Beef up BufRead::consume docs #23622
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
|
r? @pcwalton (rust_highfive has picked a reviewer for you, use r? to override) |
| @@ -558,6 +558,10 @@ pub trait BufRead: Read { | |||
| /// This function does not perform any I/O, it simply informs this object | |||
| /// that some amount of its buffer, returned from `fill_buf`, has been | |||
| /// consumed and should no longer be returned. | |||
| /// | |||
| /// This function is used to tell the buffer how many bytes you've consumed from the return | |||
| /// value of `fill_buff`, and so may do odd things if `fill_buf` isn't called before calling | |||
|
also there's no mention that the number of bytes passed to |
|
@oli-obk thanks! fixed. That naming convention is something I have yet to internalize, ugh. |
| /// | ||
| /// This function is used to tell the buffer how many bytes you've consumed from the return | ||
| /// value of `fill_buf`, and so may do odd things if `fill_buf` isn't called before calling | ||
| /// this. |
There was a problem hiding this comment.
Can this follow the surrounding style of wrapping to 80 characters? Other than that r=me
|
@bors: r=alexcrichton rollup |
|
📌 Commit a5e1cbe has been approved by |
steveklabnik
added a commit
to steveklabnik/rust
that referenced
this pull request
Mar 23, 2015
alexcrichton
added a commit
to alexcrichton/rust
that referenced
this pull request
Mar 23, 2015
alexcrichton
added a commit
to alexcrichton/rust
that referenced
this pull request
Mar 23, 2015
- Successful merges: rust-lang#22954, rust-lang#23119, rust-lang#23509, rust-lang#23561, rust-lang#23590, rust-lang#23607, rust-lang#23608, rust-lang#23618, rust-lang#23622, rust-lang#23639, rust-lang#23641 - Failed merges: rust-lang#23401
Manishearth
added a commit
to Manishearth/rust
that referenced
this pull request
Mar 24, 2015
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.
Fixes #23196