Struct State 

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

A mutable value that notifies the observers that read it. Cloning a State clones the handle, not the value: all clones share one value.

Implementations

impl<T> State<T>

where T: 'static,

pub fn new(value: T) -> State<T>

Creates a state holding value.

pub fn get(&self) -> T

where T: Clone,

Returns a clone of the value and records the read.

pub fn with<R>(&self, f: impl FnOnce(&T) -> R) -> R

Reads the value by reference and records the read.

pub fn peek(&self) -> Ref<'_, T>

Borrows the value without recording a dependency.

pub fn set(&self, value: T)

Replaces the value and notifies dependents.

pub fn set_if_changed(&self, value: T)

where T: PartialEq,

Replaces the value only if it differs, notifying only on change.

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

Mutates the value in place and notifies dependents.

pub fn binding(&self) -> Binding<T>

where T: Clone,

A read/write view of this state for child components.

Trait Implementations

impl<T> 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> Debug for State<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Default for State<T>

where T: Default + 'static,

fn default() -> State<T>

Returns the “default value” for a type.

impl FromLive for State<Value>

fn from_live(value: Value) -> Result<State<Value>, String>

The value as this type, or why it cannot be.