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

# 1.0.0[−][src]Trait core::convert::AsMut

    pub trait AsMut<T: ?Sized> {
        fn as_mut(&mut self) -> &mut T;
    }

A cheap, mutable reference-to-mutable reference conversion.

This trait is similar to `AsRef` but used for converting between mutable references.

Note: this trait must not fail. If the conversion can fail, use a dedicated method which returns an `Option<T>` or a `Result<T, E>`.

# Generic Implementations

- `AsMut` auto-dereferences if the inner type is a mutable reference (e.g.: `foo.as_mut()` will work the same if `foo` has type `&mut Foo` or `&mut &mut Foo`)

# Examples

`Box<T>` implements `AsMut<T>`:

    fn add_one<T: AsMut<u64>>(num: &mut T) {
        *num.as_mut() += 1;
    }

    let mut boxed_num = Box::new(0);
    add_one(&mut boxed_num);
    assert_eq!(*boxed_num, 1);Run

## Required Methods

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

Performs the conversion.

## Implementors

###

`impl<'a, T: ?Sized, U: ?Sized> AsMut<U> for &'a mut T where T: AsMut<U>,`

[src]

####

`fn as_mut(&mut self) -> &mut U`

[src]

###

`impl<T> AsMut<[T]> for [T; 0]`

[src]

####

`fn as_mut(&mut self) -> &mut [T]`

[src]

###

`impl<T> AsMut<[T]> for [T; 1]`

[src]

####

`fn as_mut(&mut self) -> &mut [T]`

[src]

###

`impl<T> AsMut<[T]> for [T; 2]`

[src]

####

`fn as_mut(&mut self) -> &mut [T]`

[src]

###

`impl<T> AsMut<[T]> for [T; 3]`

[src]

####

`fn as_mut(&mut self) -> &mut [T]`

[src]

###

`impl<T> AsMut<[T]> for [T; 4]`

[src]

####

`fn as_mut(&mut self) -> &mut [T]`

[src]

###

`impl<T> AsMut<[T]> for [T; 5]`

[src]

####

`fn as_mut(&mut self) -> &mut [T]`

[src]

###

`impl<T> AsMut<[T]> for [T; 6]`

[src]

####

`fn as_mut(&mut self) -> &mut [T]`

[src]

###

`impl<T> AsMut<[T]> for [T; 7]`

[src]

####

`fn as_mut(&mut self) -> &mut [T]`

[src]

###

`impl<T> AsMut<[T]> for [T; 8]`

[src]

####

`fn as_mut(&mut self) -> &mut [T]`

[src]

###

`impl<T> AsMut<[T]> for [T; 9]`

[src]

####

`fn as_mut(&mut self) -> &mut [T]`

[src]

###

`impl<T> AsMut<[T]> for [T; 10]`

[src]

####

`fn as_mut(&mut self) -> &mut [T]`

[src]

###

`impl<T> AsMut<[T]> for [T; 11]`

[src]

####

`fn as_mut(&mut self) -> &mut [T]`

[src]

###

`impl<T> AsMut<[T]> for [T; 12]`

[src]

####

`fn as_mut(&mut self) -> &mut [T]`

[src]

###

`impl<T> AsMut<[T]> for [T; 13]`

[src]

####

`fn as_mut(&mut self) -> &mut [T]`

[src]

###

`impl<T> AsMut<[T]> for [T; 14]`

[src]

####

`fn as_mut(&mut self) -> &mut [T]`

[src]

###

`impl<T> AsMut<[T]> for [T; 15]`

[src]

####

`fn as_mut(&mut self) -> &mut [T]`

[src]

###

`impl<T> AsMut<[T]> for [T; 16]`

[src]

####

`fn as_mut(&mut self) -> &mut [T]`

[src]

###

`impl<T> AsMut<[T]> for [T; 17]`

[src]

####

`fn as_mut(&mut self) -> &mut [T]`

[src]

###

`impl<T> AsMut<[T]> for [T; 18]`

[src]

####

`fn as_mut(&mut self) -> &mut [T]`

[src]

###

`impl<T> AsMut<[T]> for [T; 19]`

[src]

####

`fn as_mut(&mut self) -> &mut [T]`

[src]

###

`impl<T> AsMut<[T]> for [T; 20]`

[src]

####

`fn as_mut(&mut self) -> &mut [T]`

[src]

###

`impl<T> AsMut<[T]> for [T; 21]`

[src]

####

`fn as_mut(&mut self) -> &mut [T]`

[src]

###

`impl<T> AsMut<[T]> for [T; 22]`

[src]

####

`fn as_mut(&mut self) -> &mut [T]`

[src]

###

`impl<T> AsMut<[T]> for [T; 23]`

[src]

####

`fn as_mut(&mut self) -> &mut [T]`

[src]

###

`impl<T> AsMut<[T]> for [T; 24]`

[src]

####

`fn as_mut(&mut self) -> &mut [T]`

[src]

###

`impl<T> AsMut<[T]> for [T; 25]`

[src]

####

`fn as_mut(&mut self) -> &mut [T]`

[src]

###

`impl<T> AsMut<[T]> for [T; 26]`

[src]

####

`fn as_mut(&mut self) -> &mut [T]`

[src]

###

`impl<T> AsMut<[T]> for [T; 27]`

[src]

####

`fn as_mut(&mut self) -> &mut [T]`

[src]

###

`impl<T> AsMut<[T]> for [T; 28]`

[src]

####

`fn as_mut(&mut self) -> &mut [T]`

[src]

###

`impl<T> AsMut<[T]> for [T; 29]`

[src]

####

`fn as_mut(&mut self) -> &mut [T]`

[src]

###

`impl<T> AsMut<[T]> for [T; 30]`

[src]

####

`fn as_mut(&mut self) -> &mut [T]`

[src]

###

`impl<T> AsMut<[T]> for [T; 31]`

[src]

####

`fn as_mut(&mut self) -> &mut [T]`

[src]

###

`impl<T> AsMut<[T]> for [T; 32]`

[src]

####

`fn as_mut(&mut self) -> &mut [T]`

[src]

###

`impl<T> AsMut<[T]> for [T]`

[src]

####

`fn as_mut(&mut self) -> &mut [T]`

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