add doc for doing Read from &str
#46088
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
|
I'm still running |
vitiral
force-pushed
the
read_doc
branch
2 times, most recently
from
8998038
to
bf483fc
Compare
vitiral
commented
Nov 18, 2017
| /// ``` | ||
| /// use std::io; | ||
| /// # use std::io; |
There was a problem hiding this comment.
I made this hidden since it isn't used in visible code
| /// # } | ||
| /// ``` | ||
| /// | ||
| /// [`read()`]: trait.Read.html#tymethod.read |
There was a problem hiding this comment.
I moved these to the bottom and added &[u8].
vitiral
force-pushed
the
read_doc
branch
2 times, most recently
from
95d4c99
to
44da4a0
Compare
steveklabnik
approved these changes
Nov 19, 2017
|
This looks great to me, agree 100%. Thanks so much! @bors: r+ rollup |
|
📌 Commit 44da4a0 has been approved by |
|
thanks @steveklabnik, no problem! |
kennytm
added
the
S-waiting-on-bors
kennytm
added a commit
to kennytm/rust
that referenced
this pull request
Nov 20, 2017
add doc for doing `Read` from `&str` This information can be found on [stackoverflow](https://stackoverflow.com/questions/32674905/pass-string-to-function-taking-read-trait) but I think it would be beneficial if it was documented in the `Read` trait itself. I had an *extremely* hard time finding this information, and "mocking" a reader with a string is an EXTREMELY common thing (I believe).
bors
added a commit
that referenced
this pull request
Nov 20, 2017
nodakai
reviewed
Dec 18, 2017
| @@ -449,6 +443,32 @@ fn read_to_end<R: Read + ?Sized>(r: &mut R, buf: &mut Vec<u8>) -> Result<usize> | |||
| /// # Ok(()) | |||
| /// # } | |||
| /// ``` | |||
| /// | |||
| /// Read from `&str` because [`&[u8]`] implements [`Read`]: | |||
There was a problem hiding this comment.
Pulldown doesn't seem to able to parse [`&[u8]`] (@steveklabnik please confirm)
Documenting std v0.0.0 (file:///home/nodakai/src/rust-HEAD/src/libstd)
WARNING: documentation for this crate may be rendered differently using the new Pulldown renderer.
See https://github.com/rust-lang/rust/issues/44229 for details.
WARNING: rendering difference in `The `Read` trait allows for reading bytes from a source.`
--> src/libstd/io/mod.rs:470:0
/html[0]/body[1]/p[8] Text differs:
expected: `because`
found: `because [`
WARNING: rendering difference in `The `Read` trait allows for reading bytes from a source.`
--> src/libstd/io/mod.rs:470:0
/html[0]/body[1]/p[8] Tags differ: expected: `a`, found: `code`
WARNING: rendering difference in `The `Read` trait allows for reading bytes from a source.`
--> src/libstd/io/mod.rs:470:0
/html[0]/body[1]/p[8] Text differs:
expected: `implements`
found: `] implements`
WARNING: rendering difference in `The `Read` trait allows for reading bytes from a source.`
--> src/libstd/io/mod.rs:470:0
/html[0]/body[1] Unexpected element `p`: found: `<p>[<code>&[u8]</code>]: primitive.slice.html</p>`
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.
This information can be found on stackoverflow but I think it would be beneficial if it was documented in the
Readtrait itself.I had an extremely hard time finding this information, and "mocking" a reader with a string is an EXTREMELY common thing (I believe).