Enum ExecutionState 

pub enum ExecutionState {
    Queued,
    Running,
    Cancelling,
    Succeeded,
    Failed,
    Cancelled,
}

Where an execution is in its life.

The transitions are the whole contract, and ExecutionState::may_move_to is the one place they are written down: the engine asks before every change, the store refuses a move it did not allow, and a client that reads a final state never sees it move again.

  queued ──► running ──┬──► succeeded
     │                 ├──► failed
     │                 └──► cancelling ──┬──► cancelled
     │                                   ├──► succeeded
     └──► cancelled                      └──► failed

There is no starting. An in-process engine claims an execution and enters its handler in the same instant, so a state between the two would be one no client could ever observe and every client would have to handle.

Variants

Queued

Accepted, and no worker has picked it up.

Running

The handler is running.

Cancelling

Cancellation was asked for and the handler has not stopped yet.

Succeeded

The handler returned an output.

Failed

The handler returned an error, or the worker could not run it.

Cancelled

It stopped because it was asked to.

Implementations

impl ExecutionState

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

The word as serialised.

pub fn is_final(self) -> bool

Is this the last thing that will be said about the execution?

use majordomus_cli::execution::ExecutionState;
assert!(ExecutionState::Succeeded.is_final());
assert!(!ExecutionState::Cancelling.is_final());

pub fn is_active(self) -> bool

Is the execution doing work, or about to?

pub fn may_move_to(self, next: ExecutionState) -> bool

May the execution move from here to next?

use majordomus_cli::execution::ExecutionState::*;
assert!(Queued.may_move_to(Running));
assert!(Running.may_move_to(Cancelling));
assert!(Queued.may_move_to(Cancelled), "a queued execution is cancelled without running");
assert!(!Succeeded.may_move_to(Running), "a final state is final");
assert!(!Running.may_move_to(Queued), "nothing goes back");

Trait Implementations

impl Clone for ExecutionState

fn clone(&self) -> ExecutionState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ExecutionState

impl Debug for ExecutionState

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ExecutionState

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ExecutionState

impl Hash for ExecutionState

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 ExecutionState

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

fn cmp(&self, other: &ExecutionState) -> 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 ExecutionState

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

fn partial_cmp(&self, other: &ExecutionState) -> 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 Serialize for ExecutionState

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 ExecutionState