Struct yew_state::handle::StateHandle

pub struct StateHandle<HANDLER> where
    HANDLER: StateHandler,
    <HANDLER as StateHandler>::Message: Clone,
    <HANDLER as StateHandler>::Output: Clone,
    <HANDLER as StateHandler>::Input: Clone,
    <HANDLER as StateHandler>::Model: Clone + 'static,  { /* fields omitted */ }

Interface to shared state

Implementations

impl<HANDLER> StateHandle<HANDLER> where
    HANDLER: StateHandler,
    <HANDLER as StateHandler>::Message: Clone,
    <HANDLER as StateHandler>::Output: Clone,
    <HANDLER as StateHandler>::Input: Clone,
    <HANDLER as StateHandler>::Model: Clone + 'static, 

pub fn link(&self) -> &HandlerLink<HANDLER>

pub fn state(&self) -> &<HANDLER as StateHandler>::Model

pub fn reduce(
    &self,
    f: impl FnOnce(&mut <HANDLER as StateHandler>::Model) + '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 <HANDLER as StateHandler>::Model) + 'static
) -> Callback<E> where
    <HANDLER as StateHandler>::Model: '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 <HANDLER as StateHandler>::Model) + 'static
) -> Callback<E> where
    <HANDLER as StateHandler>::Model: '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 <HANDLER as StateHandler>::Model, E) + 'static
) -> Callback<E> where
    <HANDLER as StateHandler>::Model: '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 <HANDLER as StateHandler>::Model, E) + 'static
) -> Callback<E> where
    <HANDLER as StateHandler>::Model: '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<HANDLER> Clone for StateHandle<HANDLER> where
    HANDLER: StateHandler,
    HandlerLink<HANDLER>: Clone,
    <HANDLER as StateHandler>::Message: Clone,
    <HANDLER as StateHandler>::Output: Clone,
    <HANDLER as StateHandler>::Input: Clone,
    <HANDLER as StateHandler>::Model: Clone, 

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<HANDLER> Default for StateHandle<HANDLER> where
    HANDLER: StateHandler,
    <HANDLER as StateHandler>::Message: Clone,
    <HANDLER as StateHandler>::Output: Clone,
    <HANDLER as StateHandler>::Input: Clone,
    <HANDLER as StateHandler>::Model: Clone, 

fn default() -> Self

Returns the “default value” for a type.

impl<HANDLER> Handle for StateHandle<HANDLER> where
    HANDLER: StateHandler,
    <HANDLER as StateHandler>::Message: Clone,
    <HANDLER as StateHandler>::Output: Clone,
    <HANDLER as StateHandler>::Input: Clone,
    <HANDLER as StateHandler>::Model: Clone + 'static, 

type Handler = HANDLER

impl<HANDLER> PartialEq<StateHandle<HANDLER>> for StateHandle<HANDLER> where
    HANDLER: StateHandler,
    <HANDLER as StateHandler>::Message: Clone,
    <HANDLER as StateHandler>::Output: Clone,
    <HANDLER as StateHandler>::Input: Clone,
    <HANDLER as StateHandler>::Model: Clone, 

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

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

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

This method tests for !=.

impl<HANDLER> Properties for StateHandle<HANDLER> where
    HANDLER: StateHandler,
    <HANDLER as StateHandler>::Message: Clone,
    <HANDLER as StateHandler>::Output: Clone,
    <HANDLER as StateHandler>::Input: Clone,
    <HANDLER as StateHandler>::Model: Clone + 'static, 

type Builder = StateHandleBuilder<HANDLER, StateHandleBuilderStep_build>

Builder that will be used to construct properties

fn builder() -> Self::Builder

Entrypoint for building properties

impl<HANDLER> SharedState for StateHandle<HANDLER> where
    HANDLER: StateHandler,
    <HANDLER as StateHandler>::Message: Clone,
    <HANDLER as StateHandler>::Output: Clone,
    <HANDLER as StateHandler>::Input: Clone,
    <HANDLER as StateHandler>::Model: Clone, 

type Handle = Self

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

impl<HANDLER> WrapperHandle for StateHandle<HANDLER> where
    HANDLER: StateHandler,
    <HANDLER as StateHandler>::Message: Clone,
    <HANDLER as StateHandler>::Output: Clone,
    <HANDLER as StateHandler>::Input: Clone,
    <HANDLER as StateHandler>::Model: Clone + 'static, 

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

fn set_link(&mut self, link: HandlerLink<Self::Handler>)

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