core::cell::RefMut - Rust
Description: API documentation for the Rust `RefMut` struct in crate `core`.
Keywords: rust, rustlang, rust-lang, RefMut

# Struct core::cell::RefMut 1.0.0 [−] [src]

    pub struct RefMut<'b, T: ?Sized + 'b> { /* fields omitted */ }

A wrapper type for a mutably borrowed value from a `RefCell<T>`.

See the module-level documentation for more.

## Methods

### `impl<'b, T: ?Sized> RefMut<'b, T>`
[src]

#### `pub fn map<U: ?Sized, F>(orig: RefMut<'b, T>, f: F) -> RefMut<'b, U> where
F: FnOnce(&mut T) -> &mut U,`
1.8.0
[src]

Make a new `RefMut` for a component of the borrowed data, e.g. an enum variant.

The `RefCell` is already mutably borrowed, so this cannot fail.

This is an associated function that needs to be used as `RefMut::map(...)`. A method would interfere with methods of the same name on the contents of a `RefCell` used through `Deref`.

# Examples

    use std::cell::{RefCell, RefMut};

    let c = RefCell::new((5, 'b'));
    {
        let b1: RefMut<(u32, char)> = c.borrow_mut();
        let mut b2: RefMut<u32> = RefMut::map(b1, |t| &mut t.0);
        assert_eq!(*b2, 5);
        *b2 = 42;
    }
    assert_eq!(*c.borrow(), (42, 'b'));Run

## Trait Implementations

### `impl<'b, T: ?Sized> Deref for RefMut<'b, T>`
[src]

#### `type Target = T`

The resulting type after dereferencing.

#### `fn deref(&self) -> &T`
[src]

Dereferences the value.

### `impl<'b, T: ?Sized> DerefMut for RefMut<'b, T>`
[src]

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

Mutably dereferences the value.

### `impl<'b, T: ?Sized + Unsize<U>, U: ?Sized> CoerceUnsized<RefMut<'b, U>> for RefMut<'b, T>`
[src]

### `impl<'a, T: ?Sized + Display> Display for RefMut<'a, T>`
1.20.0
[src]

#### `fn fmt(&self, f: &mut Formatter) -> Result`
[src]

Formats the value using the given formatter. Read more

### `impl<'b, T: ?Sized + Debug> Debug for RefMut<'b, T>`
[src]

#### `fn fmt(&self, f: &mut Formatter) -> Result`
[src]

Formats the value using the given formatter. 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
+ / -
  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`)