sycamore::futures

Struct SuspenseScope

pub struct SuspenseScope {
    pub parent: Option<Signal<SuspenseScope>>,
    pub sent: Signal<bool>,
    /* private fields */
}
Expand description

Represents a new suspense scope. This is created by a call to create_suspense_scope.

Fields§

§parent: Option<Signal<SuspenseScope>>

The parent suspense scope of the current scope, if it exists.

§sent: Signal<bool>

Signal that is set to true when the view is rendered and streamed into the buffer. This is unused on the client side.

Implementations§

§

impl SuspenseScope

pub fn new(parent: Option<SuspenseScope>) -> SuspenseScope

Create a new suspense scope, optionally with a parent scope.

The parent scope should always be located in a reactive scope that is an ancestor of this scope.

pub fn is_loading(self) -> ReadSignal<bool>

Returns a signal representing whether we are currently loading this suspense or not.

Implementation for the use_is_loading hook.

pub async fn until_finished(self)

Returns a future that resolves once the scope is no longer loading.

Trait Implementations§

§

impl Clone for SuspenseScope

§

fn clone(&self) -> SuspenseScope

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
§

impl Debug for SuspenseScope

§

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

Formats the value using the given formatter. Read more
§

impl Copy for SuspenseScope

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.