Struct RwSignal 

pub struct RwSignal<T, S = UnsyncStorage> { /* private fields */ }

A read write Signal which can act as both a Getter and a Setter

Implementations

impl<T, S> RwSignal<T, S>

pub fn id(&self) -> Id

impl<T, S> RwSignal<T, S>

pub fn read_only(&self) -> ReadSignal<T, S>

Create a Getter of this Signal

pub fn write_only(&self) -> WriteSignal<T, S>

Create a Setter of this Signal

impl<T: Send + Sync + 'static> RwSignal<T, SyncStorage>

pub fn new_sync(value: T) -> Self

Creates a sync signal. When called off the UI thread, the signal is left unscoped, so callers must ensure it is disposed manually.

pub fn new_sync_split( value: T, ) -> (ReadSignal<T, SyncStorage>, WriteSignal<T, SyncStorage>)

Creates a sync signal with separate read/write handles. Off-UI calls leave the signal unscoped; the caller is responsible for disposal.

impl<T: 'static> RwSignal<T, UnsyncStorage>

pub fn new(value: T) -> Self

pub fn new_split( value: T, ) -> (ReadSignal<T, UnsyncStorage>, WriteSignal<T, UnsyncStorage>)

Trait Implementations

impl<T: Add<Output = T> + 'static> Add<T> for RwSignal<T>

where for<'a> &'a T: Add<T, Output = T>,

type Output = T

The resulting type after applying the + operator.

fn add(self, rhs: T) -> Self::Output

Performs the + operation.

impl<T: AddAssign + 'static> AddAssign<T> for RwSignal<T>

fn add_assign(&mut self, rhs: T)

Performs the += operation.

impl<T: BitAnd<Output = T> + 'static> BitAnd<T> for RwSignal<T>

where for<'a> &'a T: BitAnd<T, Output = T>,

type Output = T

The resulting type after applying the & operator.

fn bitand(self, rhs: T) -> Self::Output

Performs the & operation.

impl<T: BitAndAssign + 'static> BitAndAssign<T> for RwSignal<T>

fn bitand_assign(&mut self, rhs: T)

Performs the &= operation.

impl<T: BitOr<Output = T> + 'static> BitOr<T> for RwSignal<T>

where for<'a> &'a T: BitOr<T, Output = T>,

type Output = T

The resulting type after applying the | operator.

fn bitor(self, rhs: T) -> Self::Output

Performs the | operation.

impl<T: BitOrAssign + 'static> BitOrAssign<T> for RwSignal<T>

fn bitor_assign(&mut self, rhs: T)

Performs the |= operation.

impl<T: BitXor<Output = T> + 'static> BitXor<T> for RwSignal<T>

where for<'a> &'a T: BitXor<T, Output = T>,

type Output = T

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: T) -> Self::Output

Performs the ^ operation.

impl<T: BitXorAssign + 'static> BitXorAssign<T> for RwSignal<T>

fn bitxor_assign(&mut self, rhs: T)

Performs the ^= operation.

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

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, S> Debug for RwSignal<T, S>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Default + 'static> Default for RwSignal<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Display + 'static> Display for RwSignal<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Div<Output = T> + 'static> Div<T> for RwSignal<T>

where for<'a> &'a T: Div<T, Output = T>,

type Output = T

The resulting type after applying the / operator.

fn div(self, rhs: T) -> Self::Output

Performs the / operation.

impl<T: DivAssign + 'static> DivAssign<T> for RwSignal<T>

fn div_assign(&mut self, rhs: T)

Performs the /= operation.

impl<T: Mul<Output = T> + 'static> Mul<T> for RwSignal<T>

where for<'a> &'a T: Mul<T, Output = T>,

type Output = T

The resulting type after applying the * operator.

fn mul(self, rhs: T) -> Self::Output

Performs the * operation.

impl<T: MulAssign + 'static> MulAssign<T> for RwSignal<T>

fn mul_assign(&mut self, rhs: T)

Performs the *= operation.

impl<T: 'static> Neg for RwSignal<T>

where for<'a> &'a T: Neg<Output = T>,

type Output = T

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<T: 'static> Not for RwSignal<T>

where for<'a> &'a T: Not<Output = T>,

type Output = T

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl<T: PartialEq + 'static> PartialEq<T> for RwSignal<T>

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T, S> PartialEq for RwSignal<T, S>

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T: Rem<Output = T> + 'static> Rem<T> for RwSignal<T>

where for<'a> &'a T: Rem<T, Output = T>,

type Output = T

The resulting type after applying the % operator.

fn rem(self, rhs: T) -> Self::Output

Performs the % operation.

impl<T: RemAssign + 'static> RemAssign<T> for RwSignal<T>

fn rem_assign(&mut self, rhs: T)

Performs the %= operation.

impl<T: Shl<Output = T> + 'static> Shl<T> for RwSignal<T>

where for<'a> &'a T: Shl<T, Output = T>,

type Output = T

The resulting type after applying the << operator.

fn shl(self, rhs: T) -> Self::Output

Performs the << operation.

impl<T: ShlAssign + 'static> ShlAssign<T> for RwSignal<T>

fn shl_assign(&mut self, rhs: T)

Performs the <<= operation.

impl<T: Shr<Output = T> + 'static> Shr<T> for RwSignal<T>

where for<'a> &'a T: Shr<T, Output = T>,

type Output = T

The resulting type after applying the >> operator.

