Enum DurableError 

#[non_exhaustive]
pub enum DurableError {
    ReplayDivergence {
        step_id: StepId,
    },
    AmbiguityPolicyRequired {
        step: &'static str,
    },
    JournalUnavailable,
    PayloadTooLarge {
        size: u64,
        max: u64,
    },
    Decode {
        context: &'static str,
    },
    ReplayIntegrity,
    StepCapExceeded {
        cap: u32,
    },
    EncryptionRequired {
        context: &'static str,
    },
    UnsupportedEntryKind {
        kind: &'static str,
    },
    Storage {
        op: &'static str,
        source: Box<dyn Error + Send + Sync>,
    },
    StepFailed {
        step: &'static str,
        source: Box<dyn Error + Send + Sync>,
    },
    AmbiguousEffect {
        step_id: StepId,
    },
    Serialize {
        step: &'static str,
    },
    UnknownPromise,
    PromiseRejected,
}

An error raised by the durable execution layer.

The enum is #[non_exhaustive]: follow-up issues add variants as runtime behavior lands, and downstream match expressions must keep a wildcard arm.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

ReplayDivergence

The replayed step’s descriptor fingerprint did not match the fingerprint journaled for this StepId (INV-3). The execution is discarded and restarted fresh rather than returning a result for a structurally different step.

Fields

step_id: StepId

The step whose fingerprint diverged.

AmbiguityPolicyRequired

A destructive or security-relevant ExactlyOnceGuarded step was constructed without an explicit ambiguity policy. The safety decision must be made at the call site, not deferred to a runtime default.

Fields

step: &'static str

The name of the offending step descriptor.

JournalUnavailable

The journal writer did not acknowledge an append within the configured timeout, or is otherwise unreachable. The calling path degrades to non-durable mode rather than hanging (INV-12).

PayloadTooLarge

A payload exceeded the configured max_payload_bytes limit. Enforced on both append and read; it fails closed and never panics (INV-11).

Fields

size: u64

The size of the offending payload, in bytes.

max: u64

The configured maximum payload size, in bytes.

Decode

A journal entry could not be decoded: corrupt, truncated, or written under an unknown wire format version. Fails closed.

Fields

context: &'static str

A non-sensitive description of the decode failure.

ReplayIntegrity

AEAD authentication failed when opening a sealed payload: the entry was forged, moved to a different step, or replayed under a different execution. Fails closed.

StepCapExceeded

An execution exceeded the hard per-execution step cap and was aborted rather than allowed to grow unboundedly.

Fields

cap: u32

The configured hard step cap.

EncryptionRequired

AEAD payload encryption was disabled (encrypt_payload = false) for a deployment where it is mandatory — a non-local backend or a shared database (INV-8). The DB-file trust boundary does not hold in multi-client environments, so this fails closed at startup.

Fields

context: &'static str

A non-sensitive label for the deployment that mandates encryption (e.g. "restate" or "shared-database").

UnsupportedEntryKind

A journal entry of a kind whose persistence is provided by a higher layer not yet wired into this backend revision. Promise, timer, and checkpoint entries land with the promise/timer and retention layers; until then the backend fails closed rather than silently dropping the entry’s kind-specific state.

Fields

kind: &'static str

The entry_kind tag of the entry whose persistence is deferred.

Storage

A journal storage operation failed at the database layer (connection, migration, or query).

The static op names the failing operation; the underlying database error is attached as the error source. Per INV-5 the Display message carries only the operation name — the boxed source never contains plaintext payloads, since every bind is ciphertext, a hash, or a non-secret descriptor.

Fields

op: &'static str

The static name of the failing operation (e.g. "append", "finalize", "open").

source: Box<dyn Error + Send + Sync>

The underlying database error.

StepFailed

A step’s operation closure returned an error on a fresh execution. The step did not complete, so no StepResult is journaled; on a later resume the step re-runs (or, for a guarded effect, its OnAmbiguous policy applies). The closure’s own error is attached as the source.

Fields

step: &'static str

The name of the step whose operation closure failed.

source: Box<dyn Error + Send + Sync>

The closure’s underlying error.

AmbiguousEffect

A guarded step resumed inside the ambiguous window (an EffectIntent is journaled but no StepResult) and its policy is OnAmbiguous::Fail: the layer refuses to guess whether the irreversible effect fired and surfaces the decision to the operator instead of re-running or skipping it.

Fields

step_id: StepId

The step caught in the ambiguous window.

Serialize

A step result could not be serialized into journal bytes before sealing. The step’s value is the consumer’s serializable type, so this indicates a faulty Serialize implementation; it fails closed rather than journaling a partial payload. Per INV-5 only the step name is named.

Fields

step: &'static str

The name of the step whose result failed to serialize.

UnknownPromise

A promise resolution referenced a promise that has no durable_promises row — either never created, or pruned. Fails closed rather than silently succeeding. Per INV-5 the raw PromiseId is semi-sensitive and is therefore not embedded in the message.

PromiseRejected

A promise resolution presented a resolver token that did not match the stored hash (INV-9). The comparison is constant-time, and neither the presented token nor the raw PromiseId appears in the message (INV-5). The pending promise is left untouched.

Trait Implementations

impl Debug for DurableError

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

Formats the value using the given formatter.

impl Display for DurableError

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

Formats the value using the given formatter.

impl Error for DurableError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<CipherError> for DurableError

fn from(err: CipherError) -> Self

Lift a cipher failure into the crate-wide error, preserving fail-closed semantics.

An authentication failure is a replay-integrity violation; a structural or key-selection failure is a decode failure. Both fail closed — no plaintext is ever returned.