Struct CancelContext

pub struct CancelContext { /* private fields */ }

A cancellation context.

This is used to get a notification when an operation has been cancelled. It can be cloned or sent across process boundaries.

Implementations

impl CancelContext

pub fn new() -> Self

Returns a new context that is never notified of cancellation.

pub fn with_cancel(&self) -> (Self, Cancel)

Returns a new child context and a cancel function.

The new context is notified when either this context is cancelled, or the returned Cancel object’s cancel method is called.

pub fn with_deadline(&self, deadline: Deadline) -> Self

Returns a new child context with a deadline.

The new context is notified when either this context is cancelled, or the deadline is exceeded.

pub fn with_timeout(&self, timeout: Duration) -> Self

Returns a new child context with a timeout.

The new context is notified when either this context is cancelled, or the timeout has expired.

pub fn deadline(&self) -> Option<Deadline>

Returns the current deadline, if there is one.

pub fn cancelled(&mut self) -> Cancelled<'_>

Returns a future that completes when the context is cancelled.

pub async fn until_cancelled<F: Future>( &mut self, fut: F, ) -> Result<F::Output, CancelReason>

Runs fut until this context is cancelled.

pub async fn until_cancelled_failable<F: Future<Output = Result<T, E>>, T, E>( &mut self, fut: F, ) -> Result<T, ErrorOrCancelled<E>>

Runs a failable future until this context is cancelled, merging the result with the cancellation reason.

pub fn is_cancelled(&mut self) -> bool

Returns true if the context has been cancelled.

Trait Implementations

impl Clone for CancelContext

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CancelContext

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

Formats the value using the given formatter.

impl Default for CancelContext

fn default() -> Self

Returns the “default value” for a type.

impl DefaultEncoding for CancelContext

type Encoding = TableEncoder

The encoding to use for the serialization.

impl Drop for CancelContext

fn drop(&mut self)

Executes the destructor for this type.

impl<'encoding> StructDecodeMetadata<'encoding, Resource> for CancelContext

const DECODERS: &'static [ErasedDecoderEntry]

The list of decoder vtables.

impl StructEncodeMetadata<Resource> for CancelContext

const ENCODERS: &'static [ErasedEncoderEntry]

The list of encoder vtables.

impl StructMetadata for CancelContext

const NUMBERS: &'static [u32]

The field numbers for each field.

const OFFSETS: &'static [usize]

The byte offset to each field within the struct.