Struct NestedRefMut

pub struct NestedRefMut<'a, T, N>
where
    T: ?Sized,
    N: ArrayLength<Ref<'a, ()>>,
{ /* private fields */ }

Exclusive reference to data contained in one or more nested RefCells.

This has the same interface as RefMut, and unlike NestedRef cannot be nested further.

Examples

// Create a `RefCell` two levels deep and a `NestedRefMut` into it
let rc = RefCell::new(RefCell::new(0));
let nr = NestedRef::new(rc.borrow());
let mut nr = NestedRef::map_ref_mut(nr, RefCell::borrow_mut);

// Mutate contained value
assert_eq!(*nr, 0);
*nr = 1;
assert_eq!(*nr, 1);

Implementations

impl<'a, T> NestedRefMut<'a, T, U0>

where T: ?Sized,

pub fn new(inner: RefMut<'a, T>) -> Self

Creates a new reference inside a single RefCell

impl<'a, T, N> NestedRefMut<'a, T, N>

where T: ?Sized, N: ArrayLength<Ref<'a, ()>>,

pub fn map<U, F>(orig: Self, f: F) -> NestedRefMut<'a, U, N>

where U: ?Sized, F: FnOnce(&mut T) -> &mut U,

Creates a reference to a component of the borrowed data, like RefMut::map.

This is an associated function, because a method would interfere with methods of the same name on the contents of the RefCell.

pub fn filter_map<U, F>( orig: Self, f: F, ) -> Result<NestedRefMut<'a, U, N>, Self>

where U: ?Sized, F: FnOnce(&mut T) -> Option<&mut U>,

Creates a reference to an optional component of the borrowed data, like RefMut::filter_map. The original reference is returned inside an Err if the closure returns None.

This is an associated function, because a method would interfere with methods of the same name on the contents of the RefCell.

pub fn map_split<U, V, F>( orig: Self, f: F, ) -> (NestedRefMut<'a, U, N>, NestedRefMut<'a, V, N>)

where U: ?Sized, V: ?Sized, F: FnOnce(&mut T) -> (&mut U, &mut V),

Splits a reference into multiple references for different components of the borrowed data, like RefMut::map_split.

This is an associated function, because a method would interfere with methods of the same name on the contents of the RefCell.

Trait Implementations

impl<'a, T, N> Deref for NestedRefMut<'a, T, N>

where T: ?Sized, N: ArrayLength<Ref<'a, ()>>,

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a, T, N> DerefMut for NestedRefMut<'a, T, N>

where T: ?Sized, N: ArrayLength<Ref<'a, ()>>,

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.