FlowState

Enum FlowState 

Source
pub enum FlowState {
    Created,
    Validated,
    Instantiated,
    Running,
    Draining,
    Completed,
    Cancelled,
    Failed,
}
Expand description

Flow lifecycle state machine.

Per Doc 04, Section 10.1: 8 states with defined legal transitions. This is the label-only version in torvyn-types. The reactor crate provides an extended version with associated data (stats, error info).

State transition diagram:

  Created -> Validated -> Instantiated -> Running -> Draining -> Completed
  Created -> Failed                                            -> Cancelled
  Validated -> Failed                                          -> Failed
  Running -> Draining -> Failed

§Examples

use torvyn_types::FlowState;

let state = FlowState::Created;
assert!(state.can_transition_to(&FlowState::Validated));
assert!(!state.can_transition_to(&FlowState::Running));

let new_state = state.transition_to(FlowState::Validated).unwrap();
assert_eq!(new_state, FlowState::Validated);

Variants§

§

Created

Flow definition has been submitted but not yet validated.

§

Validated

Contracts and capabilities have been validated.

§

Instantiated

Components have been instantiated and streams are connected.

§

Running

The flow is actively processing stream elements.

§

Draining

The flow is draining remaining elements after a completion or cancellation signal.

§

Completed

The flow completed successfully.

§

Cancelled

The flow was cancelled by operator or policy.

§

Failed

The flow failed due to an unrecoverable error.

Implementations§

Source§

impl FlowState

Source

pub fn can_transition_to(&self, target: &FlowState) -> bool

Returns true if transitioning from self to target is legal.

Legal transitions (per Doc 04, Section 10.2):

  • Created -> Validated | Failed
  • Validated -> Instantiated | Failed
  • Instantiated -> Running
  • Running -> Draining
  • Draining -> Completed | Cancelled | Failed
§WARM PATH — called per flow state change.
Source

pub fn transition_to( self, target: FlowState, ) -> Result<FlowState, InvalidTransition>

Attempt to transition from self to target.

Returns Ok(target) if the transition is legal, or Err(InvalidTransition) if it is not.

§WARM PATH — called per flow state change.
Source

pub const fn is_terminal(&self) -> bool

Returns true if this state is terminal (no further transitions possible).

§WARM PATH — checked for flow cleanup.
Source

pub const fn is_active(&self) -> bool

Returns true if this state is active (Created through Running).

Trait Implementations§

Source§

impl Clone for FlowState

Source§

fn clone(&self) -> FlowState

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FlowState

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for FlowState

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for FlowState

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Hash for FlowState

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for FlowState

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for FlowState

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Copy for FlowState

Source§

impl Eq for FlowState

Source§

impl StructuralPartialEq for FlowState

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,