Skip to content

doc: improve docs for std::io::Seek::rewind method #105596

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 1 commit into from
Closed

doc: improve docs for std::io::Seek::rewind method #105596

wants to merge 1 commit into from

Conversation

poliorcetics
Copy link
Contributor

No description provided.

@rustbot
Copy link
Collaborator

rustbot commented Dec 12, 2022

r? @m-ou-se

(rustbot has picked a reviewer for you, use r? to override)

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-libs Relevant to the library team, which will review and decide on the PR/issue. labels Dec 12, 2022
@rustbot
Copy link
Collaborator

rustbot commented Dec 12, 2022

Hey! It looks like you've submitted a new PR for the library teams!

If this PR contains changes to any rust-lang/rust public library APIs then please comment with @rustbot label +T-libs-api -T-libs to tag it appropriately. If this PR contains changes to any unstable APIs please edit the PR description to add a link to the relevant API Change Proposal or create one if you haven't already. If you're unsure where your change falls no worries, just leave it as is and the reviewer will take a look and make a decision to forward on if necessary.

Examples of T-libs-api changes:

  • Stabilizing library features
  • Introducing insta-stable changes such as new implementations of existing stable traits on existing stable types
  • Introducing new or changing existing unstable library APIs (excluding permanently unstable features / features without a tracking issue)
  • Changing public documentation in ways that create new stability guarantees
  • Changing observable runtime behavior of library APIs

@poliorcetics
Copy link
Contributor Author

Relates to #85149

@vacuus
Copy link
Contributor

vacuus commented Dec 12, 2022

Should it really keep the line that it's equivalent to the other function call, then?

the8472
the8472 reviewed Dec 27, 2022
View reviewed changes
library/std/src/io/mod.rs
@@ -1770,6 +1770,9 @@ pub trait Seek {
/// Rewind to the beginning of a stream.
///
/// This is a convenience method, equivalent to `seek(SeekFrom::Start(0))`.
/// Note that unlike `seek(SeekFrom::Start(0))`, this method does not return
/// the old offset and cannot replace assignements of the form:
/// `let old_offset = buf.seek(SeekFrom::Start(0))?;`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

seek doesn't return the old position unless you do SeekFrom::Current(0)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See also the documentation of seek:

If the seek operation completed successfully, this method returns the new position from the start of the stream.

@m-ou-se m-ou-se added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Dec 28, 2022
@Dylan-DPC
Copy link
Member

@poliorcetics any updates on this?

@Dylan-DPC
Copy link
Member

Closing this as inactive. Feel free to reöpen this pr or create a new pr if you get the time to work on this. Thanks

@Dylan-DPC Dylan-DPC added S-inactive Status: Inactive and waiting on the author. This is often applied to closed PRs. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels May 17, 2023
@tgross35
Copy link
Contributor

@Dylan-DPC based on your last comment did you mean to close this? It is still open

@poliorcetics poliorcetics deleted the improve-std-io-seek-rewind-doc branch July 14, 2023 23:35
@Dylan-DPC
Copy link
Member

Ye sorry, thanks :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@m-ou-se m-ou-se m-ou-se left review comments

@the8472 the8472 the8472 left review comments

Assignees

@m-ou-se m-ou-se

Labels
S-inactive Status: Inactive and waiting on the author. This is often applied to closed PRs. T-libs Relevant to the library team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@poliorcetics @rustbot @vacuus @Dylan-DPC @tgross35 @m-ou-se @the8472