Struct valerie::state::StateGeneric

pub struct StateGeneric<T, D> { /* fields omitted */ }

A generic State type

You can make your own type of State Variable using this.

Implementations

impl<T, D> StateGeneric<T, D>

pub fn new(
    value: D,
    reader: fn(_: &T) -> D,
    writer: fn(_: &T, _: D),
    new: fn(_: D) -> T
) -> Self

To make a new Generic State type.

Description

• value - The data to store
• reader - The reader function which reads the function
• writer - The writer function
• new - To make enclose the value, eg: Mutex::new

impl<T, D> StateGeneric<T, D> where
    T: 'static,
    D: Display + Clone + 'static, 

pub fn from<U, F>(
    state: &U,
    func: F,
    reader: fn(_: &T) -> D,
    writer: fn(_: &T, _: D),
    new: fn(_: D) -> T
) -> Self where
    U: StateTrait + 'static,
    F: FnMut(U::Value) -> Self::Value + 'static, 

A from function to derive the value from other state variables.

Trait Implementations

impl<T, D> Clone for StateGeneric<T, D>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, D> Component for StateGeneric<T, D> where
    D: Display + Clone, 

impl<T, D> Eq for StateGeneric<T, D>

impl<T, D> From<StateGeneric<T, D>> for Node where
    D: Display + Clone, 

fn from(x: StateGeneric<T, D>) -> Self

Performs the conversion.

impl<T, D> PartialEq<StateGeneric<T, D>> for StateGeneric<T, D>

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, D> StateTrait for StateGeneric<T, D> where
    D: Display + Clone, 

type Value = D

Type that is stored in the State variable.

type Store = T

Type that is wrapped in Arc which stores the value.

type Channel = Channel

Channel type is used to pass the message between the Sender and the Receiver.

fn value(&self) -> Self::Value

Returns a copy of the original value stored.

fn tx(&self) -> StateSender<Self::Channel>

Returns the clone of the Sender.

fn rx(&self) -> StateReceiver<Self::Channel>

Returns the clone of the Receiver.

fn put(&self, value: Self::Value)

Stores the value on to the State variable.

fn pointer(&self) -> Arc<Self::Store>

Gives a pointer to the value.

fn update(&self)

Update the value across the DOM. put() should call this.

impl<T, D> Value for StateGeneric<T, D> where
    D: Clone + Display, 

fn bind_func(&self, func: Box<dyn FnMut(&str)>)

The bind_func has to call the func function with the parameter as its own value whenever it is updated. Ignore the repeated calls if your type is not a state variable.