Struct Signal 

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

Reactive state shared by browser expressions.

Create a signal with signal during rendering. Runtime expressions can read and write it. When its value changes, browser expressions that read it run again. Cloning a signal is cheap and refers to the same state.

On the server, get and read track the signal as a dependency. A change re-renders the enclosing shard, or the page if there is no shard. Use get_untracked or read_untracked to read without this dependency. Validate values read on the server because the client can supply them.

Implementations

impl<T> Signal<T>

pub fn read(&self) -> &T

Borrows the current value, tracking the signal as a dependency of the body reading it.

A change re-renders the enclosing shard, or the page if there is no shard. Repeated reads create only one dependency.

Panics

Panics outside an active rendering scope or runtime expression.

pub fn read_untracked(&self) -> &T

Borrows the current value without tracking the signal.

Outside runtime expressions, this creates no dependency and needs no rendering scope.

impl<T> Signal<T>

where T: Clone,

pub fn get(&self) -> T

Clones the current value, tracking the signal as a dependency of the body reading it.

Uses the same tracking rules as read.

Panics

Panics outside an active rendering scope or runtime expression.

pub fn get_untracked(&self) -> T

Clones the current value without tracking the signal.

Uses the same tracking rules as read_untracked.

Trait Implementations

impl<T> Clone for Signal<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Signal<T>

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

Formats the value using the given formatter.

impl<T> Surrogated for Signal<T>

type Surrogate = SignalSurrogate<T>

fn into_surrogate(self) -> Self::Surrogate

impl<'__lifetime, T> Surrogated for &'__lifetime Signal<T>

type Surrogate = &'__lifetime SignalSurrogate<T>

fn into_surrogate(self) -> Self::Surrogate

impl<'__lifetime, T> Surrogated for &'__lifetime mut Signal<T>

type Surrogate = &'__lifetime mut SignalSurrogate<T>

fn into_surrogate(self) -> Self::Surrogate