Enum ClientError 

#[non_exhaustive]
pub enum ClientError {
    Transport(TransportError),
    Codec(CratestackError),
    State(String),
    InvalidResponse(String),
    BadInput(String),
    Envelope(EnvelopeError),
    Remote {
        status: StatusCode,
        error: Option<Box<CratestackErrorResponse>>,
        message: String,
        challenges: Challenges,
    },
}

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.

Transport(TransportError)

Codec(CratestackError)

State(String)

InvalidResponse(String)

BadInput(String)

Envelope(EnvelopeError)

The signed transport failed (cratestack#1007). Never a decoded body.

Remote

Fields

status: StatusCode

error: Option<Box<CratestackErrorResponse>>

The decoded error envelope, boxed since cratestack#1208 gave it an extra map: inline, it made every Result<_, ClientError> carry it (clippy::result_large_err).

message: String

challenges: Challenges

Every WWW-Authenticate value the answer carried, raw and in order (cratestack#1243): an AuthRefusal’s challenges. Empty when there were none. ClientError::challenges reads it.

Implementations

impl ClientError

pub fn remote_error(&self) -> Option<&CratestackErrorResponse>

The decoded error envelope of a ClientError::Remote: code, message, details and the extra members in extra. None for any other variant, or when the body did not decode.

pub fn challenges(&self) -> &[String]

The WWW-Authenticate values of a ClientError::Remote, raw and in order; empty for any other variant.

impl ClientError

pub fn step_up(&self) -> Option<StepUpRequired>

The step-up refusal this error carries: a 401 whose envelope’s extra member error is insufficient_user_authentication. None for anything else.

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 RpcClientError

fn from(error: ClientError) -> Self

Converts to this type from the input type.

impl From<ClientError> for RuntimeErrorWire

fn from(value: ClientError) -> Self

Converts to this type from the input type.

impl From<CratestackError> for ClientError

fn from(source: CratestackError) -> Self

Converts to this type from the input type.

impl From<EnvelopeError> for ClientError

fn from(source: EnvelopeError) -> Self

Converts to this type from the input type.

impl From<Error> for ClientError

fn from(e: Error) -> Self

Converts to this type from the input type.

impl StepUpError for ClientError

fn step_up(&self) -> Option<StepUpRequired>

The refusal, when this error is one.