Struct PeekMut

pub struct PeekMut<'a, K: Hash + Eq, T: 'a, C: 'a + Compare<T>> { /* private fields */ }

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

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

Implementations

impl<K: Hash + Eq, T, C: Compare<T>> PeekMut<'_, K, T, C>

pub fn key(&self) -> &K

returns the key of the first item on the heap.

pub fn key_value(&self) -> (&K, &T)

returns the key-value pair that is the first item on the heap.

pub fn key_value_mut(&mut self) -> (&mut K, &mut T)

returns a mutable reference to the key-value pair that is the first item on the heap.

pub fn pop(self) -> T

Removes the peeked value from the heap and returns it.

pub fn pop_with_key(self) -> (K, T)

Removes the peeked value from the heap and returns it as a key-value pair.

Trait Implementations

impl<K: Debug + Hash + Eq, T: Debug, C: Compare<T>> Debug for PeekMut<'_, K, T, C>

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

Formats the value using the given formatter.

impl<K: Hash + Eq, T, C: Compare<T>> Deref for PeekMut<'_, K, T, C>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<K: Hash + Eq, T, C: Compare<T>> DerefMut for PeekMut<'_, K, T, C>

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

Mutably dereferences the value.

impl<K: Hash + Eq, T, C: Compare<T>> Drop for PeekMut<'_, K, T, C>

fn drop(&mut self)

Executes the destructor for this type.