Skip to main content

WorkflowInstance

Struct WorkflowInstance 

Source
pub struct WorkflowInstance {
Show 13 fields pub id: String, pub name: String, pub root_workflow_id: Option<String>, pub workflow_definition_id: String, pub version: u32, pub description: Option<String>, pub reference: Option<String>, pub execution_pointers: Vec<ExecutionPointer>, pub next_execution: Option<i64>, pub status: WorkflowStatus, pub data: Value, pub create_time: DateTime<Utc>, pub complete_time: Option<DateTime<Utc>>,
}
Expand description

Workflowinstance.

Fields§

§id: String

UUID — the primary key, always unique, never changes.

§name: String

Human-friendly unique name, e.g. “ci-42”. Auto-assigned as {definition_id}-{N} via a per-definition monotonic counter when the caller does not supply an override. Used interchangeably with id in lookup APIs. Empty when the instance has not yet been persisted (the host fills it in before the first insert).

§root_workflow_id: Option<String>

UUID of the top-level ancestor workflow. None on the root (user-started) workflow; set to the parent’s root_workflow_id (or the parent’s id if the parent is itself a root) on every SubWorkflowStep-created child.

Used by the Kubernetes executor to place all workflows in a tree under a single namespace — siblings started via type: workflow steps share the parent’s namespace and any provisioned shared volume. Backends that don’t care about workflow topology can ignore this field.

§workflow_definition_id: String

Workflow definition id.

§version: u32

Version.

§description: Option<String>

Description.

§reference: Option<String>

Reference.

§execution_pointers: Vec<ExecutionPointer>

Execution pointers.

§next_execution: Option<i64>

Next execution.

§status: WorkflowStatus

Status.

§data: Value

Data.

§create_time: DateTime<Utc>

Create time.

§complete_time: Option<DateTime<Utc>>

Complete time.

Implementations§

Source§

impl WorkflowInstance

Source

pub fn new( workflow_definition_id: impl Into<String>, version: u32, data: Value, ) -> Self

Source

pub fn is_branch_complete(&self, scope: &[String]) -> bool

Check if all execution pointers in a given scope have completed.

Trait Implementations§

Source§

impl Clone for WorkflowInstance

Source§

fn clone(&self) -> WorkflowInstance

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for WorkflowInstance

Source§

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

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

impl<'de> Deserialize<'de> for WorkflowInstance

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 Serialize for WorkflowInstance

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

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

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

Source§

impl<T> WorkflowData for T
where T: Serialize + DeserializeOwned + Send + Sync + Clone + 'static,