Struct Suspension

pub struct Suspension { /* private fields */ }

A Suspension.

This type can be sent back as an Err(_) to suspend a component until the underlying task completes.

Implementations

impl Suspension

pub fn new() -> (Self, SuspensionHandle)

Creates a Suspension.

pub fn resumed(&self) -> bool

Returns true if the current suspension is already resumed.

pub fn from_future(f: impl Future<Output = ()> + 'static) -> Self

Creates a Suspension that resumes when the Future resolves.

Trait Implementations

impl Clone for Suspension

fn clone(&self) -> Suspension

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Suspension

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

Formats the value using the given formatter.

impl Display for Suspension

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

Formats the value using the given formatter.

impl Error for Suspension

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.

impl From<Suspension> for RenderError

fn from(source: Suspension) -> Self

Converts to this type from the input type.

impl Future for Suspension

type Output = ()

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.

impl PartialEq for Suspension

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