Struct PeekMut

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

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<NonZero<usize>>

Implementations

impl<'a, T, A> PeekMut<'a, T, A>

where T: Ord, A: Allocator,

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

Removes the peeked value from the heap and returns it.

Trait Implementations

impl<T, A> Debug for PeekMut<'_, T, A>

where T: Ord + Debug, A: Allocator,

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

Formats the value using the given formatter.

impl<T, A> Deref for PeekMut<'_, T, A>

where T: Ord, A: Allocator,

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T, A> DerefMut for PeekMut<'_, T, A>

where T: Ord, A: Allocator,

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

Mutably dereferences the value.

impl<T, A> Drop for PeekMut<'_, T, A>

where T: Ord, A: Allocator,

fn drop(&mut self)

Executes the destructor for this type.