Skip to main content

Signal

Struct Signal 

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

A value you set. A memo or effect that reads it reruns after it changes.

Create one with Owner::signal. The handle is a small Copy key, so closures capture it by value. The value itself lives in this thread’s runtime until the signal’s owner is disposed.

Implementations§

Source§

impl<T: 'static> Signal<T>

Source

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

A read-only view of this signal, for code that should only read it.

Source

pub fn get(&self) -> T
where T: Clone,

Returns a clone of the value. Inside a memo or effect, this makes it depend on the signal.

§Panics

If the signal’s owner was disposed. try_get returns None instead.

Source

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

Calls f with a reference to the value, without cloning it. Inside a memo or effect, this makes it depend on the signal.

§Panics

If the signal’s owner was disposed, or if f writes this signal.

Source

pub fn get_untracked(&self) -> T
where T: Clone,

Like get, but records no dependency.

Source

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

Like with, but records no dependency.

Source

pub fn try_get(&self) -> Option<T>
where T: Clone,

Like get, but returns None if the owner was disposed.

Source

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

Like with, but returns None if the owner was disposed.

Source

pub fn set(&self, value: T)

Stores a new value, marks every memo and effect that read this signal as stale, and queues the effects. Nothing runs until the next Runtime::flush. Dependents are notified even when the new value equals the old one.

§Panics

If the signal’s owner was disposed, if this runs inside a memo (use an effect to write signals), or if it runs inside a with call on the same signal.

Source

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

Changes the value in place, then notifies like set.

§Panics

Like set, and also if f reads this signal.

Source

pub fn try_set(&self, value: T) -> bool

Like set, but if the owner was disposed it does nothing and returns false.

Source

pub fn try_update(&self, f: impl FnOnce(&mut T)) -> bool

Like update, but if the owner was disposed it does nothing and returns false.

Source

pub fn named(self, name: impl Into<String>) -> Self

Gives the signal a debug name, such as a widget path.

Trait Implementations§

Source§

impl<T> Clone for Signal<T>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T> Copy for Signal<T>

Source§

impl<T> Debug for Signal<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T> Eq for Signal<T>

Source§

impl<T> Hash for Signal<T>

Source§

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<T> PartialEq for Signal<T>

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

Auto Trait Implementations§

§

impl<T> !Send for Signal<T>

§

impl<T> !Sync for Signal<T>

§

impl<T> Forget for Signal<T>

§

impl<T> Freeze for Signal<T>
where PhantomData<(fn(T) -> T, *const ())>: Freeze,

§

impl<T> Move for Signal<T>

§

impl<T> RefUnwindSafe for Signal<T>

§

impl<T> Unpin for Signal<T>
where PhantomData<(fn(T) -> T, *const ())>: Unpin,

§

impl<T> UnsafeUnpin for Signal<T>
where PhantomData<(fn(T) -> T, *const ())>: UnsafeUnpin,

§

impl<T> UnwindSafe for Signal<T>
where PhantomData<(fn(T) -> T, *const ())>: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more