Enum UseRwSignal

pub enum UseRwSignal<T: 'static, S = SyncStorage>
where
    S: Storage<T>,
{
    Separate(Signal<T, S>, WriteSignal<T, S>),
    Combined(RwSignal<T, S>),
}

Variants

Separate(Signal<T, S>, WriteSignal<T, S>)

Combined(RwSignal<T, S>)

Trait Implementations

impl<T, S> Clone for UseRwSignal<T, S>

where S: Storage<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> Default for UseRwSignal<T>

where T: Default + Send + Sync,

fn default() -> Self

Returns the “default value” for a type.

impl<T> Default for UseRwSignal<T, LocalStorage>

where T: Default,

fn default() -> Self

Returns the “default value” for a type.

impl<T, S> DefinedAt for UseRwSignal<T, S>

where S: Storage<T>,

fn defined_at(&self) -> Option<&'static Location<'static>>

Returns the location at which the signal was defined. This is usually simply None in release mode.

impl<T, S, RS> From<(RS, WriteSignal<T, S>)> for UseRwSignal<T, S>

where RS: Into<Signal<T, S>>, S: Storage<T>,

fn from(s: (RS, WriteSignal<T, S>)) -> Self

Converts to this type from the input type.

impl<T, S> From<RwSignal<T, S>> for UseRwSignal<T, S>

where S: Storage<T>,

fn from(s: RwSignal<T, S>) -> Self

Converts to this type from the input type.

impl<T, S> Set for UseRwSignal<T, S>

where RwSignal<T, S>: Set<Value = T>, WriteSignal<T, S>: Set<Value = T>, S: Storage<T>,

type Value = T

The type of the value contained in the signal.

fn set(&self, new_value: T)

Updates the value by replacing it, and notifies subscribers that it has changed.

fn try_set(&self, new_value: T) -> Option<T>

Updates the value by replacing it, and notifies subscribers that it has changed.

impl<T, S> Update for UseRwSignal<T, S>

where RwSignal<T, S>: Update<Value = T>, WriteSignal<T, S>: Update<Value = T>, S: Storage<T>,

type Value = T

The type of the value contained in the signal.

fn update(&self, f: impl FnOnce(&mut T))

Updates the value of the signal and notifies subscribers.

fn try_update<O>(&self, f: impl FnOnce(&mut T) -> O) -> Option<O>

Updates the value of the signal and notifies subscribers, returning the value that is returned by the update function, or None if the signal has already been disposed.

fn maybe_update(&self, fun: impl FnOnce(&mut Self::Value) -> bool)

Updates the value of the signal, but only notifies subscribers if the function returns true.

fn try_maybe_update<U>( &self, fun: impl FnOnce(&mut Self::Value) -> (bool, U), ) -> Option<U>

Updates the value of the signal, notifying subscribers if the update function returns (true, _), and returns the value returned by the update function, or None if the signal has already been disposed.

impl<T, S> With for UseRwSignal<T, S>

where RwSignal<T, S>: With<Value = T>, Signal<T, S>: With<Value = T>, ReadSignal<T, S>: With<Value = T>, S: Storage<T>,

type Value = T

The type of the value contained in the signal.

fn with<R>(&self, f: impl FnOnce(&T) -> R) -> R

Subscribes to the signal, applies the closure to the value, and returns the result.

fn try_with<R>(&self, f: impl FnOnce(&T) -> R) -> Option<R>

Subscribes to the signal, applies the closure to the value, and returns the result, or None if the signal has already been disposed.

impl<T, S> WithUntracked for UseRwSignal<T, S>

where RwSignal<T, S>: WithUntracked<Value = T>, Signal<T, S>: WithUntracked<Value = T>, ReadSignal<T, S>: WithUntracked<Value = T>, S: Storage<T>,

type Value = T

The type of the value contained in the signal.

fn with_untracked<R>(&self, f: impl FnOnce(&T) -> R) -> R

Applies the closure to the value, and returns the result.

fn try_with_untracked<R>(&self, f: impl FnOnce(&T) -> R) -> Option<R>

Applies the closure to the value, and returns the result, or None if the signal has already been disposed.

impl<T, S> Copy for UseRwSignal<T, S>

where S: Storage<T>,