Enum RequestError 

#[non_exhaustive]
pub enum RequestError {
    Spi(SpiError),
    Rewrite(RewriteError),
    Sink(SinkError),
    StaleEpoch {
        stamped: Epoch,
    },
    Internal {
        reason: &'static str,
    },
    Cursor {
        reason: &'static str,
    },
    PayloadTooLarge {
        reason: &'static str,
    },
}

A failure anywhere on the request path.

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.

Spi(SpiError)

Routing (partition resolution / placement) failed.

Rewrite(RewriteError)

A body transform failed (malformed document, reserved-field collision).

Sink(SinkError)

The write could not be delivered or was rejected upstream.

StaleEpoch

The write resolved against a placement epoch no longer current for a migrating partition: the migration write gate held it (docs/06 §2). Retryable, the client re-resolves against the new placement.

Fields

stamped: Epoch

The epoch the rejected decision was stamped with (an id, not data).

Internal

An internal invariant was violated, a bug, not a client or upstream fault. Carries a static reason (never tenant data) for the operator/LLM.

Fields

reason: &'static str

A short, value-free description of the violated invariant.

Cursor

A scroll/PIT cursor could not be resolved to its pinned cluster, its affinity envelope is absent, malformed, or fails its signature. The client must re-issue the originating search (docs/03 §6).

Fields

reason: &'static str

A short, value-free reason (e.g. "missing", "bad signature").

PayloadTooLarge

The request body exceeded a size cap (e.g. a single _bulk line over the per-op limit). A client error (413), not an internal fault: the client must split or shrink the body.

Fields

reason: &'static str

A short, value-free description of the limit that was exceeded.

Implementations

impl RequestError

pub fn code(&self) -> ErrorCode

The stable ErrorCode for this failure, surfaced into the trace and /debug/explain.

pub fn retryable(&self) -> bool

Whether the caller may retry.

Trait Implementations

impl Debug for RequestError

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

Formats the value using the given formatter.

impl Display for RequestError

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

Formats the value using the given formatter.

impl Error for RequestError

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<RewriteError> for RequestError

fn from(source: RewriteError) -> Self

Converts to this type from the input type.

impl From<SinkError> for RequestError

fn from(source: SinkError) -> Self

Converts to this type from the input type.

impl From<SpiError> for RequestError

fn from(source: SpiError) -> Self

Converts to this type from the input type.