Struct PauseCheckpoint 

pub struct PauseCheckpoint {
    pub workflow_id: String,
    pub step_index: usize,
    pub completed_steps: Vec<String>,
    pub pending_steps: Vec<String>,
    pub state_data: HashMap<String, String>,
    pub paused_at: u64,
    pub pause_reason: String,
}

A snapshot of workflow state recorded when the workflow is paused.

Fields

workflow_id: String

Identifier of the paused workflow.

step_index: usize

Zero-based index of the step at which execution was paused.

completed_steps: Vec<String>

Names of steps that had already completed before pausing.

pending_steps: Vec<String>

Names of steps still remaining to be executed.

state_data: HashMap<String, String>

Arbitrary serialised outputs or metadata from completed steps.

paused_at: u64

Unix timestamp (milliseconds) when the checkpoint was recorded.

pause_reason: String

Human-readable reason the workflow was paused.

Implementations

impl PauseCheckpoint

pub fn new(workflow_id: impl Into<String>, step_index: usize) -> Self

Create a new checkpoint for workflow_id paused at step_index.

paused_at is set to the current wall-clock time in milliseconds.

pub fn with_completed(self, step: impl Into<String>) -> Self

Add a completed step name (builder pattern).

pub fn with_pending(self, step: impl Into<String>) -> Self

Add a pending step name (builder pattern).

pub fn with_state( self, key: impl Into<String>, value: impl Into<String>, ) -> Self

Insert a key-value pair into the state data (builder pattern).

pub fn with_reason(self, reason: impl Into<String>) -> Self

Set the human-readable pause reason (builder pattern).

pub fn remaining_steps(&self) -> usize

Number of steps still pending (not yet executed).

pub fn progress_percent(&self) -> f32

Progress as a fraction in [0.0, 1.0].

Returns 0.0 when no steps have been completed and no steps are pending.

pub fn to_json(&self) -> String

Serialise the checkpoint to a JSON string.

The format is stable and suitable for long-term storage.

pub fn from_json(json: &str) -> Result<Self, String>

Deserialise a checkpoint from a JSON string produced by to_json.

Errors

Returns Err(String) when the JSON is malformed or a required field is missing.

Trait Implementations

impl Clone for PauseCheckpoint

fn clone(&self) -> PauseCheckpoint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PauseCheckpoint

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

Formats the value using the given formatter.

impl PartialEq for PauseCheckpoint

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PauseCheckpoint