Skip to main content

CheckpointingRunner

Struct CheckpointingRunner 

Source
pub struct CheckpointingRunner<B> { /* private fields */ }
Expand description

A single-process workflow runner with checkpointing for crash recovery.

CheckpointingRunner executes an entire workflow within one process, saving snapshots after each task. Fork branches run concurrently as tokio tasks. If the process crashes, the workflow can be resumed from the last checkpoint.

§When to Use

  • Single-node execution: One process runs the entire workflow
  • Crash recovery: Resume from the last completed task after restart
  • Simple deployment: No coordination between workers needed

For horizontal scaling with multiple workers, use PooledWorker.

§Example

let backend = InMemoryBackend::new();
let runner = CheckpointingRunner::new(backend);

let ctx = WorkflowContext::new("my-workflow", Arc::new(JsonCodec), Arc::new(()));
let workflow = WorkflowBuilder::new(ctx)
    .then("step1", |i: u32| async move { Ok(i + 1) })
    .build()?;

// Run workflow - snapshots are saved automatically
let status = runner.run(&workflow, "instance-123", 1u32).await?;

// Resume from checkpoint if needed (e.g., after crash)
let status = runner.resume(&workflow, "instance-123").await?;

Implementations§

Source§

impl<B> CheckpointingRunner<B>

Source

pub fn new(backend: B) -> Self

Create a new checkpointing runner with the given backend.

Source

pub fn from_shared(backend: Arc<B>) -> Self

Create a runner from a shared backend reference.

Useful when the same backend is shared with a WorkflowClient.

Source

pub fn with_conflict_policy(self, policy: ConflictPolicy) -> Self

Set the conflict policy for duplicate instance IDs.

Source

pub fn backend(&self) -> &Arc<B>

Get a reference to the backend.

Source§

impl<B> CheckpointingRunner<B>
where B: PersistentBackend + 'static,

Source

pub async fn run<C, Input, M>( &self, workflow: &Workflow<C, Input, M>, instance_id: impl Into<String>, input: Input, ) -> Result<WorkflowStatus, RuntimeError>
where Input: Send + 'static, M: Send + Sync + 'static, C: Codec + EnvelopeCodec + EncodeValue<Input> + DecodeValue<Input> + 'static,

Run a workflow from the beginning, saving checkpoints after each task.

The instance_id uniquely identifies this workflow execution instance. The ConflictPolicy (set via with_conflict_policy) controls behaviour when a snapshot with this ID already exists.

§Errors

Returns an error if the workflow cannot be executed, if snapshot operations fail, or if the conflict policy rejects a duplicate.

Source

pub async fn resume<'w, C, Input, M>( &self, workflow: &'w Workflow<C, Input, M>, instance_id: &str, ) -> Result<WorkflowStatus, RuntimeError>
where Input: Send + 'static, M: Send + Sync + 'static, C: Codec + EnvelopeCodec + DecodeValue<Input> + EncodeValue<Input> + 'static,

Resume a workflow from a saved snapshot.

Loads the snapshot for the given instance ID and continues execution from the last checkpoint.

§Errors

Returns an error if:

  • The snapshot is not found
  • The workflow definition hash doesn’t match (workflow definition changed)
  • The workflow cannot be resumed

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

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

impl<T> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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