refactor(iroh-docs): Replace flume with async_channel in docs #2540
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is mostly a 1:1 replacement, except for the fact that the same_channel api is missing from async_channel. So I replaced it with some ugly code that uses the fact that a async_channel Sender or Receiver is just an Arc<Channel>. To be removed if/when smol-rs/async-channel#98 is merged, but until then I think it is fine.
rklaehn
force-pushed
the
iroh-docs-flume-purge
branch
from
b0082bc to
a5720e9
Compare
rklaehn
commented
Jul 24, 2024
| pub fn doc_list( | ||
| &self, | ||
| _req: DocListRequest, | ||
| ) -> impl Stream<Item = RpcResult<DocListResponse>> + Unpin { |
There was a problem hiding this comment.
Added Unpin here. it was unpin before - implicitly assumed, but it is better to be explicit. Maybe we should remove this later, but for now let's keep it as close as possible to before. Otherwise I think this would be a breaking change.
Frando
reviewed
Jul 24, 2024
Frando
approved these changes
Jul 26, 2024
matheus23
pushed a commit
that referenced
this pull request
Nov 14, 2024
## Description This is mostly a 1:1 replacement, except for the fact that the same_channel api is missing from async_channel. So I replaced it with some ugly code that uses the fact that a async_channel Sender or Receiver is just an Arc<Channel>. To be removed if/when smol-rs/async-channel#98 is merged, but until then I think it is fine. ## Breaking Changes None ## Notes & open questions Note: we can not use tokio::sync::mpsc::Channel for the actor because we can't control from which thread Drop is called. Note: some streams were Unpin before, but it was not explicit. Now I added Unpin explicitly (and boxed the stream to make it true). Not sure if the version check would catch this, pretty sure that not. But taking away Unpin would have been a breaking change. ## Change checklist - [ ] Self-review. - [ ] Documentation updates following the [style guide](https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#appendix-a-full-conventions-text), if relevant. - [ ] Tests if relevant. - [ ] All breaking changes documented.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This is mostly a 1:1 replacement, except for the fact that the same_channel api is missing from async_channel. So I replaced it with some ugly code that uses the fact that a async_channel Sender or Receiver is just an Arc.
To be removed if/when smol-rs/async-channel#98 is merged, but until then I think it is fine.
Breaking Changes
None
Notes & open questions
Note: we can not use tokio::sync::mpsc::Channel for the actor because we can't control from which thread Drop is called.
Note: some streams were Unpin before, but it was not explicit. Now I added Unpin explicitly (and boxed the stream to make it true). Not sure if the version check would catch this, pretty sure that not. But taking away Unpin would have been a breaking change.
Change checklist