Struct sycamore_reactive::ReactiveScope

pub struct ReactiveScope(_);

Owns the effects created in the current reactive scope. The effects are dropped and the cleanup callbacks are called when the ReactiveScope is dropped.

A new ReactiveScope is usually created with create_root. A new ReactiveScope is also created when a new effect is created with create_effect and other reactive utilities that call it under the hood.

Implementations

impl ReactiveScope

pub fn new() -> Self

Create a new empty ReactiveScope.

This should be rarely used and only serve as a placeholder. The scope created by this method is detached from the scope hierarchy, meaning that functionality such as contexts would not work through this scope.

In general, prefer create_scope instead.

pub fn extend<U>(&self, f: impl FnOnce() -> U) -> U

Runs the passed callback in the reactive scope pointed to by this handle.

pub async fn extend_future<U>(&self, f: impl Future<Output = U>) -> U

Runs the passed future in the reactive scope pointed to by this handle.

pub fn creation_loc(&self) -> Option<&'static Location<'static>>

Returns the source code Location where this ReactiveScope was created.

Trait Implementations

impl Default for ReactiveScope

fn default() -> Self

Returns the “default value” for a type.

impl Drop for ReactiveScope

fn drop(&mut self)

Executes the destructor for this type.