Struct State 

pub struct State<T: Clone> { /* private fields */ }

The atomic state

Implementations

impl<T: Clone> State<T>

pub fn new(value: T) -> Self

Creates a new state

pub fn lock(&self) -> StateGuard<'_, T>

Returns a locked state guard

Examples found in repository

examples/test_state.rs (line 21)

fn main() {
    CONFIG.set(Config { count: 10, });
    assert_eq!(CONFIG.get().count, 10);

    CONFIG.map(|cfg| cfg.count = 20);
    assert_eq!(CONFIG.get().count, 20);
    
    CONFIG.lock().count = 30;
    assert_eq!(CONFIG.get().count, 30);
}

pub fn get(&self) -> Arc<T>

Returns a state value

Examples found in repository

examples/test_state.rs (line 16)

fn main() {
    CONFIG.set(Config { count: 10, });
    assert_eq!(CONFIG.get().count, 10);

    CONFIG.map(|cfg| cfg.count = 20);
    assert_eq!(CONFIG.get().count, 20);
    
    CONFIG.lock().count = 30;
    assert_eq!(CONFIG.get().count, 30);
}

pub fn get_cloned(&self) -> T

Returns a clone of state value

pub fn set(&self, value: T)

Sets a new value to state

Examples found in repository

examples/test_state.rs (line 15)

fn main() {
    CONFIG.set(Config { count: 10, });
    assert_eq!(CONFIG.get().count, 10);

    CONFIG.map(|cfg| cfg.count = 20);
    assert_eq!(CONFIG.get().count, 20);
    
    CONFIG.lock().count = 30;
    assert_eq!(CONFIG.get().count, 30);
}

pub fn map(&self, f: impl FnOnce(&mut T))

Writes data directly

Examples found in repository

examples/test_state.rs (line 18)

fn main() {
    CONFIG.set(Config { count: 10, });
    assert_eq!(CONFIG.get().count, 10);

    CONFIG.map(|cfg| cfg.count = 20);
    assert_eq!(CONFIG.get().count, 20);
    
    CONFIG.lock().count = 30;
    assert_eq!(CONFIG.get().count, 30);
}

Trait Implementations

impl<T: Clone + Clone> Clone for State<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Clone + Debugging> Debug for State<T>

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

Formats the value using the given formatter.

impl<T: Clone + Default> Default for State<T>

fn default() -> Self

Returns the “default value” for a type.