Enum TaskPhase 

#[non_exhaustive]
pub enum TaskPhase {
    Pending,
    Running,
    Succeeded,
    Failed,
    Timeout,
    Canceled,
    Exhausted,
}

Current execution phase of a task.

Phases describe the state visible on TaskStatus.

Example

use solti_model::TaskPhase;

let phase: TaskPhase = "running".parse().unwrap();
assert!(phase.is_active());
assert_eq!(phase.to_string(), "running");

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.

Pending

Desired state is waiting for execution.

Running

An attempt is executing.

Succeeded

An attempt completed successfully.

Failed

Attempt failed with an error.

Timeout

An attempt exceeded its timeout.

Canceled

Execution was canceled.

Exhausted

Failure retry budget was exhausted.

Implementations

impl TaskPhase

pub fn is_terminal(&self) -> bool

Returns whether the phase is terminal.

A later attempt may still start under RestartPolicy. Resource reconciliation may also refine or replace a terminal outcome.

Example

use solti_model::TaskPhase;

assert!(TaskPhase::Succeeded.is_terminal());
assert!(!TaskPhase::Running.is_terminal());

pub fn is_active(&self) -> bool

Returns whether the phase is pending or running.

Example

use solti_model::TaskPhase;

assert!(TaskPhase::Pending.is_active());
assert!(!TaskPhase::Failed.is_active());

Trait Implementations

impl Clone for TaskPhase

fn clone(&self) -> TaskPhase

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for TaskPhase

impl Debug for TaskPhase

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TaskPhase

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TaskPhase

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

Formats the value using the given formatter.

impl Eq for TaskPhase

impl FromStr for TaskPhase

fn from_str(s: &str) -> ModelResult<Self>

Parses a phase name.

Parsing trims whitespace and ignores ASCII case.

Errors

Returns ModelError::UnknownTaskPhase for an unknown value.

type Err = ModelError

The associated error which can be returned from parsing.

impl Hash for TaskPhase

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 JsonSchema for TaskPhase

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for TaskPhase

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for TaskPhase

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TaskPhase