Struct AppState 

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

A thread-safe, read-only state container.

Examples

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

struct MyState {
  counter: u32,
}

#[stateful]
fn func(state: AppState<MyState>) {
  let state = state.get_ref();
  println!("Counter: {}", state.counter);
}

Implementations

impl<T: ?Sized> AppState<T>

pub fn get_ref(&self) -> &T

Returns reference to inner T.

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

Unwraps to the internal Arc<T>

Trait Implementations

impl<T: 'static + Send + Sync> AppStateTrait<T, AppState<T>> for AppState<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 AppState<T>

fn clone(&self) -> AppState<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 AppState<T>

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

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

type Target = Arc<T>

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: ?Sized> From<Arc<T>> for AppState<T>

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

Converts to this type from the input type.