Significantly improve documentation for the traits in std::io #26924
Conversation
This file contains hidden or 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
steveklabnik
force-pushed
the
doc_io_traits_enums
branch
from
43769a8 to
748c437
Compare
| /// returning how many bytes were successfully written. | ||
| /// Implementors of the `Write` trait are sometimes called 'writers'. | ||
| /// | ||
| /// Readers are defined by two required methods, `write()` and `flush()`: |
| /// let mut buffer = try!(OpenOptions::new().write(true).open("foo.txt")); | ||
| /// | ||
| /// buffer.write(b"some bytes").unwrap(); | ||
| /// buffer.flush().unwrap(); |
There was a problem hiding this comment.
(and the ones in the below examples)
There was a problem hiding this comment.
i had made a mental note that 'now that i've converted these things to files i can try instead of unwrap' and then forgot, thanks :)
steveklabnik
force-pushed
the
doc_io_traits_enums
branch
2 times, most recently
from
7f96964 to
0e1b874
Compare
|
updated some more, and feeling good about it :) |
| /// let mut buffer = String::new(); | ||
| /// | ||
| /// while stdin.read_line(&mut buffer).unwrap() > 0 { | ||
| /// if n == 0 { break } // eof |
There was a problem hiding this comment.
This line can be deleted now
|
I am as well! Thanks so much @steveklabnik! r=me with just a few last nits |
|
(travis also failed) |
steveklabnik
force-pushed
the
doc_io_traits_enums
branch
from
0e1b874 to
4fb02a3
Compare
|
@bors: r=alexcrichton rollup |
|
📌 Commit 4fb02a3 has been approved by |
|
🎊 |
bors
added a commit
that referenced
this pull request
Aug 18, 2015
"Don't seek past end of stream" is mentioned twice in a row. This happened because seeking before offset 0 was previously mentioned there, and was moved to the "errors" section afterwards. Somehow made it through [#26924](https://github.com/rust-lang/rust/pull/26924/files#diff-668f8f358d4a93474b396dcb3727399eR825).
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.
Examples for everything, as well as some cleanup and consistency changes.
r? @alexcrichton