Struct ScopeId

pub struct ScopeId(pub usize);

A component’s unique identifier.

ScopeId is a usize that acts a key for the internal slab of Scopes. This means that the key is not unique across time. We do try and guarantee that between calls to wait_for_work, no ScopeIds will be recycled in order to give time for any logic that relies on these IDs to properly update.

Tuple Fields

0: usize

Implementations

impl ScopeId

pub fn owner<S>(self) -> Owner<S>

where S: AnyStorage,

Get the owner for the current scope.

impl ScopeId

pub fn current_scope_id(self) -> Result<ScopeId, RuntimeError>

Get the current scope id

pub fn consume_context<T>(self) -> Option<T>

where T: 'static + Clone,

Consume context from the current scope

pub fn consume_context_from_scope<T>(self, scope_id: ScopeId) -> Option<T>

where T: 'static + Clone,

Consume context from the current scope

pub fn has_context<T>(self) -> Option<T>

where T: 'static + Clone,

Check if the current scope has a context

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

where T: 'static + Clone,

Provide context to the current scope

pub fn push_future( self, fut: impl Future<Output = ()> + 'static, ) -> Option<Task>

Pushes the future onto the poll queue to be polled after the component renders.

pub fn spawn(self, fut: impl Future<Output = ()> + 'static)

Spawns the future but does not return the Task

pub fn generation(self) -> Option<usize>

Get the current render since the inception of this component

This can be used as a helpful diagnostic when debugging hooks/renders, etc

pub fn parent_scope(self) -> Option<ScopeId>

Get the parent of the current scope if it exists

pub fn is_descendant_of(self, other: ScopeId) -> bool

Check if the current scope is a descendant of the given scope

pub fn needs_update(self)

Mark the current scope as dirty, causing it to re-render

pub fn schedule_update(&self) -> Arc<dyn Fn() + Sync + Send>

Create a subscription that schedules a future render for the reference component. Unlike Self::needs_update, this function will work outside of the dioxus runtime.

Notice: you should prefer using crate::prelude::schedule_update_any

pub fn height(self) -> u32

Get the height of the current scope

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

Run a closure inside of scope’s runtime

pub fn throw_error(self, error: impl Into<CapturedError> + 'static)

Throw a CapturedError into a scope. The error will bubble up to the nearest [ErrorBoundary] or the root of the app.

Examples

fn Component() -> Element {
    let request = spawn(async move {
        match reqwest::get("https://api.example.com").await {
            Ok(_) => unimplemented!(),
            // You can explicitly throw an error into a scope with throw_error
            Err(err) => ScopeId::APP.throw_error(err)
        }
    });

    unimplemented!()
}

impl ScopeId

pub const APP: ScopeId = _

The ScopeId of the main scope passed into [VirtualDom::new].

This scope will last for the entire duration of your app, making it convenient for long-lived state that is created dynamically somewhere down the component tree.

Example

use dioxus::prelude::*;
let my_persistent_state = Signal::new_in_scope(String::new(), ScopeId::APP);

pub const ROOT: ScopeId = _

The ScopeId of the topmost scope in the tree. This will be higher up in the tree than ScopeId::APP because dioxus inserts a default [SuspenseBoundary] and [ErrorBoundary] at the root of the tree.

Trait Implementations

impl Clone for ScopeId

fn clone(&self) -> ScopeId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScopeId

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

Formats the value using the given formatter.

impl Hash for ScopeId

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ScopeId

fn cmp(&self, other: &ScopeId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ScopeId

fn eq(&self, other: &ScopeId) -> 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 PartialOrd for ScopeId

fn partial_cmp(&self, other: &ScopeId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for ScopeId

impl Eq for ScopeId

impl StructuralPartialEq for ScopeId