Struct alloc::collections::binary_heap::PeekMut

pub struct PeekMut<'a, T: 'a + Ord, A: Allocator = Global> {
    heap: &'a mut BinaryHeap<T, A>,
    original_len: Option<NonZeroUsize>,
}

Structure wrapping a mutable reference to the greatest item on a BinaryHeap.

This struct is created by the peek_mut method on BinaryHeap. See its documentation for more.

Fields

heap: &'a mut BinaryHeap<T, A>

original_len: Option<NonZeroUsize>

Implementations

impl<'a, T: Ord, A: Allocator> PeekMut<'a, T, A>

pub fn pop(this: PeekMut<'a, T, A>) -> T

Removes the peeked value from the heap and returns it.

Trait Implementations

impl<T: Ord + Debug, A: Allocator> Debug for PeekMut<'_, T, A>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Ord, A: Allocator> Deref for PeekMut<'_, T, A>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T: Ord, A: Allocator> DerefMut for PeekMut<'_, T, A>

fn deref_mut(&mut self) -> &mut T

Mutably dereferences the value.

impl<T: Ord, A: Allocator> Drop for PeekMut<'_, T, A>

fn drop(&mut self)

Executes the destructor for this type.