Struct ScopeState 

pub struct ScopeState { /* private fields */ }

A component’s rendered state.

This state erases the type of the component’s props. It is used to store the state of a component in the runtime.

Implementations

impl ScopeState

pub fn root_node(&self) -> &VNode

Get a handle to the currently active head node arena for this Scope

This is useful for traversing the tree outside of the VirtualDom, such as in a custom renderer or in SSR.

Panics if the tree has not been built yet.

pub fn try_root_node(&self) -> Option<&VNode>

Try to get a handle to the currently active head node arena for this Scope

This is useful for traversing the tree outside of the VirtualDom, such as in a custom renderer or in SSR.

Returns None if the tree has not been built yet.

pub fn try_mounted_root_node(&self) -> Option<MountedVNode<'_>>

Try to get the currently active root node with its mounted identity.

Returns None if the tree has not been built or mounted yet.

pub fn id(&self) -> ScopeId

Returns the scope id of this ScopeState.

pub fn height(&self) -> u32

Returns the height of this scope in the tree.

Trait Implementations

impl Drop for ScopeState

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.