core::borrow::BorrowMut - Rust
Description: API documentation for the Rust `BorrowMut` trait in crate `core`.
Keywords: rust, rustlang, rust-lang, BorrowMut

# Trait core::borrow::BorrowMut 1.0.0[−][src]

    pub trait BorrowMut<Borrowed: ?Sized>: Borrow<Borrowed> {
        fn borrow_mut(&mut self) -> &mut Borrowed;
    }

A trait for mutably borrowing data.

As a companion to `Borrow<T>` this trait allows a type to borrow as an underlying type by providing a mutable reference. See `Borrow<T>` for more information on borrowing as another type.

## Required Methods

### `fn borrow_mut(&mut self) -> &mut Borrowed`

Mutably borrows from an owned value.

# Examples

    use std::borrow::BorrowMut;

    fn check<T: BorrowMut<[i32]>>(mut v: T) {
        assert_eq!(&mut [1, 2, 3], v.borrow_mut());
    }

    let v = vec![1, 2, 3];

    check(v);Run

## Implementors

- `impl<T: ?Sized> BorrowMut<T> for T` | [src]

- `impl<'a, T: ?Sized> BorrowMut<T> for &'a mut T` | [src]

- `impl<T> BorrowMut<[T]> for [T; 0]` | [src]

- `impl<T> BorrowMut<[T]> for [T; 1]` | [src]

- `impl<T> BorrowMut<[T]> for [T; 2]` | [src]

- `impl<T> BorrowMut<[T]> for [T; 3]` | [src]

- `impl<T> BorrowMut<[T]> for [T; 4]` | [src]

- `impl<T> BorrowMut<[T]> for [T; 5]` | [src]

- `impl<T> BorrowMut<[T]> for [T; 6]` | [src]

- `impl<T> BorrowMut<[T]> for [T; 7]` | [src]

- `impl<T> BorrowMut<[T]> for [T; 8]` | [src]

- `impl<T> BorrowMut<[T]> for [T; 9]` | [src]

- `impl<T> BorrowMut<[T]> for [T; 10]` | [src]

- `impl<T> BorrowMut<[T]> for [T; 11]` | [src]

- `impl<T> BorrowMut<[T]> for [T; 12]` | [src]

- `impl<T> BorrowMut<[T]> for [T; 13]` | [src]

- `impl<T> BorrowMut<[T]> for [T; 14]` | [src]

- `impl<T> BorrowMut<[T]> for [T; 15]` | [src]

- `impl<T> BorrowMut<[T]> for [T; 16]` | [src]

- `impl<T> BorrowMut<[T]> for [T; 17]` | [src]

- `impl<T> BorrowMut<[T]> for [T; 18]` | [src]

- `impl<T> BorrowMut<[T]> for [T; 19]` | [src]

- `impl<T> BorrowMut<[T]> for [T; 20]` | [src]

- `impl<T> BorrowMut<[T]> for [T; 21]` | [src]

- `impl<T> BorrowMut<[T]> for [T; 22]` | [src]

- `impl<T> BorrowMut<[T]> for [T; 23]` | [src]

- `impl<T> BorrowMut<[T]> for [T; 24]` | [src]

- `impl<T> BorrowMut<[T]> for [T; 25]` | [src]

- `impl<T> BorrowMut<[T]> for [T; 26]` | [src]

- `impl<T> BorrowMut<[T]> for [T; 27]` | [src]

- `impl<T> BorrowMut<[T]> for [T; 28]` | [src]

- `impl<T> BorrowMut<[T]> for [T; 29]` | [src]

- `impl<T> BorrowMut<[T]> for [T; 30]` | [src]

- `impl<T> BorrowMut<[T]> for [T; 31]` | [src]

- `impl<T> BorrowMut<[T]> for [T; 32]` | [src]

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