Struct intuitive::state::State

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

A struct that triggers a re-render upon mutation.

State’s have interior mutability, and can be cloned. States cloned from one another share the inner reference to a T, and therefore mutating one of them will be reflected across all of the cloned states. For example,

let count = use_state(|| 0);

let other_count = count.clone();
other_count.set(1);

// both `count` and `other_count` are `1`
assert_eq!(count.get(), other_count.get());

This is useful when receiving a State as a parameter from a parent component, as it must be cloned, and then may be mutated by both the child and parent components.

Implementations

impl<T> State<T>

pub fn set(&self, new: T)

Sets a new value for the state and triggers a re-render.

pub fn inspect<F, R>(&self, f: F) -> Rwhere F: FnOnce(&T) -> R,

Calls a function on the inner value and returns its result. Does not trigger a re-render.

pub fn mutate<F, R>(&self, f: F)where F: FnOnce(&mut T) -> R,

Calls a function on a mutable reference of the inner value and triggers a re-render.

pub fn update<F>(&self, f: F)where F: FnOnce(&T) -> T,

Calls a function on the inner value, replaces it with the result, and triggers a re-render.

impl<T: Clone> State<T>

pub fn get(&self) -> T

Returns a clone of the State<T>’s inner value.

Trait Implementations

impl<T> Clone for State<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

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

fn default() -> State<T>

Returns the “default value” for a type.