fn shr(self, rhs: T) -> Self::Output

Performs the >> operation.

impl<T: ShrAssign + 'static> ShrAssign<T> for RwSignal<T>

fn shr_assign(&mut self, rhs: T)

Performs the >>= operation.

impl<T: Clone> SignalGet<T> for RwSignal<T, UnsyncStorage>

fn id(&self) -> Id

get the Signal Id

fn get_untracked(&self) -> T

where T: 'static,

fn get(&self) -> T

where T: 'static,

fn try_get(&self) -> Option<T>

where T: 'static,

fn try_get_untracked(&self) -> Option<T>

where T: 'static,

impl<T: Clone + Send + Sync> SignalGet<T> for RwSignal<T, SyncStorage>

fn id(&self) -> Id

get the Signal Id

fn get_untracked(&self) -> T

where T: 'static,

fn get(&self) -> T

where T: 'static,

fn try_get(&self) -> Option<T>

where T: 'static,

fn try_get_untracked(&self) -> Option<T>

where T: 'static,

impl<T> SignalRead<T> for RwSignal<T, UnsyncStorage>

fn id(&self) -> Id

get the Signal Id

fn try_read(&self) -> Option<ReadRef<'_, T>>

where T: 'static,

If the signal isn’t disposed, reads the data stored in the Signal and subscribes to the current running effect.

fn try_read_untracked(&self) -> Option<ReadRef<'_, T>>

where T: 'static,

If the signal isn’t disposed, reads the data stored in the Signal without subscribing.

fn read(&self) -> ReadRef<'_, T>

where T: 'static,

Reads the data stored in the Signal, subscribing the current running effect.

fn read_untracked(&self) -> ReadRef<'_, T>

where T: 'static,

Reads the data stored in the Signal without subscribing.

impl<T: Send + Sync> SignalRead<T> for RwSignal<T, SyncStorage>

fn id(&self) -> Id

get the Signal Id

fn try_read(&self) -> Option<ReadRef<'_, T>>

where T: 'static,

If the signal isn’t disposed, reads the data stored in the Signal and subscribes to the current running effect.

fn try_read_untracked(&self) -> Option<ReadRef<'_, T>>

where T: 'static,

If the signal isn’t disposed, reads the data stored in the Signal without subscribing.

fn read(&self) -> ReadRef<'_, T>

where T: 'static,

Reads the data stored in the Signal, subscribing the current running effect.

fn read_untracked(&self) -> ReadRef<'_, T>

where T: 'static,

Reads the data stored in the Signal without subscribing.

impl<T, S> SignalTrack<T> for RwSignal<T, S>

fn id(&self) -> Id

fn track(&self)

Only subscribes to the current running effect to this Signal.

fn try_track(&self)

If the signal isn’t disposed,

impl<T> SignalUpdate<T> for RwSignal<T, UnsyncStorage>

fn id(&self) -> Id

get the Signal Id

fn set(&self, new_value: T)

where T: 'static,

Sets the new_value to the Signal and triggers effect run

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

where T: 'static,

Update the stored value with the given function and triggers effect run

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

where T: 'static,

Update the stored value with the given function, triggers effect run, and returns the value returned by the function

impl<T: Send + Sync> SignalUpdate<T> for RwSignal<T, SyncStorage>

fn id(&self) -> Id

get the Signal Id

fn set(&self, new_value: T)

where T: 'static,

Sets the new_value to the Signal and triggers effect run

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

where T: 'static,

Update the stored value with the given function and triggers effect run

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

where T: 'static,

Update the stored value with the given function, triggers effect run, and returns the value returned by the function

impl<T> SignalWith<T> for RwSignal<T, UnsyncStorage>

fn id(&self) -> Id

get the Signal Id

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

where T: 'static,

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

where T: 'static,

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

where T: 'static,

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

where T: 'static,

impl<T: Send + Sync> SignalWith<T> for RwSignal<T, SyncStorage>

fn id(&self) -> Id

get the Signal Id

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

where T: 'static,

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

where T: 'static,

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

where T: 'static,

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

where T: 'static,

impl<T> SignalWrite<T> for RwSignal<T, UnsyncStorage>

fn id(&self) -> Id

get the Signal Id

fn write(&self) -> WriteRef<'_, T>

where T: 'static,

Mutably borrows the signal value, triggering subscribers when dropped.

fn try_write(&self) -> Option<WriteRef<'_, T>>

where T: 'static,

If the Signal isn’t disposed, mutably borrows the signal value.

impl<T: Send + Sync> SignalWrite<T> for RwSignal<T, SyncStorage>

fn id(&self) -> Id

get the Signal Id

fn write(&self) -> WriteRef<'_, T>

where T: 'static,

Mutably borrows the signal value, triggering subscribers when dropped.

fn try_write(&self) -> Option<WriteRef<'_, T>>

where T: 'static,

If the Signal isn’t disposed, mutably borrows the signal value.

impl<T: Sub<Output = T> + 'static> Sub<T> for RwSignal<T>

where for<'a> &'a T: Sub<T, Output = T>,

type Output = T

The resulting type after applying the - operator.

fn sub(self, rhs: T) -> Self::Output

Performs the - operation.

impl<T: SubAssign + 'static> SubAssign<T> for RwSignal<T>

fn sub_assign(&mut self, rhs: T)

Performs the -= operation.

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

impl<T, S> Eq for RwSignal<T, S>