Enum ClientError 

pub enum ClientError {
    Auth {
        message: String,
    },
    Server {
        message: String,
        code: Option<String>,
    },
    Connection {
        message: String,
    },
    Timeout,
    FrameTooLarge {
        message: String,
    },
    Decode {
        message: String,
    },
}

The stable error classes of the client contract (CLT-050).

Variants are the public API — matching on them is supported forever. Clone is required so one connection failure can fan out to every pending call (CLT-014).

Variants

Auth

Authentication / authorization failure — handshake rejections (CLT-003) and NOAUTH/WRONGPASS/NOPERM-prefixed replies (CLT-051).

Fields

message: String

Raw server message, verbatim.

Server

The server answered the call with Result::Err.

Fields

message: String

Raw server message, verbatim (any [code] prefix included).

code: Option<String>

Machine-readable code extracted from a leading "[code] " prefix under BracketCode / Both conventions (PRO-014).

Connection

Transport-level failure: dial, write, or the connection dying while the call was pending (CLT-004/030/031). Also raised for invalid endpoints (CLT-070).

Fields

message: String

Human-readable cause.

Timeout

The per-call (or connect) timeout elapsed (CLT-020). The pending entry was removed; a late response is dropped per CLT-013.

FrameTooLarge

The server sent a frame larger than the profile cap; the connection was poisoned (WIRE-020 via CLT-014).

Fields

message: String

Human-readable cause.

Decode

The server sent a malformed frame (or a push frame under a Reserved profile, CLT-060); the connection was poisoned (CLT-014).

Fields

message: String

Human-readable cause.

Implementations

impl ClientError

pub fn from_server_message( message: impl Into<String>, convention: ErrorConvention, ) -> Self

Parse a server error string per the profile’s convention (CLT-050, PRO-014).

• Resp3Prefixes: NOAUTH/WRONGPASS/NOPERM → Self::Auth; everything else (ERR … included) → Self::Server.
• BracketCode: a leading "[code] " is extracted into code; the auth prefixes still map to Self::Auth regardless of convention (CLT-051).
• Both: composes the two — bracket code first, then prefixes.
• None: no parsing; the raw message becomes Self::Server.

message always carries the raw string, verbatim.

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

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 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