Enum Outcome 

#[non_exhaustive]
pub enum Outcome {
    Succeeded,
    Skipped,
    Cancelled,
    Failed,
    Abandoned,
    NotRun,
}

How a phase ended. Reaching a count total is not an outcome.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Succeeded

All of the phase’s work completed.

Skipped

The planned work turned out to be unnecessary.

Cancelled

Work stopped cooperatively, after a cancellation request or timeout.

Failed

Work failed for a reason other than a stop request.

Abandoned

The phase’s owner went away without publishing an outcome.

NotRun

Prevented from running by an earlier error; earns no completed share.

Implementations

impl Outcome

pub fn from_result<T, E>( result: &Result<T, E>, is_stop: impl FnOnce(&E) -> bool, ) -> Self

The outcome of an operation’s result: Succeeded for Ok, Cancelled for an error is_stop accepts, and Failed for any other error.

use how_far::{Outcome, StopReason};

let stopped: Result<(), StopReason> = Err(StopReason::Cancelled);
assert_eq!(Outcome::from_result(&stopped, |_| true), Outcome::Cancelled);

Trait Implementations

impl Clone for Outcome

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Outcome

impl Debug for Outcome

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

Formats the value using the given formatter.

impl Eq for Outcome

impl Hash for Outcome

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Outcome

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Outcome