Enum Error 

#[non_exhaustive]
pub enum Error {
    InvalidUrl {
        url: String,
        reason: &'static str,
    },
    Invalid(String),
    Transport {
        base: String,
        cause: String,
        source: Error,
    },
    Api(Box<ApiError>),
    UnsupportedContract {
        served: String,
    },
    ResponseTooLarge,
    Decode(Error),
    Accounts(Error),
}

Everything that can go wrong in this crate.

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.

InvalidUrl

The Commit API URL cannot be used; nothing was sent.

Fields

url: String

The URL as given.

reason: &'static str

Why it was refused.

Invalid(String)

A value passed to the client was refused before anything was sent.

Transport

The request never got an answer (DNS, connection, TLS, timeout).

Fields

base: String

The API origin.

cause: String

The innermost cause, without URLs or credentials.

source: Error

The transport error (its URL is removed).

Api(Box<ApiError>)

The Commit API answered with an error.

UnsupportedContract

The Commit API answered with a contract this client does not speak.

Fields

served: String

The X-Commit-API-Version the API answered with.

ResponseTooLarge

The response body was larger than 8 MiB, so it was not read.

Decode(Error)

The response body was not the JSON this client expects.

Accounts(Error)

Silicon Accounts refused or failed a sign-in step (device code, short-lived token, refresh or revocation). The inner error carries the code, a precise message and a hint.

Implementations

impl Error

pub fn code(&self) -> &str

Stable machine-readable code: the API’s error.code, the Silicon Accounts code (invalid_grant, access_denied, expired_token, …), or a client-side code.

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

HTTP status of the failed response, if there was one.

pub fn request_id(&self) -> Option<&str>

The request id of the failed response, if any (quote it when reporting a bug).

pub fn hint(&self) -> Option<String>

What to do next, when known.

pub fn as_api(&self) -> Option<&ApiError>

The API error envelope, when this is an API error.

pub fn is_unauthenticated(&self) -> bool

True when the Commit API refused the credential (HTTP 401): refresh the access token (or sign in again) and retry.

pub fn is_sign_in_refused(&self) -> bool

True when Silicon Accounts refused a refresh token or short-lived token for good (invalid_grant): the sign-in ended or the token cannot be used, so sign in again.

pub fn is_transient(&self) -> bool

True when nobody answered or the answer was a temporary failure (5xx, 429): the request may or may not have been applied.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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<ApiError> for Error

fn from(value: ApiError) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.