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

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

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

A container object that represents the result of the `peek_mut()` method on `BinaryHeap`. See its documentation for details.

## Methods

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

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

🔬 This is a nightly-only experimental API. (`binary_heap_peek_mut_pop` #38863)

Removes the peeked value from the heap and returns it.

## Trait Implementations

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

#### `fn drop(&mut self)`

A method called when the value goes out of scope. Read more

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

#### `type Target = T`

The resulting type after dereferencing

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

The method called to dereference a value

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

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

The method called to mutably dereference a value

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  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`)