Struct valerie::state::StateMutex

pub struct StateMutex<T> { /* fields omitted */ }

State variable to be used with types that implement Clone

This uses Mutex of parking_lot internally.

Implementations

impl<T> StateMutex<T>

pub fn new(value: T) -> Self

Make a new StateMutex variable.

Examples

let state = StateMutex::new(String::from("Hello, World!"));
h3!(state)

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

pub fn from<U, F>(state: &U, func: F) -> Self where
    U: StateTrait + 'static,
    F: FnMut(U::Value) -> Self::Value + 'static, 

Derive a StateAtomic variable from another variable implementing StateTrait.

Examples

let string = StateMutex::new(String::from("This is a test."));
let length = StateMutex::from(&string, |x| {
    let mut result = String::from("The length is ");
    result.push_str(&x.len().to_string());
    result
});

div!(
    h3!("String: ", string),
    h3!(length)
)

Trait Implementations

impl<T, U> Add<U> for StateMutex<T> where
    T: Display + Clone + Add<U> + AddAssign<U>, 

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: U) -> Self::Output

Performs the + operation.

impl<T, U> AddAssign<U> for StateMutex<T> where
    T: Display + Clone + AddAssign<U>, 

fn add_assign(&mut self, other: U)

Performs the += operation.

impl<T> Clone for StateMutex<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

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

impl<T, U> Div<U> for StateMutex<T> where
    T: Display + Clone + Div<U> + DivAssign<U>, 

type Output = Self

The resulting type after applying the / operator.

fn div(self, other: U) -> Self::Output

Performs the / operation.

impl<T, U> DivAssign<U> for StateMutex<T> where
    T: Display + Clone + DivAssign<U>, 

fn div_assign(&mut self, other: U)

Performs the /= operation.

impl<T> Eq for StateMutex<T>

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

fn from(x: StateMutex<T>) -> Self

Performs the conversion.

impl<T, U> Mul<U> for StateMutex<T> where
    T: Display + Clone + Mul<U> + MulAssign<U>, 

type Output = Self

The resulting type after applying the * operator.

fn mul(self, other: U) -> Self::Output

Performs the * operation.

impl<T, U> MulAssign<U> for StateMutex<T> where
    T: Display + Clone + MulAssign<U>, 

fn mul_assign(&mut self, other: U)

Performs the *= operation.

impl<T> PartialEq<StateMutex<T>> for StateMutex<T>

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, U> Rem<U> for StateMutex<T> where
    T: Display + Clone + Rem<U> + RemAssign<U>, 

type Output = Self

The resulting type after applying the % operator.

fn rem(self, other: U) -> Self::Output

Performs the % operation.

impl<T, U> RemAssign<U> for StateMutex<T> where
    T: Display + Clone + RemAssign<U>, 

fn rem_assign(&mut self, other: U)

Performs the %= operation.

impl<T> StateTrait for StateMutex<T> where
    T: Display + Clone, 

type Value = T

Type that is stored in the State variable.

type Store = Mutex<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, U> Sub<U> for StateMutex<T> where
    T: Display + Clone + Sub<U> + SubAssign<U>, 

type Output = Self

The resulting type after applying the - operator.

fn sub(self, other: U) -> Self::Output

Performs the - operation.

impl<T, U> SubAssign<U> for StateMutex<T> where
    T: Display + Clone + SubAssign<U>, 

fn sub_assign(&mut self, other: U)

Performs the -= operation.