Struct RunState 

pub struct RunState {

    pub break_before: Option<String>,
    pub id: String,
    pub workflow: String,
    pub workflow_hash: String,
    pub inputs: Value,
    pub status: RunStatus,
    pub start: Start,
    pub steps: BTreeMap<String, StepState>,
    pub vars: Map<String, Value>,
    pub tokens: u64,
    pub steps_run: u32,
    pub output: Option<Value>,
    pub error: Option<String>,
    pub task: Option<String>,
    pub principal: Option<String>,
    pub conversation: Option<String>,
    pub children: Vec<String>,
    pub parent: Option<Value>,
    pub attempt: u32,
    pub created: u64,
    pub updated: u64,
    pub finished: Option<u64>,
    pub deadline_ms: Option<u64>,
    pub dirty: bool,
}

The durable run record (RFC 0025 §3.3 run, RFC 0027 §9).

Fields

break_before: Option<String>

Stop this run just before the named step starts (a breakpoint set with workflow.pause {before_step}). Durable, so it survives a restart — which is the point: the interesting bugs are the ones that need one.

id: String

workflow: String

workflow_hash: String

inputs: Value

status: RunStatus

start: Start

steps: BTreeMap<String, StepState>

vars: Map<String, Value>

tokens: u64

steps_run: u32

output: Option<Value>

error: Option<String>

task: Option<String>

principal: Option<String>

conversation: Option<String>

children: Vec<String>

parent: Option<Value>

attempt: u32

created: u64

updated: u64

finished: Option<u64>

deadline_ms: Option<u64>

dirty: bool

Implementations

impl RunState

pub fn new(id: &str, wf: &Workflow, start: Start, inputs: Value) -> RunState

pub fn touch(&mut self)

pub fn step(&self, id: &str) -> Option<&StepState>

pub fn data(&self, env: Value, memory: Value) -> Data

The template data view of this run (RFC 0027 §3). memory and env are supplied by the caller (env curated + secret-free).

pub fn begin_step(&mut self, id: &str) -> u32

Mark a step running (attempt +1). Returns the attempt.

pub fn end_step( &mut self, id: &str, status: StepStatus, output: Option<Value>, error: Option<String>, )

Record a step’s terminal outcome.

pub fn suspend_step(&mut self, id: &str, wait: Value)

Record a suspension (timer/gate/budget).

pub fn finish( &mut self, status: RunStatus, output: Option<Value>, error: Option<String>, )

Terminal transition of the run.

pub fn write_var(&mut self, key: &str, value: Value, mode: &str)

Apply an assign/transform write with a reducer mode.

pub fn progress(&self) -> Value

The steps counted as terminal/pending — for status views.

pub fn summary(&self) -> Value

Trait Implementations

impl Clone for RunState

fn clone(&self) -> RunState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RunState

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RunState

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RunState

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for RunState

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 RunState