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.

Sign up for GitHub

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

Jump to bottom

Update documentation of AsyncRead to reflect use of ReadBuf #2971

Merged
merged 1 commit into from
Oct 16, 2020
Merged

Update documentation of AsyncRead to reflect use of ReadBuf #2971

merged 1 commit into from
Oct 16, 2020

Conversation

udoprog
Copy link
Contributor

@udoprog udoprog commented Oct 16, 2020

Documentation incorrectly mentions Ok(n) which is fixed here. Also adds a hint (twice) informing the reader how to check for EOF since it might be non-obvious.

Darksonn added a commit to Darksonn/tokio that referenced this pull request Oct 16, 2020
@Darksonn
Undo part to avoid merge conflict with tokio-rs#2971
1ae4085
@udoprog
Copy link
Contributor Author

udoprog commented Oct 16, 2020

Also would be nice to have shorthands on ReadBuf for checking the length of the filled buffer (ReadBuf::len, ReadBuf::is_empty) which might be worthwhile feedback to the RFC.

@Darksonn
Copy link
Contributor

Darksonn commented Oct 16, 2020 •
edited
Loading

Makes sense. Can you post it on the RFC? And perhaps open a PR here?

@udoprog udoprog merged commit 1644511 into tokio-rs:master Oct 16, 2020
@udoprog udoprog deleted the async-read-doc branch October 16, 2020 09:55
@quininer quininer mentioned this pull request Oct 16, 2020
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Darksonn Darksonn Darksonn approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@udoprog @Darksonn