Struct Signal 

pub struct Signal<T> { /* private fields */ }

A local (UI-thread) read write Signal.

Implementations

impl<T> Signal<T>

pub fn id(&self) -> Id

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

Create a Getter of this Signal

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

Create a Setter of this Signal

impl<T> Signal<T>

where T: 'static,

pub fn new(value: T) -> Signal<T>

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

Trait Implementations

impl<T> Add<T> for Signal<T>

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

type Output = T

The resulting type after applying the + operator.

fn add(self, rhs: T) -> <Signal<T> as Add<T>>::Output

Performs the + operation.

impl<T> AddAssign<T> for Signal<T>

where T: AddAssign + 'static,

fn add_assign(&mut self, rhs: T)

Performs the += operation.

impl<T> BitAnd<T> for Signal<T>

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

type Output = T

The resulting type after applying the & operator.

fn bitand(self, rhs: T) -> <Signal<T> as BitAnd<T>>::Output

Performs the & operation.

impl<T> BitAndAssign<T> for Signal<T>

where T: BitAndAssign + 'static,

fn bitand_assign(&mut self, rhs: T)

Performs the &= operation.

impl<T> BitOr<T> for Signal<T>

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

type Output = T

The resulting type after applying the | operator.

fn bitor(self, rhs: T) -> <Signal<T> as BitOr<T>>::Output

Performs the | operation.

impl<T> BitOrAssign<T> for Signal<T>

where T: BitOrAssign + 'static,

fn bitor_assign(&mut self, rhs: T)

Performs the |= operation.

impl<T> BitXor<T> for Signal<T>

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

type Output = T

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: T) -> <Signal<T> as BitXor<T>>::Output

Performs the ^ operation.

impl<T> BitXorAssign<T> for Signal<T>

where T: BitXorAssign + 'static,

fn bitxor_assign(&mut self, rhs: T)

Performs the ^= operation.

impl<T> Clone for Signal<T>

fn clone(&self) -> Signal<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Signal<T>

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

Formats the value using the given formatter.

impl<T> Default for Signal<T>

where T: Default + 'static,

fn default() -> Signal<T>

Returns the “default value” for a type.

impl<T> Display for Signal<T>

where T: Display + 'static,

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

Formats the value using the given formatter.

impl<T> Div<T> for Signal<T>

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

type Output = T

The resulting type after applying the / operator.

fn div(self, rhs: T) -> <Signal<T> as Div<T>>::Output

Performs the / operation.

impl<T> DivAssign<T> for Signal<T>

where T: DivAssign + 'static,

fn div_assign(&mut self, rhs: T)

Performs the /= operation.

impl<T> From<T> for Signal<T>

where T: 'static,

fn from(value: T) -> Signal<T>

Converts to this type from the input type.

impl<T> Mul<T> for Signal<T>

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

type Output = T

The resulting type after applying the * operator.

fn mul(self, rhs: T) -> <Signal<T> as Mul<T>>::Output

Performs the * operation.

impl<T> MulAssign<T> for Signal<T>

where T: MulAssign + 'static,

fn mul_assign(&mut self, rhs: T)

Performs the *= operation.

impl<T> Neg for Signal<T>

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

type Output = T

The resulting type after applying the - operator.

fn neg(self) -> <Signal<T> as Neg>::Output

Performs the unary - operation.

impl<T> Not for Signal<T>

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

type Output = T

The resulting type after applying the ! operator.

fn not(self) -> <Signal<T> as Not>::Output

Performs the unary ! operation.

impl<T> PartialEq<T> for Signal<T>

where T: PartialEq + 'static,

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> PartialEq for Signal<T>

fn eq(&self, other: &Signal<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> Rem<T> for Signal<T>

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

type Output = T

The resulting type after applying the % operator.

fn rem(self, rhs: T) -> <Signal<T> as Rem<T>>::Output

Performs the % operation.

impl<T> RemAssign<T> for Signal<T>

where T: RemAssign + 'static,

fn rem_assign(&mut self, rhs: T)

Performs the %= operation.

impl<T> Res<T> for Signal<T>

where T: Clone + 'static,

fn get_value(&self, _: &impl DataContext) -> T

Returns the value of a resource by value.

fn set_or_bind<F>(self, cx: &mut Context, closure: F)

where F: 'static + Fn(&mut Context, Signal<T>),

fn to_signal(self, _cx: &mut Context) -> Signal<T>

where Signal<T>: Sized + 'static, T: Clone + 'static,

Converts this signal into a signal mirror tied to entity.

impl<T> Shl<T> for Signal<T>

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

type Output = T

The resulting type after applying the << operator.

fn shl(self, rhs: T) -> <Signal<T> as Shl<T>>::Output

Performs the << operation.

impl<T> ShlAssign<T> for Signal<T>

where T: ShlAssign + 'static,

fn shl_assign(&mut self, rhs: T)

Performs the <<= operation.

impl<T> Shr<T> for Signal<T>

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

type Output = T

The resulting type after applying the >> operator.

fn shr(self, rhs: T) -> <Signal<T> as Shr<T>>::Output

Performs the >> operation.

impl<T> ShrAssign<T> for Signal<T>

where T: ShrAssign + 'static,

fn shr_assign(&mut self, rhs: T)

Performs the >>= operation.

impl<T> SignalGet<T> for Signal<T>

where T: Clone,

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 Signal<T>

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> SignalTrack<T> for Signal<T>

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 Signal<T>

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

fn set_if_changed(&self, new_value: T)

where T: PartialEq + 'static,

Sets the new_value to the Signal and triggers effect run only if the value has changed

impl<T> SignalWith<T> for Signal<T>

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 Signal<T>

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<T> for Signal<T>

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

type Output = T

The resulting type after applying the - operator.

fn sub(self, rhs: T) -> <Signal<T> as Sub<T>>::Output

Performs the - operation.

impl<T> SubAssign<T> for Signal<T>

where T: SubAssign + 'static,

fn sub_assign(&mut self, rhs: T)

Performs the -= operation.

impl<T> Copy for Signal<T>

impl<T> Eq for Signal<T>