feat(yamux): future-proof public API #3908
Merged
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
4 tasks
thomaseizinger
commented
May 10, 2023
… into feat/harden-yamux-api
mxinden
reviewed
May 11, 2023
| /// The [`futures::stream::Stream`] of incoming substreams. | ||
| incoming: S, | ||
| incoming: BoxStream<'static, Result<yamux::Stream, yamux::ConnectionError>>, |
There was a problem hiding this comment.
Why Box the stream of streams? Not boxing would also resolve the need for PhantomData, right?
There was a problem hiding this comment.
I just inlined what we had before.
This and the phantom data will go away once update to latest yamux. I only added it to make sure it is a compatible API change later :)
into_stream returns an impl Trait. I guess we could inline the unfold operation and store an Unfold type?
Do you feel strongly?
There was a problem hiding this comment.
I am not sure the Unfold type is nameable at all because it contains an async block.
There was a problem hiding this comment.
This and the phantom data will go away once update to latest yamux.
Great. Don't feel strongly. Let's keep as is.
mxinden
approved these changes
May 12, 2023
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
With this set of changes, we prepare the public API of
libp2p-yamuxto be as minimal as possible and allow for upgrades of the underlyingyamuxlibrary in patch releases.Related: #3013.
Notes & open questions
Change checklist