Enum BatchStatus 

#[non_exhaustive]
pub enum BatchStatus {
    Starting,
    Started,
    Stopping,
    Stopped,
    Failed,
    Completed,
    Abandoned,
    Unknown,
}

The framework lifecycle status of a job or step execution.

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.

Starting

Metadata exists and user work has not started.

Started

User work is running.

Stopping

A cooperative stop is in progress.

Stopped

The attempt stopped cooperatively and may be restarted.

Failed

The attempt failed and may be restartable.

Completed

The attempt completed successfully.

Abandoned

The instance is intentionally terminal and cannot restart.

Unknown

The durable outcome is ambiguous and requires recovery.

Implementations

impl BatchStatus

pub const fn is_active(self) -> bool

Returns whether the attempt is actively running or stopping.

pub const fn is_finished(self) -> bool

Returns whether the attempt has a known finished outcome.

pub const fn is_terminal(self) -> bool

Returns whether the logical instance is terminal and not restartable.

pub const fn as_str(self) -> &'static str

Returns the stable durable code for this status.

The code is the same value durable adapters store and audit records carry, so a projection never renames a status.

Trait Implementations

impl Clone for BatchStatus

fn clone(&self) -> BatchStatus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for BatchStatus

impl Debug for BatchStatus

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

Formats the value using the given formatter.

impl Display for BatchStatus

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

Formats the value using the given formatter.

impl Eq for BatchStatus

impl Hash for BatchStatus

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 Ord for BatchStatus

fn cmp(&self, other: &BatchStatus) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for BatchStatus

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for BatchStatus

fn partial_cmp(&self, other: &BatchStatus) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for BatchStatus