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]);

Trait Implementations§

Source§

impl<T: ?Sized + Debug> Debug for InterruptRefMut<'_, T>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<T: ?Sized> Deref for InterruptRefMut<'_, T>

Source§

type Target = T

The resulting type after dereferencing.
Source§

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

Dereferences the value.
Source§

impl<T: ?Sized> DerefMut for InterruptRefMut<'_, T>

Source§

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

Mutably dereferences the value.
Source§

impl<T: ?Sized + Display> Display for InterruptRefMut<'_, T>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'b, T> Freeze for InterruptRefMut<'b, T>
where T: ?Sized,

§

impl<'b, T> !RefUnwindSafe for InterruptRefMut<'b, T>

§

impl<'b, T> !Send for InterruptRefMut<'b, T>

§

impl<'b, T> !Sync for InterruptRefMut<'b, T>

§

impl<'b, T> Unpin for InterruptRefMut<'b, T>
where T: ?Sized,

§

impl<'b, T> !UnwindSafe for InterruptRefMut<'b, T>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.