Enum SdkError 

#[non_exhaustive]
pub enum SdkError {
    Service {
        service: ServiceError,
    },
    FlowAlreadyStarted {
        service: ServiceError,
    },
    FlowClosing {
        service: ServiceError,
    },
    FlowNotFound {
        service: ServiceError,
    },
    FlowNotActiveOrNotFound {
        service: ServiceError,
    },
    WorkerInvocation {
        service: ServiceError,
        worker: Box<WorkerError>,
    },
    RpcLockConflict {
        service: ServiceError,
    },
    LongPollTimeout {
        service: ServiceError,
    },
    ChannelMessageNotFound {
        service: ServiceError,
    },
    RequestTimeout {
        service: ServiceError,
    },
    FlowDefinition {
        message: String,
    },
    InvalidArgument {
        message: String,
    },
    ValueMapping {
        message: String,
    },
    InvalidStepResult {
        flow_type: String,
        step_type: String,
        detail: String,
    },
}

Reports service, definition, value, handler, and Flow-completion failures.

Match specific variants when recovery differs. Self::service_error extracts common gRPC metadata from every service-backed variant.

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.

Service

A general Dex service or transport call failed.

Fields

service: ServiceError

Structured service failure.

FlowAlreadyStarted

Starting a Flow conflicted with an existing Flow ID.

Fields

service: ServiceError

Structured start-operation failure.

FlowClosing

An update-class request arrived while Dex was closing the Flow.

Re-read the retained terminal Flow state before deciding what to do next. Match this variant instead of comparing service detail text:

fn should_reread_terminal_state(result: &SdkResult<()>) -> bool {
    matches!(result, Err(SdkError::FlowClosing { .. }))
}

Fields

service: ServiceError

Structured rejected-operation failure, including the original transport cause.

FlowNotFound

An operation requiring an existing Flow targeted an unknown ID.

Fields

service: ServiceError

Structured lookup failure.

FlowNotActiveOrNotFound

A Flow was not found or the operation could not use its closed execution.

RPC calls also use this variant for missing query-only targets. A query-only RPC without locks, transactionality, durable effects, or Server-forced Update routing can read a retained terminal execution. At that confirmed read boundary, treat this variant as not found without a lifecycle probe. Preserve other service and Worker failures.

For mutations and active-only RPCs, this variant does not distinguish missing from closed targets or prove that the requested action succeeded. Match it as follows:

fn report_unavailable(result: SdkResult<()>) -> SdkResult<()> {
    match result {
        Err(SdkError::FlowNotActiveOrNotFound { service }) => {
            eprintln!("{} has no usable target", service.operation());
            Err(SdkError::FlowNotActiveOrNotFound { service })
        }
        other => other,
    }
}

Fields

service: ServiceError

Structured target failure, including the original transport cause.

WorkerInvocation

A Worker Step or RPC handler failed.

Fields

service: ServiceError

Outer Dex service failure.

worker: Box<WorkerError>

Original Worker-side failure metadata.

RpcLockConflict

A locking RPC could not acquire all requested Attribute locks.

Fields

service: ServiceError

Structured aborted-operation failure.

LongPollTimeout

A long-poll timeout elapsed without indicating a Flow failure.

Fields

service: ServiceError

Structured timeout failure.

ChannelMessageNotFound

A requested Channel message is no longer pending.

Fields

service: ServiceError

Structured deletion failure.

RequestTimeout

A caller-defined request budget expired.

Fields

service: ServiceError

Structured timeout failure.

FlowDefinition

A registered Flow, Step, RPC, or persistence definition is invalid.

Fields

message: String

Developer-actionable contract violation.

InvalidArgument

An SDK method received an invalid argument.

Fields

message: String

Developer-actionable argument violation.

ValueMapping

An application value could not be serialized or decoded.

Fields

message: String

Developer-actionable mapping failure.

InvalidStepResult

A Step returned a value that violates its handler contract.

Fields

flow_type: String

Flow type containing the Step.

step_type: String

Step type that returned the invalid value.

detail: String

Developer-actionable result violation.

Implementations

impl SdkError

pub fn pull_registration_error(&self) -> Option<&PullRegistrationError>

Returns the typed pull queue rejection when a permanent error leaves no registered stream.

Registration waiters and opt-in Worker shutdown return the existing Self::Service variant. This accessor preserves its queue name and original gRPC status. Other errors return None. See crate::PullRegistrationError for a complete inspection example.

pub fn service_error(&self) -> Option<&ServiceError>

Returns shared service metadata for service-backed variants.

Local definition, argument, mapping, and invalid-result errors return None.

Trait Implementations

impl Clone for SdkError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SdkError

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

Formats the value using the given formatter.

impl Display for SdkError

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

Formats the value using the given formatter.

impl Error for SdkError

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.