Enum StopReason 

#[non_exhaustive]
pub enum StopReason {
    Cancelled,
    TimedOut,
}

Why an operation was stopped.

This is returned from Stop::check() when the operation should stop.

Error Integration

Implement From<StopReason> for your error type to use ? naturally:

use enough::StopReason;

#[derive(Debug)]
enum MyError {
    Stopped(StopReason),
    Io(std::io::Error),
}

impl From<StopReason> for MyError {
    fn from(r: StopReason) -> Self { MyError::Stopped(r) }
}

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.

Cancelled

Operation was explicitly cancelled.

This typically means someone called cancel() on a cancellation source, or a parent operation was cancelled.

TimedOut

Operation exceeded its deadline.

This means a timeout was set and the deadline passed before the operation completed.

Implementations

impl StopReason

pub fn is_transient(&self) -> bool

Returns true if this is a transient condition that might succeed on retry.

Currently only TimedOut is considered transient, as the operation might succeed with a longer timeout or under less load.

Cancelled is not transient - it represents an explicit decision to stop.

pub fn is_cancelled(&self) -> bool

Returns true if this was an explicit cancellation.

pub fn is_timed_out(&self) -> bool

Returns true if this was a timeout.

Trait Implementations

impl Clone for StopReason

fn clone(&self) -> StopReason

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StopReason

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

Formats the value using the given formatter.

impl Display for StopReason

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

Formats the value using the given formatter.

impl Hash for StopReason

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

where __H: Hasher,

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 StopReason

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

impl Eq for StopReason

impl StructuralPartialEq for StopReason