Struct Cancelled 

pub struct Cancelled { /* private fields */ }

Cancellation error type. Should include the cause of cancellation (name of the crate::CancellationTrigger type that caused the error).

In cases where the operation itself can result in an error E, make sure to implement From<Cancelled> for E, meaning you’ll still be able to use the is_cancelled macro and other features of this crate.

Implementations

impl Cancelled

pub fn new(cause: &'static str) -> Self

Create a new Cancelled with a cause type.

impl Cancelled

pub fn cause(&self) -> &'static str

The name of the crate::CancellationTrigger that caused the error. If the cause is unknown, use crate::UNKNOWN_CAUSE.

Trait Implementations

impl Clone for Cancelled

fn clone(&self) -> Cancelled

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Cancelled

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

Formats the value using the given formatter.

impl Default for Cancelled

fn default() -> Self

Returns the “default value” for a type.

impl Display for Cancelled

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

Formats the value using the given formatter.

impl Error for Cancelled

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 Hash for Cancelled

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Cancelled

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

impl Eq for Cancelled

impl StructuralPartialEq for Cancelled