Skip to content

Proposal to add Peekable::peek_mut - #77491

Merged
bors merged 1 commit into
rust-lang:masterfrom
lukaslueg:peek_mut
Nov 25, 2020
Merged

Proposal to add Peekable::peek_mut#77491
bors merged 1 commit into
rust-lang:masterfrom
lukaslueg:peek_mut

Conversation

@lukaslueg

@lukaslueglukaslueg commented Oct 3, 2020

Copy link
Copy Markdown
Contributor

A "peekable" iterator has a peek()-method which provides an immutable reference to the next item. We currently do not have a method to modify that item, which we could easily add via a peek_mut(). See the test for a use-case (alike to my original use case), where a "pristine" iterator is passed on after modifying its state via peek_mut().

If there is interest in this, I can expand on the tests and docs.

@rust-highfive

rust-highfive commented Oct 3, 2020

Copy link
Copy Markdown
Contributor

r? @kennytm

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

@rust-highfiverust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Oct 3, 2020
@jyn514jyn514 added A-iterators Area: Iterators T-libs-api [DEPRECATED; DO NOT USE] labels Oct 3, 2020
@jyn514

jyn514 commented Oct 3, 2020

Copy link
Copy Markdown
Member

What's the use case for adding this?

@lukaslueg

lukaslueg commented Oct 3, 2020•
edited by jyn514
Loading

Copy link
Copy Markdown
ContributorAuthor

I've a iterator of BufRead where I peek into the buffer via fill_buf, which requires mutable access to fill the buffer.

@timvermeulen

timvermeulen commented Oct 3, 2020

Copy link
Copy Markdown
Contributor

+1, I've been wanting to add this 🙂

@lukaslueg
lukaslueg marked this pull request as draft October 4, 2020 13:17
@Dylan-DPC-zz

Dylan-DPC-zz commented Oct 23, 2020

Copy link
Copy Markdown

@lukaslueg can you open an issue regarding this? once that's done update issue=none to the issue number and we can see what's next after that. Thanks

@Dylan-DPC-zzDylan-DPC-zz 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 Oct 23, 2020
@lukaslueglukaslueg mentioned this pull request Oct 23, 2020
Closed
2 tasks
@Dylan-DPC-zzDylan-DPC-zz added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. S-waiting-on-team and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Nov 17, 2020
@Dylan-DPC-zz

Dylan-DPC-zz commented Nov 17, 2020

Copy link
Copy Markdown

@rust-lang/libs would like your thoughts on this proposal so we can move forward with this

@dtolnay

dtolnay commented Nov 21, 2020

Copy link
Copy Markdown
Member

+1, I am on board with this.

@dtolnaydtolnay assigned dtolnay and unassigned kennytmNov 21, 2020
@lukaslueg

lukaslueg commented Nov 22, 2020

Copy link
Copy Markdown
ContributorAuthor

Expanded docs, similar to peek(), rebased

@jyn514

jyn514 commented Nov 22, 2020

Copy link
Copy Markdown
Member
tidy error: /checkout/library/core/src/iter/adapters/mod.rs: too many lines (3004) (add `// ignore-tidy-filelength` to the file to suppress this error)

I'd add ignore-tidy-filelength for now and it can be split up later at some point.

@lukaslueg
lukaslueg marked this pull request as ready for review November 22, 2020 19:05
@bors

bors commented Nov 23, 2020

Copy link
Copy Markdown
Collaborator

☔ The latest upstream changes (presumably #79319) made this pull request unmergeable. Please resolve the merge conflicts.

Note that reviewers usually do not review pull requests until merge conflicts are resolved! Once you resolve the conflicts, you should change the labels applied by bors to indicate that your PR is ready for review. Post this as a comment to change the labels:

@rustbot modify labels: +S-waiting-on-review -S-waiting-on-author

@lukaslueg

lukaslueg commented Nov 23, 2020•
edited
Loading

Copy link
Copy Markdown
ContributorAuthor

Rebased due to #77697. Note that I went light on adding new tests for peek_mut since it's implementation is identical to peek().

@m-ou-se

m-ou-se commented Nov 24, 2020

Copy link
Copy Markdown
Member

Looks like nobody is against adding this (as unstable). :)

@bors r+ rollup

@bors

bors commented Nov 24, 2020

Copy link
Copy Markdown
Collaborator

📌 Commit 3b01562 has been approved by m-ou-se

@borsbors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-team labels Nov 24, 2020
@bors

bors commented Nov 25, 2020

Copy link
Copy Markdown
Collaborator

⌛ Testing commit 3b01562 with merge b387f62...

@bors

bors commented Nov 25, 2020

Copy link
Copy Markdown
Collaborator

☀️ Test successful - checks-actions
Approved by: m-ou-se
Pushing b387f62 to master...

@borsbors added the merged-by-bors This PR was explicitly merged by bors. label Nov 25, 2020
@bors
bors merged commit b387f62 into rust-lang:masterNov 25, 2020
@rustbotrustbot added this to the 1.50.0 milestone Nov 25, 2020
@lukaslueg
lukaslueg deleted the peek_mut branch November 25, 2020 08:43
@m-ou-sem-ou-se mentioned this pull request Dec 14, 2020
Merged
@lukaslueglukaslueg mentioned this pull request Feb 9, 2021
Merged
Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this pull request Mar 17, 2021
@Dylan-DPC
Rollup merge ofrust-lang#81938- lukaslueg:stab_peek_mut, r=KodrAus,…
03abd47
…JohnTitor
Stabilize `peekable_peek_mut`
Resolvesrust-lang#78302. Also adds some documentation on `std::iter::Iterator::peekable()` regarding the new method.
The feature was added in rust-lang#77491 in Nov' 20, which is recently, but the feature seems reasonably small. Never did a stabilization-pr, excuse my ignorance if there is a protocol I'm not aware of.
Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this pull request Apr 8, 2021
@Dylan-DPC
Rollup merge ofrust-lang#81938- lukaslueg:stab_peek_mut, r=Amanieu
5f6fb2c
Stabilize `peekable_peek_mut`
Resolvesrust-lang#78302. Also adds some documentation on `std::iter::Iterator::peekable()` regarding the new method.
The feature was added in rust-lang#77491 in Nov' 20, which is recently, but the feature seems reasonably small. Never did a stabilization-pr, excuse my ignorance if there is a protocol I'm not aware of.
Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this pull request Apr 8, 2021
@Dylan-DPC
Rollup merge ofrust-lang#81938- lukaslueg:stab_peek_mut, r=Amanieu
461297e
Stabilize `peekable_peek_mut`
Resolvesrust-lang#78302. Also adds some documentation on `std::iter::Iterator::peekable()` regarding the new method.
The feature was added in rust-lang#77491 in Nov' 20, which is recently, but the feature seems reasonably small. Never did a stabilization-pr, excuse my ignorance if there is a protocol I'm not aware of.
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@dtolnaydtolnay

Labels

A-iteratorsArea: Iteratorsmerged-by-borsThis PR was explicitly merged by bors.S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.T-libs-api[DEPRECATED; DO NOT USE]

Projects

None yet

Milestone

1.50.0

Development

Successfully merging this pull request may close these issues.

10 participants

@lukaslueg@rust-highfive@jyn514@timvermeulen@Dylan-DPC-zz@dtolnay@bors@m-ou-se@kennytm@rustbot