Struct leptos::SuspenseContext

pub struct SuspenseContext {
    pub pending_resources: ReadSignal<usize>,
    /* private fields */
}

Tracks Resources that are read under a suspense context, i.e., within a Suspense component.

Fields

pending_resources: ReadSignal<usize>

The number of resources that are currently pending.

Implementations

impl SuspenseContext

pub fn has_local_only(&self) -> bool

Whether the suspense contains local resources at this moment, and therefore can’t be serialized

pub fn has_any_local(&self) -> bool

Whether the suspense contains any local resources at this moment.

pub fn should_block(&self) -> bool

Whether any blocking resources are read under this suspense context, meaning the HTML stream should not begin until it has resolved.

pub fn to_future(&self) -> impl Future<Output = ()>

Returns a Future that resolves when this suspense is resolved.

pub fn none_pending(&self) -> bool

Reactively checks whether there are no pending resources in the suspense.

impl SuspenseContext

pub fn new() -> SuspenseContext

Creates an empty suspense context.

pub fn increment(&self, serializable: bool)

Notifies the suspense context that a new resource is now pending.

pub fn decrement(&self, serializable: bool)

Notifies the suspense context that a resource has resolved.

pub fn decrement_for_resource(&self, serializable: bool, resource: ResourceId)

Notifies the suspense context that a resource has resolved.

pub fn clear(&self)

Resets the counter of pending resources.

pub fn ready(&self) -> Memo<bool>

Tests whether all of the pending resources have resolved.

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 Default for SuspenseContext

fn default() -> SuspenseContext

Returns the “default value” for a type.

impl Hash for SuspenseContext

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 PartialEq for SuspenseContext

fn eq(&self, other: &SuspenseContext) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for SuspenseContext

impl Eq for SuspenseContext