Struct StepContext 

pub struct StepContext {
    pub operation_id: String,
    pub parent_id: Option<String>,
    pub name: Option<String>,
    pub durable_execution_arn: String,
    pub attempt: u32,
    pub retry_payload: Option<String>,
}

Context provided to step functions during execution.

This struct provides information about the current step execution that can be used by the step function for logging or other purposes.

Examples

Creating a basic step context:

use durable_execution_sdk::handlers::StepContext;

let ctx = StepContext::new("op-123", "arn:aws:lambda:us-east-1:123456789012:function:test:durable:abc");
assert_eq!(ctx.operation_id, "op-123");
assert_eq!(ctx.attempt, 0);
assert!(ctx.parent_id.is_none());

Using the builder pattern:

use durable_execution_sdk::handlers::StepContext;

let ctx = StepContext::new("op-123", "arn:aws:lambda:us-east-1:123456789012:function:test:durable:abc")
    .with_parent_id("parent-456")
    .with_name("process-order")
    .with_attempt(2);

assert_eq!(ctx.parent_id, Some("parent-456".to_string()));
assert_eq!(ctx.name, Some("process-order".to_string()));
assert_eq!(ctx.attempt, 2);

Fields

operation_id: String

The operation identifier for this step

parent_id: Option<String>

The parent operation ID, if any

name: Option<String>

The name of the step, if provided

durable_execution_arn: String

The durable execution ARN

attempt: u32

The current retry attempt (0-indexed) Requirements: 4.8

retry_payload: Option<String>

The retry payload from the previous attempt (for wait-for-condition pattern) Requirements: 4.9

Implementations

impl StepContext

pub fn new( operation_id: impl Into<String>, durable_execution_arn: impl Into<String>, ) -> Self

Creates a new StepContext.

pub fn with_parent_id(self, parent_id: impl Into<String>) -> Self

Sets the parent ID.

pub fn with_name(self, name: impl Into<String>) -> Self

Sets the name.

pub fn with_attempt(self, attempt: u32) -> Self

Sets the attempt number.

pub fn with_retry_payload(self, payload: impl Into<String>) -> Self

Sets the retry payload from the previous attempt. Requirements: 4.9

pub fn serdes_context(&self) -> SerDesContext

Creates a SerDesContext from this StepContext.

pub fn get_retry_payload<T>( &self, ) -> Result<Option<T>, Box<dyn Error + Send + Sync>>

where T: DeserializeOwned,

Returns the retry payload deserialized to the specified type.

This is useful for the wait-for-condition pattern where state is passed between retry attempts.

Type Parameters

• T - The type to deserialize the payload into

Returns

Ok(Some(T)) if payload exists and can be deserialized, Ok(None) if no payload exists, Err if deserialization fails.

Examples

use durable_execution_sdk::handlers::StepContext;
use serde::Deserialize;

#[derive(Deserialize, Debug, PartialEq)]
struct RetryState {
    counter: i32,
}

// With a payload
let ctx = StepContext::new("op-123", "arn:test")
    .with_retry_payload(r#"{"counter": 5}"#);
let state: Option<RetryState> = ctx.get_retry_payload().unwrap();
assert_eq!(state, Some(RetryState { counter: 5 }));

// Without a payload
let ctx_no_payload = StepContext::new("op-456", "arn:test");
let state: Option<RetryState> = ctx_no_payload.get_retry_payload().unwrap();
assert!(state.is_none());

Trait Implementations

impl Clone for StepContext

fn clone(&self) -> StepContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StepContext

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

Formats the value using the given formatter.