Enum SdkError 

#[non_exhaustive]
pub enum SdkError {
    Shutdown,
    Ingestion(String),
    Sampled,
    Unrouted,
    Poll(String),
    Adapter(String),
    Serialization(Error),
    Config(String),
    NoMesh,
    Backpressure,
    NotConnected,
    ChannelRejected(Option<AckReason>),
    Traversal {
        kind: &'static str,
        message: String,
    },
}

Unified SDK error.

Marked #[non_exhaustive] so adding a new variant is a minor-version change — external match statements must include a wildcard arm. The most recent variant additions (Sampled, Unrouted) tightened From<IngestionError> so structured backpressure / sampling / no-route signals stop being funnelled into a stringly-typed Ingestion(String). Callers that previously matched on the string content of Ingestion need to be updated to match the new variants.

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.

Shutdown

Ingestion(String)

Generic ingestion failure that doesn’t map to a more specific variant.

Pre-fix, every IngestionError was funnelled here — Backpressure, Sampled, Unrouted, and shutdown all became Ingestion("…") and callers had to string-match to pick a remediation. Today’s From<IngestionError> impl routes the structured variants below; this String variant stays as a fallback for any future IngestionError addition and for callers that already pattern-match on it.

Sampled

Event was deliberately dropped by a sampling / decimation policy. Retrying is pointless — the producer should accept the drop or change the sampling rate.

Unrouted

No routable shard for the event. Typically a topology- transient state (a concurrent scale-down removed the hashed shard id, or the shard is still provisioning). Retry once topology stabilizes; back-off-and-retry on Backpressure semantics is the wrong remediation.

Poll(String)

Adapter(String)

Serialization(Error)

Config(String)

NoMesh

Backpressure

Stream’s per-stream in-flight window is full. The caller’s events were NOT sent — daemons decide whether to drop, retry, or buffer at the app layer. See Mesh::send_with_retry / send_blocking for the two built-in policies.

NotConnected

Stream’s peer session is gone (peer disconnected, never connected, or the stream was closed).

ChannelRejected(Option<AckReason>)

A publisher’s Ack rejected a Subscribe / Unsubscribe request. None means the rejection arrived without a structured reason. Gated behind net because AckReason lives in the network-transport surface; non-net SDK builds (e.g. redis-only consumer helpers) don’t compile this variant.

Traversal

NAT-traversal failure — a reflex probe, hole-punch, or port-mapping path couldn’t complete. Always represents a missed optimization, never a connectivity failure: every NATed peer remains reachable through the routed- handshake path. kind is a stable discriminator matching the nat-traversal crate’s error vocabulary (reflex-timeout / peer-not-reachable / transport / rendezvous-no-relay / rendezvous-rejected / punch-failed / port-map-unavailable / unsupported).

Fields

kind: &'static str

Stable machine-readable discriminator — same value as TraversalError::kind(). Never localized; never changed once a variant has shipped.

message: String

Human-readable detail (e.g. the underlying socket error on a transport failure). Empty for kinds that have no variable detail.

Trait Implementations

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.

impl From<AdapterError> for SdkError

fn from(e: AdapterError) -> Self

Converts to this type from the input type.

impl From<ConsumerError> for SdkError

fn from(e: ConsumerError) -> Self

Converts to this type from the input type.

impl From<Error> for SdkError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<IngestionError> for SdkError

fn from(e: IngestionError) -> Self

Converts to this type from the input type.

impl From<StreamError> for SdkError

Available on crate feature net only.

fn from(e: StreamError) -> Self

Converts to this type from the input type.

impl From<TraversalError> for SdkError

Available on crate feature nat-traversal only.

fn from(e: TraversalError) -> Self

Converts to this type from the input type.