Skip to content
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

Fix obsolete reference to “stream ID” in ReadHalf::unsplit() documentation. #6498

Merged
merged 1 commit into from
Apr 20, 2024

Conversation

kpreid
Copy link
Contributor

@kpreid kpreid commented Apr 19, 2024

Motivation

SplitStreamIds were added in 5bf78d7 and removed the next day in c7719a2, and never made it into a release. Therefore, the documentation for unsplit() mentioning “comparing the stream ID” is incorrect (and has been since its introduction in tokio 0.2.10).

Solution

Describe the actual method for checking the precondition of ReadHalf::unsplit(): calling ReadHalf::is_pair_of().

…ntation.

`SplitStreamId`s were added in 5bf78d7 and removed the next day in c7719a2, and never made it into a release.
@mox692 mox692 added T-docs Topic: documentation A-tokio Area: The main tokio crate M-io Module: tokio/io labels Apr 20, 2024
Copy link
Member

@mox692 mox692 left a comment

Choose a reason for hiding this comment

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

Thanks!

@mox692 mox692 merged commit 125a185 into tokio-rs:master Apr 20, 2024
80 checks passed
@kpreid kpreid deleted the patch-1 branch April 20, 2024 14:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-tokio Area: The main tokio crate M-io Module: tokio/io T-docs Topic: documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants