Struct async_ctx::Context

pub struct Context { /* fields omitted */ }

A future that can be completed externally as an asynchronous cancellation mechanism.

Resolves if any of the following occur:

• complete is called
• a derived Guard is dropped
• a parent Context completes

Clones can be expected to refer to the same logical entity.

Methods

impl Context

pub fn guard(&self) -> Guard

Create a RAII guard that will complete this context (and any derived children) when the guard is dropped.

pub fn complete(&self)

Complete this context (and any derived children).

pub fn child(&self) -> Self

Derive a child context. Completion of the parent (self) will propagate to the child, but not vice-versa.

Trait Implementations

impl Clone for Context

Important traits for Context

impl Future for Context type Output = ();

fn clone(&self) -> Context

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Context

Important traits for Context

impl Future for Context type Output = ();

fn default() -> Context

Returns the "default value" for a type.

impl Future for Context

type Output = ()

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, ctx: &mut Context) -> Poll<Self::Output>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.