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

# 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.

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

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

Executes the destructor for this type. Read more

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

####
ⓘImportant traits for &'a mut I

### Important traits for &'a mut I

`impl<'a, I> Iterator for &'a mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'a, R: Read + ?Sized> Read for &'a mut Rimpl<'a, W: Write + ?Sized> Write for &'a mut W`
`fn deref_mut(&mut self) -> &mut T`
[src]

Mutably dereferences the value.

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

#### `type Target = T`

The resulting type after dereferencing.

####
ⓘImportant traits for &'a mut I

### Important traits for &'a mut I

`impl<'a, I> Iterator for &'a mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'a, R: Read + ?Sized> Read for &'a mut Rimpl<'a, W: Write + ?Sized> Write for &'a mut W`
`fn deref(&self) -> &T`
[src]

Dereferences the value.

# 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
+ / -
  Collapse/expand 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`)