std::collections::binary_heap::PeekMut - Rust
Description: API documentation for the Rust `PeekMut` struct in crate `std`.
Keywords: rust, rustlang, rust-lang, PeekMut

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

    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.

## Methods

### `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> Deref for PeekMut<'_, T> where
T: Ord,` [src]

#### `type Target = T`

The resulting type after dereferencing.

####
ⓘImportant traits for &'_ mut F

### Important 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`
`fn deref(&self) -> &T`[src]

Dereferences the value.

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

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

Executes the destructor for this type. Read more

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

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

Formats the value using the given formatter. Read more

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

####
ⓘImportant traits for &'_ mut F

### Important 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`
`fn deref_mut(&mut self) -> &mut T`[src]

Mutably dereferences the value.

## Auto Trait Implementations

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

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

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

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

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

## Blanket Implementations

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

#### `fn from(t: T) -> T`[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.

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

Performs the conversion.

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

#### `fn into(self) -> U`[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.

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

Performs the conversion.

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

####
ⓘImportant traits for &'_ mut F

### Important 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`
`fn borrow(&self) -> &T`[src]

Immutably borrows from an owned value. Read more

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

####
ⓘImportant traits for &'_ mut F

### Important 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`
`fn borrow_mut(&mut self) -> &mut T`[src]

Mutably borrows from an owned value. Read more

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

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

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

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g., `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g., `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g., `str,u8` or `String,struct:Vec,test`)