Struct FaultStateEnvelope 

pub struct FaultStateEnvelope { /* private fields */ }

The bounded, checksummed fault state of one durable step execution.

Format 1 is canonical JSON containing the prior committed checkpoint digest and at most Self::MAX_ENTRIES digest-sorted unresolved retry entries. The empty envelope carries the zero checkpoint digest because no entry depends on a checkpoint generation.

Implementations

impl FaultStateEnvelope

pub const FORMAT: &'static str = "oxide-batch.fault-state"

The framework format identifier durable adapters persist.

pub const FORMAT_VERSION: u16 = 1

The framework format version durable adapters persist.

pub const SCHEMA_VERSION: u32 = 1

The framework schema version durable adapters persist.

pub const MAX_BYTES: usize

The canonical byte ceiling accepted by the durable metadata model.

pub const MAX_ENTRIES: usize = 256

The hard unresolved-key ceiling of format 1.

pub const fn empty() -> Self

Returns the envelope every step execution starts from.

pub fn new( checkpoint_digest: [u8; 32], entries: impl IntoIterator<Item = FaultStateEntry>, ) -> Result<Self, FaultStateFormatError>

Validates a complete envelope, sorting entries by retry-key digest.

Errors

Returns FaultStateFormatError::TooManyEntries above the format ceiling, FaultStateFormatError::DuplicateKey for a repeated key, and FaultStateFormatError::CheckpointMismatch when a non-empty envelope carries the zero checkpoint digest.

pub const fn checkpoint_digest(&self) -> &[u8; 32]

Returns the checkpoint generation the retained entries belong to.

pub fn entries(&self) -> &[FaultStateEntry]

Borrows the digest-sorted unresolved entries.

pub fn is_empty(&self) -> bool

Returns whether the envelope retains no unresolved key.

pub fn len(&self) -> usize

Returns the number of retained unresolved keys.

pub fn reserved_ordinal(&self, key: RetryKey) -> Option<RetryOrdinal>

Returns the ordinal already reserved for key, when one exists.

pub fn entry(&self, key: RetryKey) -> Option<&FaultStateEntry>

Borrows the retained entry for key, when one exists.

pub fn reserved( &self, entry: FaultStateEntry, checkpoint_digest: [u8; 32], limit: RetryStateLimit, ) -> Result<Self, FaultStateError>

Returns the envelope after accepting one reservation.

The ordinal must directly follow the persisted one for the same key, and a new key must fit within limit unresolved keys.

Errors

Returns FaultStateError::StaleReservation for a non-consecutive ordinal, FaultStateError::CapacityExhausted at the configured bound, and FaultStateError::Corrupt when the entry belongs to a different checkpoint generation.

pub fn to_canonical_json(&self) -> Result<Vec<u8>, FaultStateFormatError>

Serializes the canonical bytes the durable checksum covers.

Errors

Returns FaultStateFormatError::TooLarge above the durable ceiling.

pub fn checksum(&self) -> Result<[u8; 32], FaultStateFormatError>

Returns the SHA-256 checksum over the canonical bytes.

Errors

Returns FaultStateFormatError::TooLarge above the durable ceiling.

pub fn from_canonical_json( format_version: u16, schema: &str, schema_version: u32, bytes: &[u8], checksum: &[u8; 32], ) -> Result<Self, FaultStateFormatError>

Validates canonical bytes and their durable checksum.

Unknown format or schema versions, checksum mismatch, invalid enumerations, an unsorted or duplicated key, and an over-large payload are corruption. No component work may begin after one.

Errors

Returns the redacted FaultStateFormatError that rejected the bytes.

pub fn validate_for( &self, retry_limit: RetryLimit, state_limit: RetryStateLimit, checkpoint_digest: &[u8; 32], ) -> Result<(), FaultStateFormatError>

Rejects state the current policy and checkpoint cannot own.

Errors

Returns FaultStateFormatError::OrdinalAboveLimit for an ordinal the configured retry limit cannot reach, [FaultStateFormatError:: TooManyEntries] above the configured capacity, and FaultStateFormatError::CheckpointMismatch when the retained entries belong to a superseded checkpoint.

Trait Implementations

impl Clone for FaultStateEnvelope

fn clone(&self) -> FaultStateEnvelope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FaultStateEnvelope

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

Formats the value using the given formatter.

impl Default for FaultStateEnvelope

fn default() -> Self

Returns the “default value” for a type.

impl Eq for FaultStateEnvelope

impl PartialEq for FaultStateEnvelope

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FaultStateEnvelope