Struct Context

pub struct Context { /* private fields */ }

A context for cancelling futures and waiting for shutdown

A context can be created from a handler or another context so to have a hierarchy of contexts

Contexts can then be attached to futures or streams in order to automatically cancel them when the context is done, when invoking Handler::cancel. The Handler::shutdown method will block until all contexts have been dropped allowing for a graceful shutdown.

Implementations

impl Context

pub fn new() -> (Self, Handler)

Create a new context using the global handler Returns a tuple and a child handler

pub fn new_child(&self) -> (Self, Handler)

Create a new child context from this context Returns a tuple and a child handler

pub fn global() -> Self

Returns the global context

pub async fn done(&self)

Waits for the context to be done (the handler to be shutdown)

pub async fn into_done(self)

The same as done but takes ownership of the context

pub fn is_done(&self) -> bool

Returns true if the context is done

Trait Implementations

impl Clone for Context

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 Context

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

Formats the value using the given formatter.

impl<'a> From<&'a Context> for ContextRef<'a>

fn from(ctx: &'a Context) -> Self

Converts to this type from the input type.

impl From<Context> for ContextRef<'_>

fn from(ctx: Context) -> Self

Converts to this type from the input type.