Enum GracefulOutcome 

pub enum GracefulOutcome<T> {
    Completed(T),
    ShutdownSignaled,
}

Outcome of a task run with graceful shutdown support.

Variants

Completed(T)

The task completed normally before shutdown.

ShutdownSignaled

Shutdown was signaled; the task was interrupted.

Implementations

impl<T> GracefulOutcome<T>

pub fn is_completed(&self) -> bool

Returns true if the task completed normally.

pub fn is_shutdown(&self) -> bool

Returns true if shutdown was signaled.

pub fn into_completed(self) -> Option<T>

Returns the completed value, or None if shutdown was signaled.

pub fn map<U, F>(self, f: F) -> GracefulOutcome<U>

where F: FnOnce(T) -> U,

Maps the completed value using the provided function.

Trait Implementations

impl<T> Clone for GracefulOutcome<T>

where T: Clone,

fn clone(&self) -> GracefulOutcome<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for GracefulOutcome<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> PartialEq for GracefulOutcome<T>

where T: PartialEq,

fn eq(&self, other: &GracefulOutcome<T>) -> 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<T> Copy for GracefulOutcome<T>

where T: Copy,

impl<T> Eq for GracefulOutcome<T>

where T: Eq,

impl<T> StructuralPartialEq for GracefulOutcome<T>