Skip to content

fix: Hide the xxx_sink variants from the public API #123

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 24, 2025

Conversation

rklaehn
Copy link
Collaborator

@rklaehn rklaehn commented Jul 24, 2025

Description

These functions are internal and have no business being in the public API, I think

Breaking Changes

Removes

  • api::remote::Remote::fetch_sink
  • api::remote::Remote::execute_push_sink
  • api::remote::Remote::execute_get_sink

Notes & open questions

Note: maybe we need to expose them at some point, but currently I don't see the need, and in any case the Sink trait is not exposed, so nobody can use them anyway at this time!

Change checklist

  • Self-review.
  • Documentation updates following the style guide, if relevant.
  • Tests if relevant.
  • All breaking changes documented.

Copy link

Documentation for this PR has been generated and is available at: https://n0-computer.github.io/iroh-blobs/pr/123/docs/iroh_blobs/

Last updated: 2025-07-24T07:31:24Z

Copy link
Member

@matheus23 matheus23 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They use a custom Sink trait, so yeah I think so too :)

@rklaehn rklaehn merged commit 1ff13f5 into main Jul 24, 2025
23 of 24 checks passed
@rklaehn
Copy link
Collaborator Author

rklaehn commented Jul 24, 2025

They use a custom Sink trait, so yeah I think so too :)

Yeah, I needed something like a sink, but without all the poll madness of the one that is in futures...

@rklaehn rklaehn deleted the hide-sink-variants branch July 24, 2025 07:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants