MutAppStateLock

Struct MutAppStateLock 

Source
pub struct MutAppStateLock<'a, T: ?Sized>(/* private fields */);
Expand description

The lock guard for a mutable app state. This is a wrapper around MutexGuard. When this guard is dropped, the lock will be released. As this locks the state, no other thread can access the state until this guard is dropped.

§Examples

use app_state::{MutAppState, MutAppStateLock, AppStateTrait, stateful};

struct MyState {
  counter: u32,
}

#[stateful]
fn func(mut state: MutAppStateLock<MyState>) {
  state.counter += 1;
}

Implementations§

Source§

impl<'a, T: 'static + Send> MutAppStateLock<'a, T>

Source

pub fn new(inner: &'a MutAppState<T>) -> MutAppStateLock<'a, T>

Source§

impl<'a, T: ?Sized> MutAppStateLock<'a, T>

Source

pub fn get_ref(&self) -> &MutexGuard<'a, T>

Returns reference to inner T.

Source

pub fn into_inner(self) -> MutexGuard<'a, T>

Unwraps to the internal Arc<T>

Trait Implementations§

Source§

impl<'a, T: ?Sized> Deref for MutAppStateLock<'a, T>

Source§

type Target = T

The resulting type after dereferencing.
Source§

fn deref(&self) -> &T

Dereferences the value.
Source§

impl<'a, T: ?Sized> DerefMut for MutAppStateLock<'a, T>

Source§

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

Mutably dereferences the value.

Auto Trait Implementations§

§

impl<'a, T> Freeze for MutAppStateLock<'a, T>
where T: ?Sized,

§

impl<'a, T> RefUnwindSafe for MutAppStateLock<'a, T>
where T: ?Sized,

§

impl<'a, T> !Send for MutAppStateLock<'a, T>

§

impl<'a, T> Sync for MutAppStateLock<'a, T>
where T: Sync + ?Sized,

§

impl<'a, T> Unpin for MutAppStateLock<'a, T>
where T: ?Sized,

§

impl<'a, T> UnwindSafe for MutAppStateLock<'a, T>
where T: ?Sized,

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, 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.