Enum ClientError 

#[non_exhaustive]
pub enum ClientError {
    Connect {
        addr: String,
        reason: String,
    },
    InvalidApiKey,
    Transport(String),
    Unauthenticated(String),
    Overloaded(String),
    InvalidRequest(String),
    ServerInternal(String),
    UnexpectedStatus {
        code: Code,
        message: String,
    },
    EmptyBatch,
    BatchResultCountMismatch {
        expected: usize,
        got: usize,
    },
    MalformedResponse(&'static str),
    MalformedJob(JobConversionError),
    MalformedServerInfo(ServerInfoError),
}

The general client error type, shared by most RPCs.

gRPC status codes are mapped onto these variants: Unavailable / DeadlineExceeded / Aborted / Cancelled become Transport, ResourceExhausted becomes Overloaded, and so on. The RetryPolicy retries Unavailable, DeadlineExceeded, and Aborted (all surfacing as Transport) plus ResourceExhausted (Overloaded); a Cancelled RPC also maps to Transport but is never retried.

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.

Connect

Establishing the connection failed.

Fields

addr: String

reason: String

InvalidApiKey

The configured API key could not be encoded as an HTTP header value.

Transport(String)

A transient transport-level failure (connection dropped, deadline exceeded, request aborted/cancelled). Generally safe to retry, though the RetryPolicy does not retry cancelled RPCs, and retried enqueues can duplicate jobs that carry no idempotency key.

Unauthenticated(String)

The server rejected the credentials (missing/invalid API key, or permission denied).

Overloaded(String)

The server is shedding load (ResourceExhausted); back off and retry.

InvalidRequest(String)

The server rejected the request as malformed (InvalidArgument).

ServerInternal(String)

The server hit an internal error (Internal / DataLoss / Unknown).

UnexpectedStatus

The server returned a status code this client does not map to a more specific variant.

Fields

code: Code

message: String

EmptyBatch

An enqueue was attempted with no jobs.

BatchResultCountMismatch

The server returned a different number of results than jobs sent — a protocol violation.

Fields

expected: usize

got: usize

MalformedResponse(&'static str)

A response was missing a field the protocol requires.

MalformedJob(JobConversionError)

A job in a response could not be decoded; see JobConversionError.

MalformedServerInfo(ServerInfoError)

A server-info response could not be decoded; see ServerInfoError.

Trait Implementations

impl Debug for ClientError

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

Formats the value using the given formatter.

impl Display for ClientError

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

Formats the value using the given formatter.

impl Error for ClientError

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<ClientError> for EnqueueError

fn from(source: ClientError) -> Self

Converts to this type from the input type.

impl From<ClientError> for LeaseError

fn from(source: ClientError) -> Self

Converts to this type from the input type.

impl From<ClientError> for ReserveError

fn from(source: ClientError) -> Self

Converts to this type from the input type.

impl From<ClientError> for AtomicEnqueueError

fn from(source: ClientError) -> Self

Converts to this type from the input type.

impl From<JobConversionError> for ClientError

fn from(source: JobConversionError) -> Self

Converts to this type from the input type.

impl From<ServerInfoError> for ClientError

fn from(source: ServerInfoError) -> Self

Converts to this type from the input type.

impl From<Status> for ClientError

fn from(s: Status) -> Self

Converts to this type from the input type.