Enum task_scope::Canceled

pub enum Canceled {
    Graceful,
    Forced,
}

The error type for cancellation.

Variants

Graceful

The parent task issued a graceful cancellation request. The children are in a "grace period"; The parent will wait until all children complete shutdown.

Forced

The parent task is forcibly shutting down children (mainly because the parent is dropped). The children are in a "mercy period"; They can continue execution until the next yield, and then they will be stopped automatically.

Trait Implementations

impl Debug for Canceled

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

Formats the value using the given formatter.

impl Display for Canceled

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

Formats the value using the given formatter.

impl Eq for Canceled

impl Error for Canceled

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

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

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

Returns a stack backtrace, if available, of where this error occurred.

fn description(&self) -> &str

Deprecated since 1.41.0:

use the Display impl or to_string()

if let Err(e) = "xc".parse::<u32>() { // Print e itself, no need for description(). eprintln!("Error: {}", e); }

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

Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl Hash for Canceled

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<Canceled> for Canceled

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl StructuralEq for Canceled

impl StructuralPartialEq for Canceled