Struct InterruptRefMut

Source

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

Expand description

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

See the module-level documentation for more.

Implementations§

Source §

impl<'b, T: ?Sized> InterruptRefMut<'b, T>

Source

pub fn map<U: ?Sized, F>( orig: InterruptRefMut<'b, T>, f: F, ) -> InterruptRefMut<'b, U>
where F: FnOnce(&mut T) -> &mut U,

Makes a new InterruptRefMut for a component of the borrowed data, e.g., an enum variant.

The InterruptRefCell is already mutably borrowed, so this cannot fail.

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

§Examples

use interrupt_ref_cell::{InterruptRefCell, InterruptRefMut};

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

Source

pub fn filter_map<U: ?Sized, F>( orig: InterruptRefMut<'b, T>, f: F, ) -> Result<InterruptRefMut<'b, U>, Self>
where F: FnOnce(&mut T) -> Option<&mut U>,

Makes a new InterruptRefMut for an optional component of the borrowed data. The original guard is returned as an Err(..) if the closure returns None.

The InterruptRefCell is already mutably borrowed, so this cannot fail.

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

§Examples

use interrupt_ref_cell::{InterruptRefCell, InterruptRefMut};

let c = InterruptRefCell::new(vec![1, 2, 3]);

{
    let b1: InterruptRefMut<'_, Vec<u32>> = c.borrow_mut();
    let mut b2: Result<InterruptRefMut<'_, u32>, _> = InterruptRefMut::filter_map(b1, |v| v.get_mut(1));

    if let Ok(mut b2) = b2 {
        *b2 += 2;
    }
}

assert_eq!(*c.borrow(), vec![1, 4, 3]);

Source

pub fn map_split<U: ?Sized, V: ?Sized, F>( orig: InterruptRefMut<'b, T>, f: F, ) -> (InterruptRefMut<'b, U>, InterruptRefMut<'b, V>)
where F: FnOnce(&mut T) -> (&mut U, &mut V),

Splits a InterruptRefMut into multiple InterruptRefMuts for different components of the borrowed data.

The underlying InterruptRefCell will remain mutably borrowed until both returned InterruptRefMuts go out of scope.

The InterruptRefCell is already mutably borrowed, so this cannot fail.

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

§Examples

use interrupt_ref_cell::{InterruptRefCell, InterruptRefMut};

let cell = InterruptRefCell::new([1, 2, 3, 4]);
let borrow = cell.borrow_mut();
let (mut begin, mut end) = InterruptRefMut::map_split(borrow, |slice| slice.split_at_mut(2));
assert_eq!(*begin, [1, 2]);
assert_eq!(*end, [3, 4]);
begin.copy_from_slice(&[4, 3]);
end.copy_from_slice(&[2, 1]);