Struct ScopeId 

pub struct ScopeId(pub usize);

Available on crate feature prelude only.

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 const APP: ScopeId

The ScopeId of the main scope passed into crate::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_ERROR_BOUNDARY: ScopeId

The ScopeId of the topmost error boundary in the tree.

pub const ROOT_SUSPENSE_BOUNDARY: ScopeId

The ScopeId of the topmost suspense boundary in the tree.

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 crate::SuspenseBoundary and crate::ErrorBoundary at the root of the tree.

Trait Implementations

impl Clone for ScopeId

fn clone(&self) -> ScopeId

Returns a duplicate 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<'de> Deserialize<'de> for ScopeId

fn deserialize<__D>( __deserializer: __D, ) -> Result<ScopeId, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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 Serialize for ScopeId

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for ScopeId

impl Eq for ScopeId

impl StructuralPartialEq for ScopeId