Enum ClientError 

#[non_exhaustive]
pub enum ClientError {
    ConfigIo(String),
    ConfigDecode(String),
    MissingConfigField {
        field: &'static str,
    },
    ConfigValidation {
        field: &'static str,
        reason: String,
    },
    InvalidNamespacePath(String),
    InvalidCommitId(String),
    InvalidCheckpointId(String),
    Http(String),
    Api {
        status: u16,
        code: String,
        feature: Option<String>,
        message: String,
        request_id: Option<String>,
        details: Option<Box<ErrorDetails>>,
    },
    Io(String),
    Json(String),
}

Error returned by the blocking HTTP client.

Foreign causes (io, json, ureq) are captured as message strings rather than #[source] chains.

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.

ConfigIo(String)

ConfigDecode(String)

MissingConfigField

Fields

field: &'static str

ConfigValidation

Fields

field: &'static str

reason: String

InvalidNamespacePath(String)

InvalidCommitId(String)

InvalidCheckpointId(String)

Http(String)

Api

Fields

status: u16

code: String

feature: Option<String>

Capability feature key accompanying not_supported errors.

message: String

request_id: Option<String>

Correlation id the server assigned to the failed request.

details: Option<Box<ErrorDetails>>

Structured context for the code, when the server sent any. Boxed so the rare detailed error does not widen every client result.

Io(String)

Json(String)

Implementations

impl ClientError

pub fn code(&self) -> Option<ErrorCode>

Returns the typed code for ClientError::Api errors, or None for non-API errors and for codes this build does not know (clients must tolerate unknown codes).

pub fn kind(&self) -> Option<ErrorKind>

Returns the caller-action category for ClientError::Api errors.

Known codes classify through ErrorCode::kind. Unknown codes (a newer server) fall back to the HTTP status class, so retry decisions still work: 503 is ErrorKind::Unavailable, other 5xx are ErrorKind::Internal, and 4xx are ErrorKind::InvalidRequest.

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.