Struct SyncSignal 

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

A thread-safe read-write signal.

Implementations

impl<T> SyncSignal<T>

pub fn id(&self) -> Id

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

Create a Getter of this Signal

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

Create a Setter of this Signal

impl<T> SyncSignal<T>

where T: Send + Sync + 'static,

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

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_split(value: T) -> (SyncReadSignal<T>, SyncWriteSignal<T>)

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

Trait Implementations

impl<T> Clone for SyncSignal<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for SyncSignal<T>

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

Formats the value using the given formatter.

impl<T> Default for SyncSignal<T>

where T: Default + Send + Sync + 'static,

fn default() -> SyncSignal<T>

Returns the “default value” for a type.

impl<T> From<T> for SyncSignal<T>

where T: Send + Sync + 'static,

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

Converts to this type from the input type.

impl<T> PartialEq for SyncSignal<T>

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

where T: Clone + Send + Sync + '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, SyncSignal<T>),

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

where Self: Sized + 'static, T: Clone + 'static,

Converts this signal into a signal mirror tied to entity.

impl<T> SignalGet<T> for SyncSignal<T>

where T: Clone + Send + Sync,

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

where T: Send + Sync,

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

where T: Send + Sync,

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

where T: Send + Sync,

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

where T: Send + Sync,

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> Copy for SyncSignal<T>

impl<T> Eq for SyncSignal<T>