Struct BaseSignal

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

BaseSignal gives you another way to control the lifetime of a Signal apart from Scope.

When BaseSignal is dropped, it will dispose the underlying Signal as well. The signal isn’t put in any Scope when a BaseSignal is created, so that the lifetime of the signal can only be determined by BaseSignal rather than Scope dependencies

Implementations

impl<T> BaseSignal<T>

pub fn rw(&self) -> RwSignal<T>

Create a RwSignal of this Signal

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

Trait Implementations

impl<T> Drop for BaseSignal<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> PartialEq for BaseSignal<T>

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: Clone> SignalGet<T> for BaseSignal<T>

fn id(&self) -> Id

get the Signal Id

fn get_untracked(&self) -> T

where T: 'static,

Clones and returns the current value stored in the Signal, but it doesn’t subscribe to the current running effect.

fn get(&self) -> T

where T: 'static,

Clones and returns the current value stored in the Signal, and subscribes to the current running effect to this Signal.

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

where T: 'static,

Try to clone and return the current value stored in the Signal, and returns None if it’s already disposed. It subscribes to the current running effect.

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

where T: 'static,

Try to clone and return the current value stored in the Signal, and returns None if it’s already disposed. It doesn’t subscribe to the current running effect.

impl<T> SignalUpdate<T> for BaseSignal<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

impl<T> SignalWith<T> for BaseSignal<T>

fn id(&self) -> Id

get the Signal Id

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

where T: 'static,

Applies a closure to the current value stored in the Signal, and subscribes to the current running effect to this Memo.

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

where T: 'static,

Applies a closure to the current value stored in the Signal, but it doesn’t subscribe to the current running effect.

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

where T: 'static,

If the signal isn’t disposed, applies a closure to the current value stored in the Signal. It subscribes to the current running effect.

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

where T: 'static,

If the signal isn’t disposed, applies a closure to the current value stored in the Signal, but it doesn’t subscribe to the current running effect.

impl<T> Eq for BaseSignal<T>