Improve rewind documentation #116807
Merged
Improve rewind documentation #116807
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? @thomcc (rustbot has picked a reviewer for you, use r? to override) |
rustbot
added
S-waiting-on-review
|
This is probably fine. I'm not sure it's needed but I don;'t think it hurts. @bors r+ rollup |
bors
added
S-waiting-on-bors
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Nov 24, 2023
…iaskrgr Rollup of 6 pull requests Successful merges: - rust-lang#116807 (Improve rewind documentation) - rust-lang#117656 (Update windows-bindgen and define `INVALID_HANDLE_VALUE` ourselves) - rust-lang#117940 (chore: remove unnecessary drop) - rust-lang#118028 (Document behavior of `<dyn Any as Any>::type_id()`) - rust-lang#118060 (Use an absolute path to the NUL device) - rust-lang#118224 (Sort unstable items last in rustdoc, instead of first) r? `@ghost` `@rustbot` modify labels: rollup
rust-timer
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Nov 24, 2023
Rollup merge of rust-lang#116807 - seanlinsley:patch-2, r=thomcc Improve rewind documentation The persistent use of an internal cursor for readers is expected for buffer data types that aren't read all at once, but for files it leads to the confusing situation where calling `read_to_end` on the same file handle multiple times only returns the contents of the file for the first call. This PR adds a note to the documentation clarifying that in that case, `rewind()` must first be called. I'm unsure if this is the right location for the docs update. Maybe it should also be duplicated on `File`?
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.
The persistent use of an internal cursor for readers is expected for buffer data types that aren't read all at once, but for files it leads to the confusing situation where calling
read_to_endon the same file handle multiple times only returns the contents of the file for the first call. This PR adds a note to the documentation clarifying that in that case,rewind()must first be called.I'm unsure if this is the right location for the docs update. Maybe it should also be duplicated on
File?