Struct Scope 

pub struct Scope(/* private fields */);

You can manually control Signal’s lifetime by using Scope.

Every Signal has a Scope created explicitly or implicitly, and when you Dispose the Scope, it will clean up all the Signals that belong to the Scope and all the child Scopes

Implementations

impl Scope

pub fn new() -> Self

Create a new Scope that isn’t a child or parent of any scope

pub fn current() -> Scope

The current Scope in the Runtime. Any Signal/Effect/Memo created with implicitly Scope will be under this Scope

pub fn create_child(&self) -> Scope

Create a child Scope of this Scope

pub fn create_signal<T>(self, value: T) -> (ReadSignal<T>, WriteSignal<T>)

where T: Any + 'static,

Create a new Signal under this Scope

pub fn create_rw_signal<T>(self, value: T) -> RwSignal<T>

where T: Any + 'static,

Create a RwSignal under this Scope (local/unsync by default)

pub fn create_sync_signal<T>( self, value: T, ) -> (ReadSignal<T, SyncStorage>, WriteSignal<T, SyncStorage>)

where T: Any + Send + Sync + 'static,

Create a sync Signal under this Scope

pub fn create_sync_rw_signal<T>(self, value: T) -> RwSignal<T, SyncStorage>

where T: Any + Send + Sync + 'static,

Create a sync RwSignal under this Scope

pub fn create_local_signal<T>( self, value: T, ) -> (ReadSignal<T, UnsyncStorage>, WriteSignal<T, UnsyncStorage>)

where T: Any + 'static,

Create a local (unsync) Signal under this Scope

pub fn create_local_rw_signal<T>(self, value: T) -> RwSignal<T, UnsyncStorage>

where T: Any + 'static,

Create a local (unsync) RwSignal under this Scope

pub fn create_memo<T>(self, f: impl Fn(Option<&T>) -> T + 'static) -> Memo<T>

where T: PartialEq + 'static,

Create a Memo under this Scope

pub fn create_trigger(self) -> Trigger

Create a Trigger under this Scope

pub fn create_effect<T>(self, f: impl Fn(Option<T>) -> T + 'static)

where T: Any + 'static,

Create effect under this Scope

pub fn create_updater<R>( self, compute: impl Fn() -> R + 'static, on_change: impl Fn(R) + 'static, ) -> R

where R: 'static,

Create updater under this Scope

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

where T: 'static,

Runs the given closure within this scope.

pub fn enter_child<T, U>( &self, f: impl Fn(T) -> U + 'static, ) -> impl Fn(T) -> (U, Scope)

where T: 'static,

Wraps a closure so it runs under a new child scope of this scope.

pub fn track(&self)

This is normally used in create_effect, and it will bind the effect’s lifetime to this scope

pub fn dispose(&self)

Dispose this Scope, and it will cleanup all the Signals and child Scope of this Scope.

Trait Implementations

impl Clone for Scope

fn clone(&self) -> Scope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Scope

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

Formats the value using the given formatter.

impl Default for Scope

fn default() -> Self

Returns the “default value” for a type.

impl Copy for Scope