Struct sycamore_reactive::StateHandle

pub struct StateHandle<T: 'static>(_);

A readonly Signal.

Returned by functions that provide a handle to access state. Use Signal::handle or Signal::into_handle to retrieve a handle from a Signal.

Implementations

impl<T: 'static> StateHandle<T>

pub fn get(&self) -> Rc<T>

Get the current value of the state. When called inside a reactive scope, calling this will add itself to the scope’s dependencies.

Example

use sycamore_reactive::*;

let state = Signal::new(0);
assert_eq!(*state.get(), 0);

state.set(1);
assert_eq!(*state.get(), 1);

pub fn get_untracked(&self) -> Rc<T>

Get the current value of the state, without tracking this as a dependency if inside a reactive context.

Example

use sycamore_reactive::*;

let state = Signal::new(1);

let double = create_memo({
    let state = state.clone();
    move || *state.get_untracked() * 2
});

assert_eq!(*double.get(), 2);

state.set(2);
// double value should still be old value because state was untracked
assert_eq!(*double.get(), 2);

Trait Implementations

impl<T: 'static> Clone for StateHandle<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for StateHandle<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for StateHandle<T>

fn default() -> Self

Returns the “default value” for a type.