Struct trait_based_collection::priority_queue::PeekMut

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

A mutable reference to an element in a BinaryHeap that can be used to modify the element while maintaining the heap property. The element is only modified when the PeekMut is dropped and the user has tried to modify the element (by mutably dereferencing the PeekMut). If the user has not tried to modify the element, the element is not modified.

Implementations

impl<'a, T> PeekMut<'a, T>where
    T: 'a + Ord,

pub fn new(heap: &'a mut BinaryHeap<T>, index: usize) -> Self

Creates a new PeekMut with the given heap and index and sets modified to false.

Safety

The index must be a valid index in the heap.

Trait Implementations

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

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

Formats the value using the given formatter.

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

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

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

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

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

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, T> PartialEq<PeekMut<'a, T>> for PeekMut<'a, T>where
    T: 'a + Ord,

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.