Struct MutAppState 

pub struct MutAppState<T: ?Sized>(/* private fields */);

A mutable app state.

Examples

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

struct MyState {
  counter: u32,
}

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

Implementations

impl<T: 'static + Send> MutAppState<T>

pub fn get_mut(&self) -> MutAppStateLock<'_, T>

Returns reference to inner T.

impl<T: ?Sized> MutAppState<T>

pub fn into_inner(self) -> Arc<Mutex<T>>

Unwraps to the internal Arc<T>

Trait Implementations

impl<T: 'static + Send> AppStateTrait<T, MutAppState<T>> for MutAppState<T>

fn init(state: T)

Initializes the state store with the given state. If the state store has already been initialized, this will overwrite the existing state.

fn init_if_not_exists<F: FnOnce() -> T>(state: F)

Initializes the state store with the given state. If the state store has already been initialized, this will do nothing. This is useful for initializing the state store with a default state. If you want to overwrite the existing state, use init instead.

fn get() -> U

Returns a reference to the state. If the state store has not been initialized, this will panic.

fn try_get() -> Result<U, Box<dyn Error>>

Returns a reference to the state. If the state store has not been initialized, this will return Err.

fn get_or_insert(val: T) -> U

Returns a reference to the state. Inserts the supplied value if the state store has not been initialized.

fn get_or_insert_with<F: FnOnce() -> T>(f: F) -> U

Returns a reference to the state. Inserts the supplied value if the state store has not been initialized.

fn get_or_insert_default() -> U

where T: Default,

Returns a reference to the state. Inserts the default value of T if the state store has not been initialized.

impl<T: ?Sized> Clone for MutAppState<T>

fn clone(&self) -> MutAppState<T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: 'static + Send> CreateAppState<T> for MutAppState<T>

fn new(state: T) -> MutAppState<T>

impl<T: Debug + ?Sized> Debug for MutAppState<T>

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

Formats the value using the given formatter.

impl<T: ?Sized> Deref for MutAppState<T>

type Target = Arc<Mutex<T>>

The resulting type after dereferencing.

fn deref(&self) -> &Arc<Mutex<T>>

Dereferences the value.

impl<T: ?Sized> From<Arc<Mutex<T>>> for MutAppState<T>

fn from(arc: Arc<Mutex<T>>) -> Self

Converts to this type from the input type.