Struct PeekMut

pub struct PeekMut<'a, T, A = Global>
where
    T: 'a + Ord,
    A: Allocator,
{ /* private fields */ }

Available on crate feature std and non-no_global_oom_handling only.

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.

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.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 16 bytes