Struct WorkflowSpec 

#[non_exhaustive]
pub struct WorkflowSpec {
    pub name: String,
    pub version: String,
    pub runtime: RuntimeSpec,
    pub runtime_build_id: Option<RuntimeBuildId>,
    pub patch_markers: BTreeSet<WorkflowPatchId>,
    pub signal_names: BTreeSet<String>,
}

Durable workflow definition.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

Stable workflow type name used for registration and inspection.

version: String

Application-defined workflow definition version.

runtime: RuntimeSpec

Runtime entrypoint used to replay the workflow.

runtime_build_id: Option<RuntimeBuildId>

Exact deployed runtime build required to replay this run.

patch_markers: BTreeSet<WorkflowPatchId>

Replay-safe code changes enabled for this run at creation time.

signal_names: BTreeSet<String>

Named asynchronous message contracts accepted by this workflow.

Implementations

impl WorkflowSpec

pub fn native_ts( name: impl Into<String>, version: impl Into<String>, entrypoint: impl Into<String>, export_name: impl Into<String>, ) -> Self

Creates a workflow definition backed by native TypeScript.

pub fn rust_embedded( name: impl Into<String>, version: impl Into<String>, entrypoint: impl Into<String>, export_name: impl Into<String>, ) -> Self

Creates a workflow definition backed by an embedded Rust runtime.

pub fn with_runtime_build(self, runtime_build_id: RuntimeBuildId) -> Self

Pin new runs to the exact runtime build that can replay them.

pub fn with_patch_marker(self, patch_id: WorkflowPatchId) -> Self

Enable a replay-safe code path for every run created from this spec.

The complete marker set is persisted atomically inside run_created. Reusing an existing run ID with a different set is rejected as a start conflict instead of changing the behavior of an in-flight history.

pub fn has_patch_marker(&self, patch_id: &str) -> bool

Return whether this immutable run definition contains patch_id.

pub fn with_signal(self, signal_name: impl Into<String>) -> Self

Declare one named asynchronous signal contract for this workflow.

pub fn accepts_signal(&self, signal_name: &str) -> bool

Return whether this immutable workflow definition accepts signal_name.

pub fn validate(&self) -> Result<()>

Validates identifiers, runtime metadata, patch limits, and signal names.

Trait Implementations

impl Clone for WorkflowSpec

fn clone(&self) -> WorkflowSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkflowSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WorkflowSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for WorkflowSpec

impl From<&WorkflowSpec> for FlowWorkflowIdentity

fn from(spec: &WorkflowSpec) -> Self

Converts to this type from the input type.

impl PartialEq for WorkflowSpec

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for WorkflowSpec

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 WorkflowSpec