Enum OxiaError 

#[non_exhaustive]
pub enum OxiaError {
    KeyNotFound,
    UnexpectedVersionId,
    SessionExpired,
    RequestTooLarge,
    InvalidArgument(String),
    LeaderNotFound {
        shard: i64,
    },
    NoShardForKey {
        key: String,
    },
    Disconnected(String),
    Timeout,
    Grpc {
        code: Code,
        message: String,
    },
    Decode(String),
    ShardMoved,
    Closed,
}

Errors returned by the Oxia client.

The variants fall into three groups:

• Semantic results callers commonly match on (KeyNotFound, UnexpectedVersionId, SessionExpired, RequestTooLarge, InvalidArgument). These are never retryable.
• Transient failures that the client’s background loops (and, in a later phase, its operation-level retries) may retry: LeaderNotFound, NoShardForKey, Disconnected, and some Grpc codes. See OxiaError::is_retryable.
• Terminal failures: Timeout, Decode, Closed, and the remaining Grpc codes.

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.

KeyNotFound

The requested key does not exist.

UnexpectedVersionId

A conditional operation failed because the stored version did not match the expected one.

SessionExpired

The session backing an ephemeral record has expired or been closed.

RequestTooLarge

A single request, or a batch that cannot be split further, exceeds the server’s maximum message size.

InvalidArgument(String)

An option or argument passed to an operation was invalid.

LeaderNotFound

No leader is currently available for the shard (e.g. a leader election is in progress). Retryable.

Fields

shard: i64

The shard without a known leader.

NoShardForKey

No shard currently owns the key, because shard assignments have not been loaded yet or are momentarily incomplete. Retryable.

Fields

key: String

The key that could not be routed.

Disconnected(String)

The connection to a server was lost or could not be established, or an in-flight request’s worker went away. Retryable.

Timeout

An operation did not complete before its deadline.

Grpc

The server returned a gRPC status. Whether it is retryable depends on the code (see OxiaError::is_retryable).

Fields

code: Code

The gRPC status code.

message: String

The gRPC status message.

Decode(String)

A server response could not be decoded — a required field was missing, or the response did not match the request. Indicates a protocol mismatch or a server bug.

ShardMoved

A shard was split or merged while an operation targeted it. The client re-routes such operations to the new shard automatically, so this is not normally observed. Retryable (by re-routing).

Closed

The client has been shut down and can no longer be used.

Implementations

impl OxiaError

pub fn is_retryable(&self) -> bool

Whether retrying the operation that produced this error might succeed.

Mirrors the retryable set of the reference Go client: connection loss, missing shard leaders / assignments, and the UNAVAILABLE / ABORTED / CANCELLED gRPC codes (the last being a shutting-down server’s own cancellation propagating). Semantic results (e.g. KeyNotFound) and terminal failures are not retryable.

Trait Implementations

impl Clone for OxiaError

fn clone(&self) -> OxiaError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OxiaError

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

Formats the value using the given formatter.

impl Display for OxiaError

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

Formats the value using the given formatter.

impl Error for OxiaError

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<Error> for OxiaError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Status> for OxiaError

fn from(status: Status) -> Self

Converts to this type from the input type.