# Struct std::collections::binary_heap::PeekMut 1.12.0[−][src]

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

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> PeekMut<'a, T> where
T: Ord,` [src]

#### `pub fn pop(this: PeekMut<'a, T>) -> T` 1.18.0[src]

Removes the peeked value from the heap and returns it.

## Trait Implementations

### `impl<'_, T> Debug for PeekMut<'_, T> where
T: Ord + Debug,` 1.17.0[src]

#### `pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>`[src]

Formats the value using the given formatter. Read more

### `impl<'_, T> Deref for PeekMut<'_, T> where
T: Ord,` [src]

#### `type Target = T`

The resulting type after dereferencing.

#### `pub fn deref(&self) -> &Tⓘ

### Notable traits for &'_ mut F

`impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for &mut Rimpl<W: Write + ?Sized> Write for &mut W`
`[src]

Dereferences the value.

### `impl<'_, T> DerefMut for PeekMut<'_, T> where
T: Ord,` [src]

#### `pub fn deref_mut(&mut self) -> &mut Tⓘ

### Notable traits for &'_ mut F

`impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for &mut Rimpl<W: Write + ?Sized> Write for &mut W`
`[src]

Mutably dereferences the value.

### `impl<'_, T> Drop for PeekMut<'_, T> where
T: Ord,` [src]

#### `pub fn drop(&mut self)`[src]

Executes the destructor for this type. Read more

## Auto Trait Implementations

### `impl<'a, T> RefUnwindSafe for PeekMut<'a, T> where
T: RefUnwindSafe,` [src]

### `impl<'a, T> Send for PeekMut<'a, T> where
T: Send,` [src]

### `impl<'a, T> Sync for PeekMut<'a, T> where
T: Sync,` [src]

### `impl<'a, T> Unpin for PeekMut<'a, T>`[src]

### `impl<'a, T> !UnwindSafe for PeekMut<'a, T>`[src]

## Blanket Implementations

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `pub fn type_id(&self) -> TypeId`[src]

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

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow(&self) -> &Tⓘ

### Notable traits for &'_ mut F

`impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for &mut Rimpl<W: Write + ?Sized> Write for &mut W`
`[src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow_mut(&mut self) -> &mut Tⓘ

### Notable traits for &'_ mut F

`impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for &mut Rimpl<W: Write + ?Sized> Write for &mut W`
`[src]

Mutably borrows from an owned value. Read more

### `impl<T> From<T> for T`[src]

#### `pub fn from(t: T) -> T`[src]

Performs the conversion.

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `pub fn into(self) -> U`[src]

Performs the conversion.

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

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

The type returned in the event of a conversion error.

#### `pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]

Performs the conversion.