Struct ClientError 

#[non_exhaustive]
pub struct ClientError {
    pub kind: ErrorKind,
    pub attempts: usize,
    pub body: Option<String>,
}

The failure of a call, once its retries (if any) are used up. The client produces these; ClientError::new exists for consumers that need to fabricate one, such as a test double for TransportEvent::Failed.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

kind: ErrorKind

The failure of the last attempt.

attempts: usize

Attempts made, including the first one.

body: Option<String>

The start of the last non-2xx response body (up to 2 KiB, UTF-8 lossy), for callers that surface the server’s own message — an outbox entry’s last_error, a lens log line. None when there was no response body to read, and for transport, breaker and auth failures. Not part of Display.

Implementations

impl ClientError

pub fn new(kind: ErrorKind, attempts: usize) -> ClientError

An error of kind after attempts attempts, with no response body.

pub fn with_body(self, body: Option<String>) -> ClientError

Attach the start of the failing response body.

pub fn is_final(&self) -> bool

Whether no retry, now or later, could change this answer: a 4xx other than 408 / 429, or an auth refresher that failed. Everything else (5xx, transport, an open breaker) is the transient kind a later call may get past, so callers log it quietly.

pub fn status(&self) -> Option<u16>

The HTTP status of the last attempt, when there was a response.

pub fn kind_name(&self) -> &'static str

A stable lowercase name for the kind, for logs and tests.

Trait Implementations

impl Clone for ClientError

fn clone(&self) -> ClientError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientError

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

Formats the value using the given formatter.

impl Display for ClientError

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

Formats the value using the given formatter.

impl Eq for ClientError

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

fn eq(&self, other: &ClientError) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ClientError