Struct cmim::Move

pub struct Move<T, I> { /* fields omitted */ }

Methods

impl<T, I> Move<T, I>

pub const fn new_uninitialized(inter: I) -> Self

pub const fn new(data: T, inter: I) -> Self

impl<T, I> Move<T, I> where
    T: Send + Sized,
    I: Nr, 

pub fn try_move(&self, data: T) -> Result<Option<T>, T>

Attempt to initialize the data of the Move structure. This MUST be called from non-interrupt context, and a critical section will be in place while setting the data.

Returns:

• Ok(Some(T)): If we are in thread mode and the data was previously initialized
• Ok(None): If we are in thread mode and the data was not previously initialized
• Err(()): If we are not in thread mode (e.g. an interrupt is active)

pub fn try_free(&self) -> Result<Option<T>, ()>

Attempt to recover the data from the Move structure. This MUST be called from non-interrupt context, and a critical section will be in place while receiving the data.

Returns:

• Ok(Some(T)): If we are in thread mode and the data was previously initialized
• Ok(None): If we are in thread mode and the data was not previously initialized
• Err(()): If we are not in thread mode (e.g. an interrupt is active)

pub fn try_lock<R>(&self, f: impl FnOnce(&mut T) -> R) -> Result<R, ()>

So, this isn't a classical mutex. It will only provide access if:

• The selected interrupt is currently active
• The mutex has not already been locked

If these conditions are met, then you can access the variable from within a closure

Trait Implementations

impl<T, I> Sync for Move<T, I> where
    T: Send + Sized,
    I: Nr,