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

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

    pub struct PeekMut<'a, 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: Ord> PeekMut<'a, T>`

[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: Ord + Debug> Debug for PeekMut<'a, T>`

1.17.0
[src]

####

`fn fmt(&self, f: &mut Formatter) -> Result`

[src]

Formats the value using the given formatter. Read more

###

`impl<'a, T: Ord> Drop for PeekMut<'a, T>`

[src]

####

`fn drop(&mut self)`

[src]

Executes the destructor for this type. Read more

###

`impl<'a, T: Ord> Deref for PeekMut<'a, T>`

[src]

#### `type Target = T`

The resulting type after dereferencing.

####

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

[src]

Dereferences the value.

###

`impl<'a, T: Ord> DerefMut for PeekMut<'a, T>`

[src]

####

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

[src]

Mutably dereferences the value.

## Auto Trait Implementations

###

`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 for T`

[src]

####

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

[src]

Performs the conversion.

###

`impl<T, U> TryFrom for T where T: From<U>,`

[src]

#### `type Error = !`

🔬 This is a nightly-only experimental API. (`try_from` #33417)

The type returned in the event of a conversion error.

####

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

[src]

🔬 This is a nightly-only experimental API. (`try_from` #33417)

Performs the conversion.

###

`impl<T, U> TryInto for T where U: TryFrom<T>,`

[src]

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

🔬 This is a nightly-only experimental API. (`try_from` #33417)

The type returned in the event of a conversion error.

####

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

[src]

🔬 This is a nightly-only experimental API. (`try_from` #33417)

Performs the conversion.

###

`impl<T, U> Into for T where U: From<T>,`

[src]

####

`fn into(self) -> U`

[src]

Performs the conversion.

###

`impl<T> Borrow for T where T: ?Sized,`

[src]

####

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

[src]

Immutably borrows from an owned value. Read more

###

`impl<T> BorrowMut for T where T: ?Sized,`

[src]

####

`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 get_type_id(&self) -> TypeId`

[src]

🔬 This is a nightly-only experimental API. (`get_type_id` #27745)

this method will likely be replaced by an associated static

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`)