# Struct std::collections::binary_heap::PeekMut

1.12.0 · source ·

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

Expand description

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§

source§

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

1.18.0 · source

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

Removes the peeked value from the heap and returns it.

## Trait Implementations§

1.17.0 · source§

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

source§

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

Formats the value using the given formatter. Read more
source§

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

§

#### type Target = T

The resulting type after dereferencing.
source§

#### fn deref(&self) -> &T

Dereferences the value.
source§

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

source§

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

Mutably dereferences the value.
source§

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

source§

#### fn drop(&mut self)

Executes the destructor for this type. Read more

## Auto Trait Implementations§

§

### impl<'a, T, A> RefUnwindSafe for PeekMut<'a, T, A>where A: RefUnwindSafe, T: RefUnwindSafe,

§

### impl<'a, T, A> Send for PeekMut<'a, T, A>where A: Send, T: Send,

§

### impl<'a, T, A> Sync for PeekMut<'a, T, A>where A: Sync, T: Sync,

§

### impl<'a, T, A> Unpin for PeekMut<'a, T, A>

§

### impl<'a, T, A = Global> !UnwindSafe for PeekMut<'a, T, A>

## Blanket Implementations§

source§

### impl<T> Any for Twhere T: 'static + ?Sized,

source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
source§

### impl<T> Borrow<T> for Twhere T: ?Sized,

source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

### impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

### impl<T> From<T> for T

source§

#### fn from(t: T) -> T

Returns the argument unchanged.

source§

### impl<T, U> Into<U> for Twhere U: From<T>,

source§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

source§

### impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

#### type Error = Infallible

The type returned in the event of a conversion error.
source§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

### impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.