rust-lang / rust-lang/rust

Tracking Issue for binary_heap::PeekMut::refresh

Open
#138,355 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

C-tracking-issue T-libs
Dominant language
Rust
Stars
119k
Forks
16.1k
PR merge metrics
PR metrics pending

Description

Feature gate: #![feature(binary_heap_peek_mut_refresh)]

This is a tracking issue for #138161 . This allows efficiently re-obtaining the maximum element of a binary heap after the peeked element was modified, and determines if the heap has changed as a result of that element modification.

Public API
// alloc::collections::binary_heap;

impl<'a, T: Ord, A: Allocator> PeekMut<'a, T, A> {
    pub fn refresh(&mut self) -> bool;
}
Steps / History
  • Implementation: #138161
  • Final comment period (FCP)^1
  • Stabilization PR
Unresolved Questions
  • Decide on a name to stabilize. Future interfaces for mutable handles into other sorted std collections should be consistent but there are no others yet.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the public API in alloc::collections::binary_heap and the implementation linked in issue #138161. Review the unresolved naming question and the remaining FCP and stabilization steps; done means a stabilization decision and PR for PeekMut::refresh.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
compilers
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.