Struct yew_state::handle::StateHandle

pub struct StateHandle<T, H> where
    T: Default + Clone + 'static,
    H: Handler,  { /* fields omitted */ }

Interface to shared state

Implementations

impl<T, H> StateHandle<T, H> where
    T: Default + Clone + 'static,
    H: Handler<Model = T>, 

pub fn state(&self) -> &T

pub fn reduce(&self, f: impl FnOnce(&mut T) + 'static)

Apply a function that may mutate shared state. Changes are not immediate, and must be handled in Component::change.

pub fn reduce_callback<E: 'static>(
    &self,
    f: impl Fn(&mut T) + 'static
) -> Callback<E> where
    T: 'static, 

Convenience method for modifying shared state directly from a Callback. The callback event is ignored here, see reduce_callback_with for the alternative.

pub fn reduce_callback_once<E: 'static>(
    &self,
    f: impl FnOnce(&mut T) + 'static
) -> Callback<E> where
    T: 'static, 

Convenience method for modifying shared state directly from a CallbackOnce. The callback event is ignored here, see reduce_callback_once_with for the alternative.

pub fn reduce_callback_with<E: 'static>(
    &self,
    f: impl Fn(&mut T, E) + 'static
) -> Callback<E> where
    T: 'static,
    E: Clone, 

Convenience method for modifying shared state directly from a Callback. Similar to reduce_callback but it also accepts the fired event.

pub fn reduce_callback_once_with<E: 'static>(
    &self,
    f: impl FnOnce(&mut T, E) + 'static
) -> Callback<E> where
    T: 'static, 

Convenience method for modifying shared state directly from a CallbackOnce. Similar to reduce_callback but it also accepts the fired event.

Trait Implementations

impl<T, H> Clone for StateHandle<T, H> where
    T: Default + Clone + 'static,
    H: Handler, 

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, H: Default> Default for StateHandle<T, H> where
    T: Default + Clone + 'static,
    H: Handler, 

fn default() -> StateHandle<T, H>

Returns the "default value" for a type.

impl<T, H> Handle for StateHandle<T, H> where
    T: Default + Clone,
    H: Handler<Model = T>, 

type Handler = H

fn set_local_state(&mut self, state: Rc<<Self::Handler as Handler>::Model>)

fn set_local_callback(
    &mut self,
    callback: Callback<Rc<dyn Fn(&mut <Self::Handler as Handler>::Model)>>,
    callback_once: Callback<Box<dyn FnOnce(&mut <Self::Handler as Handler>::Model)>>
)

fn set_local(&mut self, other: &Self)

impl<T, H> PartialEq<StateHandle<T, H>> for StateHandle<T, H> where
    T: Default + PartialEq + Clone + 'static,
    H: Handler, 

fn eq(&self, other: &Self) -> bool

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T, H> Properties for StateHandle<T, H> where
    T: Default + Clone + 'static,
    H: Handler, 

type Builder = StateHandleBuilder<T, H, StateHandleBuilderStep_build>

Builder that will be used to construct properties

fn builder() -> Self::Builder

Entrypoint for building properties

impl<T, H> SharedState for StateHandle<T, H> where
    T: Default + Clone + 'static,
    H: Handler<Model = T>, 

type Handle = Self

fn handle(&mut self) -> &mut Self::Handle