Struct freya::prelude::UseSharedState

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

State that is shared between components through the context system

Implementations

impl<T> UseSharedState<T>

pub fn notify_consumers(&self)

Notify all consumers of the state that it has changed. (This is called automatically when you call “write”)

pub fn try_read(&self) -> Result<Ref<'_, T>, UseSharedStateError>

Try reading the shared state

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

Read the shared value

pub fn try_write(&self) -> Result<RefMut<'_, T>, UseSharedStateError>

Try writing the shared state

pub fn write(&self) -> RefMut<'_, T>

Calling “write” will force the component to re-render

pub fn try_write_silent(&self) -> Result<RefMut<'_, T>, UseSharedStateError>

Tries writing the value without forcing a re-render

pub fn write_silent(&self) -> RefMut<'_, T>

Writes the value without forcing a re-render

pub fn with<O>(&self, immutable_callback: impl FnOnce(&T) -> O) -> O

Take a reference to the inner value temporarily and produce a new value

pub fn with_mut<O>(&self, mutable_callback: impl FnOnce(&mut T) -> O) -> O

Take a mutable reference to the inner value temporarily and produce a new value

Trait Implementations

impl<T> Clone for UseSharedState<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> PartialEq for UseSharedState<T>

fn eq(&self, other: &UseSharedState<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.