StateHandle

Struct StateHandle 

Source
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,
{ /* private fields */ }
Expand description

Interface to shared state

Implementations§

Source§

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,

Source

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

Source

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.

Source

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.

Source

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.

Source

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

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

Source

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§

Source§

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,

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
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,

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

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,

Source§

type Handler = HANDLER

Source§

impl<HANDLER> PartialEq 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,

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

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,

Source§

type Builder = StateHandleBuilder<HANDLER, StateHandleBuilderStep_build>

Builder that will be used to construct properties
Source§

fn builder() -> Self::Builder

Entrypoint for building properties
Source§

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,

Source§

type Handle = StateHandle<HANDLER>

Source§

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

Source§

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,

Source§

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

Source§

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)>>, )

Auto Trait Implementations§

§

impl<HANDLER> Freeze for StateHandle<HANDLER>
where <HANDLER as StateHandler>::Model: Sized, <HANDLER as StateHandler>::Input: Sized, <HANDLER as StateHandler>::Output: Sized, <HANDLER as StateHandler>::Message: Sized,

§

impl<HANDLER> !RefUnwindSafe for StateHandle<HANDLER>

§

impl<HANDLER> !Send for StateHandle<HANDLER>

§

impl<HANDLER> !Sync for StateHandle<HANDLER>

§

impl<HANDLER> Unpin for StateHandle<HANDLER>
where <HANDLER as StateHandler>::Model: Sized, <HANDLER as StateHandler>::Input: Sized, <HANDLER as StateHandler>::Output: Sized, <HANDLER as StateHandler>::Message: Sized,

§

impl<HANDLER> !UnwindSafe for StateHandle<HANDLER>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Any for T
where T: Any,

Source§

impl<T> CloneAny for T
where T: Any + Clone,