futures-util/io examples #1108
Merged
futures-util/io examples #1108
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
futures-util/src/io/mod.rs
Outdated
| /// let bytes = await!(reader.read(&mut output[..]))?; | ||
| /// | ||
| /// // This is only guaranteed to be 4 because `&[u8]` is a synchronous | ||
| /// // reader, in a real system you could get anywhere from 1 to |
There was a problem hiding this comment.
...reader. In a real system
There should be a period because it's a new sentence
| /// # Ok::<(), Box<std::error::Error>>(()) }).unwrap(); | ||
| /// ``` | ||
| /// | ||
| /// ## EOF is hit before `buf` is filled |
There was a problem hiding this comment.
Maybe write it as "End of file". Some people might not know the term
There was a problem hiding this comment.
I expanded the earlier "EOF" in this doc-comment to "end of file (EOF)" and left it as shorthand in this heading.
futures-util/src/io/mod.rs
Outdated
| /// { | ||
| /// let mut writer = Cursor::new(&mut output[..]); | ||
| /// // Note that for `Cursor` the read and write halves share a single | ||
| /// // seek position, this may or may not be true for other types that |
futures-util/src/io/mod.rs
Outdated
| /// use std::io::Cursor; | ||
| /// | ||
| /// let mut reader = Cursor::new([1, 2, 3, 4]); | ||
| /// let mut buffer = [0, 0, 0, 0, 4, 3, 2, 1]; |
There was a problem hiding this comment.
One final tiny thing: Here I'd prefer to not reuse the numbers and instead use different numbers like 5, 6, 7, 8. This makes it more clear what's happening
|
Rebase (again) 🙂 |
Nemo157
force-pushed
the
futures-util-io-examples
branch
from
66a9b3d to
ea11c8d
Compare
|
Rebased and changed the numbers. |
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.
Also fixes
WriteAll, it was broken in the same way asReadExactin #1083