Tracking Issue for binary_heap::PeekMut::refresh

[197g]

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: Add PeekMut::refresh #138161
• Final comment period (FCP)¹
• 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.

Footnotes

1. https://std-dev-guide.rust-lang.org/feature-lifecycle/stabilization.html ↩

[kennytm]

this method take (this: &mut Self) as argument rather than (&mut self) because PeekMut implemented Deref.