Enum Cause 

#[non_exhaustive]
pub enum Cause {
    Signal,
    Deadline,
    GraceElapsed,
    Owner,
    Reason(&'static str),
    Error(Arc<dyn Error + Sync + Send>),
}

Available on crate feature std only.

Why a Scope entered its graceful or hard phase.

A scope cancelled through its parent reports the parent’s cause.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Signal

A signal future attached to the scope completed.

Deadline

A deadline or timeout attached to the scope was reached.

GraceElapsed

The grace period after the graceful phase elapsed.

Owner

Cancelled by the code that owns the scope.

Reason(&'static str)

Cancelled by code, with a static reason.

Error(Arc<dyn Error + Sync + Send>)

Cancelled by code because of an error.

Implementations

impl Cause

pub fn error(error: impl Into<Box<dyn Error + Sync + Send>>) -> Cause

Create a Cause::Error from any error.

Trait Implementations

impl Clone for Cause

fn clone(&self) -> Cause

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Cause

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

Formats the value using the given formatter.

impl Display for Cause

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

Formats the value using the given formatter.