Enum SdkError 

pub enum SdkError {
    ReadInterrupted,
    Connection {
        description: String,
    },
    Protocol {
        description: String,
    },
    Serialization {
        description: String,
    },
    TypeValidation {
        description: String,
    },
    Backpressure {
        reason: String,
    },
    PublishUnresolved {
        description: String,
    },
    Conversation {
        conversation_id: String,
        description: String,
    },
    Store {
        description: String,
    },
    NotConnected {
        operation: String,
    },
    Unwired {
        surface: String,
        seam: String,
        alternative: String,
    },
}

Error taxonomy returned by the Rust SDK API surface.

The SDK keeps application code independent from transport, protocol framing, and core implementation error types. Concrete embedded and remote adapters map their internal failures into these variants.

Clone is derived so a failure can be both RETAINED and RETURNED at the same seam. A store failure that bricks a participant handle is exactly that shape: the error travels to the caller of the failing operation, while a copy stays behind as the reason every later call reports RemoteParticipantError::StateUnavailable. Without it the cause is observable exactly once and only by whoever happened to make the failing call.

Variants

ReadInterrupted

A ReadWake ended a budgeted participant read before a frame arrived; the transport remains usable. See ReadWake for which reads it reaches.

Connection

Establishing, keeping, or recovering a client connection failed.

Fields

description: String

Human-readable context from the failing connection operation.

Protocol

Encoding, decoding, or interpreting SDK-internal protocol state failed.

Fields

description: String

Human-readable protocol failure context.

Serialization

Serialising an outbound value or deserialising an inbound value failed.

Fields

description: String

Human-readable serialization failure context.

TypeValidation

A typed message did not satisfy the schema declared for its channel.

Fields

description: String

Human-readable type-validation context.

Backpressure

A publish operation encountered application-visible backpressure.

Fields

reason: String

Human-readable pressure reason.

PublishUnresolved

A publish whose outcome the server could not resolve: it cannot tell whether the message was stored.

Decoded from the reply’s reason code alone, never from its text. It is neither a rejection nor backpressure: the publish may have been stored, so the safe response is a retry carrying the SAME idempotency key, which answers the original outcome if the row committed.

Fields

description: String

The server’s detail for the unresolved publish, verbatim.

Conversation

A conversation operation failed.

Fields

conversation_id: String

Application-visible conversation identifier.

description: String

Human-readable conversation failure context.

Store

Persisted subscription or recovery state could not be read or written.

Fields

description: String

Human-readable store failure context.

NotConnected

A remote operation ran against a configuration whose transport was never connected, so nothing it did could have reached any wire.

RemoteConfig::new installs the unconnected in-process transport. Call RemoteConfig::connect_tcp, RemoteConfig::connect_tcp_with_auth, RemoteConfig::connect_websocket, RemoteConfig::connect_websocket_with_auth, or (with the embedded feature) RemoteConfig::connect_loopback before publishing, subscribing, conversing, or resuming. The SDK refuses here rather than encoding a frame it discards and reporting the success that would imply.

Fields

operation: String

The SDK operation that refused.

Unwired

An SDK surface exists but has no machinery behind it, so it refused rather than reporting a success it cannot deliver.

This is the SDK being loud about an absent feature. seam records where the gap is written down (a ledger row, or that nothing records it) and alternative names the surface that does work today.

Fields

surface: String

The SDK surface that refused.

seam: String

Where the gap is recorded, or that nothing records it.

alternative: String

The working surface a caller should reach for instead.

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 Eq for SdkError

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.

impl From<MailboxOverflow> for SdkError

fn from(overflow: MailboxOverflow) -> Self

Converts to this type from the input type.

impl PartialEq for SdkError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SdkError