Struct Signal 

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

Implementations

impl<T> Signal<T>

where T: 'static,

pub fn new(initial: T) -> Self

Creates a new signal with the given initial value.

A signal is a reactive value that can be read and updated. When a signal is updated, all function components that read the signal will be re-run to reflect the new value.

The signal is removed when the component which created it goes out of scope.

Example

use rustolio_web::prelude::*;

let s = Signal::new("Hello World".to_string());
div! {
    class: "container",
    move || s.value(),
};

Caveats

All caveats will throw an runtime error in debug mode.

Immutable Signals

When creating a signal, it is important to ensure that the signal is read in a function component (e.g., move || s.value()). If this is not done, the signal itself will be recreated on every update, making it effectively immutable.

Dont do this:

use rustolio_web::prelude::*;

let s = Signal::new("Hello World".to_string());
div! {
   s.value()
};

Do this instead:

use rustolio_web::prelude::*;

let s = Signal::new("Hello World".to_string());
div! {
   move || s.value()
};
// OR
move || div! {
   s.value()
};

Breaking Signals

When reading a signal value, it is important to ensure that the next component is not a function component. This would break the signal’s updater, as it would replace the component without notifying the signal’s updater.

Dont do this:

use rustolio_web::prelude::*;

let s = Signal::new("Hello World".to_string());
let s1 = Signal::new("Hello World 2".to_string());
div! {
   move || {
      let value = s.value();
      move || div! {
         format!("S: {} - S1: {}", value, s1.value())
      }
   }
};

Do this instead:

use rustolio_web::prelude::*;

let s = Signal::new("Hello World".to_string());
let s1 = Signal::new("Hello World 2".to_string());
div! {
   move || {
      let value = s.value();
      div! {
         move || div! {
            format!("S: {} - S1: {}", value, s1.value())
         }
      }
   }
};

pub fn always_mutable(initial: T) -> Self

Creates the Signal (same as Self::new) but the check for immutablility will alway succeed.

This can be useful for Signal-Wrapper which are allowed the be read in the same scope.

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

where T: Default + 'static,

fn default() -> Self

Returns the “default value” for a type.

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

where T: Clone + 'static,

fn from(val: GlobalSignal<T>) -> Self

Converts to this type from the input type.

impl<S, T> From<GlobalWrapper<S>> for Signal<T>

where S: Copy + SignalGetter<T>, T: Clone + 'static,

fn from(val: GlobalWrapper<S>) -> Self

Converts to this type from the input type.

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

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

Returns the underlying signal of the concrete implementation.

impl<T> SignalGetter<T> for Signal<T>

where T: Clone + 'static,

fn peek(&self) -> T

Returns the current value of the signal without tracking updates.

fn value(&self) -> T

Return the value of the signal and appends it to the current scope’s dependencies. If the values changes, the scope gets reexecuted to update to the new value.

impl<T> SignalSetter<T> for Signal<T>

where T: PartialEq + 'static,

fn set(&self, value: impl Into<T>) -> T

Sets the value of the signal and notifies all dependencies.

impl<T> SignalUpdater<T> for Signal<T>

where T: 'static,

fn update<U>(&self, updater: impl FnOnce(&mut T) -> U) -> U

Updates the signal value without cloning it using the provided updater function and notifies all dependencies. This will happen, no matter if the value acually changed or not.

fn set_unchecked(&self, value: impl Into<T>)

Sets the value of the signal and notifies all its dependencies.

impl<T> Copy for Signal<T>

impl<T: Eq> Eq for Signal<T>

impl<T> StructuralPartialEq for Signal<T>