Struct SuspenseContext

pub struct SuspenseContext { /* private fields */ }

A context with information about suspended components

Implementations

impl SuspenseContext

pub fn under_suspense_boundary<O>( &self, runtime: &Runtime, f: impl FnOnce() -> O, ) -> O

Run a closure under a suspense boundary

pub fn in_suspense_placeholder<O>( &self, runtime: &Runtime, f: impl FnOnce() -> O, ) -> O

Run a closure under a suspense placeholder

pub fn downcast_suspense_boundary_from_scope( runtime: &Runtime, scope_id: ScopeId, ) -> Option<SuspenseContext>

Try to get a suspense boundary from a scope id

impl SuspenseContext

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

Get the suspense boundary’s suspended nodes

pub fn frozen(&self) -> bool

Check if the suspense boundary is resolved and frozen

pub fn freeze(&self)

Resolve the suspense boundary on the server and freeze it to prevent future reruns of any child nodes of the suspense boundary

pub fn has_suspended_tasks(&self) -> bool

Check if there are any suspended tasks

pub fn is_suspended(&self) -> bool

Check if the suspense boundary is currently rendered as suspended

pub fn suspended_futures(&self) -> Ref<'_, [SuspendedFuture]>

Get all suspended tasks

pub fn suspense_placeholder(&self) -> Option<Result<VNode, RenderError>>

Get the first suspended task with a loading placeholder

Trait Implementations

impl Clone for SuspenseContext

fn clone(&self) -> SuspenseContext

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SuspenseContext

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

Formats the value using the given formatter.

impl PartialEq for SuspenseContext

fn eq(&self, other: &SuspenseContext) -> 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.