Struct ContextCanceled

pub struct ContextCanceled(());

Contexts will trap with this error as a RuntimeError::user when they are canceled

If encountered in a host function it MUST be propagated to the context’s entrypoint. To make it harder to run into that behaviour by ignoring this error, dropping it will cause a panic with a message that it was not propagated properly. If you think you know what you are doing, you can call defuse (or just forget it) to avoid the panic.

When it bubbles up to the start of the entrypoint function of a context, it will be handled by just letting the context exit silently.

Tuple Fields

0: ()

Implementations

impl ContextCanceled

pub fn defuse(self)

Defuse the ContextCanceled so it does not panic when dropped

Trait Implementations

impl Debug for ContextCanceled

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

Formats the value using the given formatter.

impl Display for ContextCanceled

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

Formats the value using the given formatter.

impl Drop for ContextCanceled

fn drop(&mut self)

Executes the destructor for this type.

impl Error for ContextCanceled

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.