Skip to main content

FlowStatus

Enum FlowStatus 

Source
#[non_exhaustive]
pub enum FlowStatus { Active, Completed, Failed, Cancelled, Unknown, }
Expand description

Typed flow-lifecycle status surfaced on FlowSummary.

Mirrors the free-form public_flow_state literal that FF’s flow lifecycle writes onto flow_core (known values: open, running, blocked, cancelled, completed, failed — see FlowSnapshot). The three “active” runtime states (open, running, blocked) collapse to FlowStatus::Active here — callers that need the exact runtime sub-state should use FlowSnapshot::public_flow_state via crate::engine_backend::EngineBackend::describe_flow. failed maps to FlowStatus::Failed.

#[non_exhaustive] so future lifecycle states (if FF introduces any) can be added without a semver break.

Variants (Non-exhaustive)§

This enum is marked as 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.
§

Active

open / running / blocked — flow is still live on the engine.

§

Completed

Terminal success: all members reached a successful terminal state and the flow projector flipped public_flow_state to completed.

§

Failed

Terminal failure: one or more members failed and the flow projector flipped public_flow_state to failed.

§

Cancelled

Cancelled by an operator via cancel_flow.

§

Unknown

The stored public_flow_state literal is present but not a known value. The raw literal is preserved on FlowSnapshot::public_flow_state — callers that need to act on it should fall back to crate::engine_backend::EngineBackend::describe_flow.

Implementations§

Source§

impl FlowStatus

Source

pub fn from_public_flow_state(raw: &str) -> Self

Map the raw public_flow_state literal stored on flow_core to a typed FlowStatus. Unknown literals surface as FlowStatus::Unknown so the list surface stays forwards- compatible with future engine-side state additions.

Trait Implementations§

Source§

impl Clone for FlowStatus

Source§

fn clone(&self) -> FlowStatus

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 FlowStatus

Source§

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

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

impl Hash for FlowStatus

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 FlowStatus

Source§

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

Source§

impl Eq for FlowStatus

Source§

impl StructuralPartialEq for FlowStatus

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, 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.