Enum Error 

#[non_exhaustive]
pub enum Error {
    Invalid {
        code: &'static str,
        message: String,
    },
    Auth {
        code: String,
        message: String,
    },
    Forbidden {
        message: String,
    },
    NotFound {
        message: String,
    },
    VaultNotFound {
        label: String,
        message: String,
    },
    UnknownPath {
        path: String,
        suggestion: Option<String>,
        project_known: bool,
        message: String,
    },
    Conflict {
        name: String,
        expected: Expected,
        current: Option<u64>,
        message: String,
    },
    StaleGeneration {
        label: String,
        message: String,
    },
    Integrity {
        failure: IntegrityFailure,
        message: String,
    },
    Server {
        code: String,
        status: u16,
        message: String,
    },
    Transport {
        server: String,
        message: String,
        source: Arc<dyn Error + Send + Sync>,
    },
    Store {
        message: String,
        source: Arc<StoreError>,
    },
    Other {
        message: String,
    },
}

Every failure this crate returns. Send, Sync and Clone.

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.

Invalid

Refused on this side before any request: a bad argument, file, environment, document or local state. code says which.

Fields

code: &'static str

The stable code.

message: String

The message.

Auth

The token is malformed, unknown, revoked or expired, or its vault expired (unauthorized, token_expired, invalid_token).

Fields

code: String

The stable code.

message: String

The message.

Forbidden

The credential’s scope or allow-list does not permit it.

Fields

message: String

The message.

NotFound

No such record, version or token, or the record was deleted.

Fields

message: String

The message.

VaultNotFound

The server does not know an owner’s vault: it expired, was deleted, or was re-rooted. An expired one can be repaired at the same id.

Fields

label: String

The environment path.

message: String

The message.

UnknownPath

A path that is not in the known tree, refused before any request.

Fields

path: String

The path asked for.

suggestion: Option<String>

The closest known path, if one is plausibly a typo.

project_known: bool

Whether the path’s project is known at all.

message: String

The message.

Conflict

Another writer won; nothing was overwritten.

Fields

name: String

The record name.

expected: Expected

What the write expected.

current: Option<u64>

The server’s latest version, if the record exists.

message: String

The message.

StaleGeneration

The vault was rotated underneath this handle: call crate::Vault::refresh and retry.

Fields

label: String

The vault’s label.

message: String

The message.

Integrity

Something the server served does not verify.

Fields

failure: IntegrityFailure

What failed.

message: String

The message.

Server

Any other refusal by the server, its code kept verbatim, including a code this client does not know (http_<status> when it named none).

Fields

code: String

The stable code.

status: u16

The HTTP status.

message: String

The message.

Transport

The server could not be reached; source() is the I/O or TLS error.

Fields

server: String

The server.

message: String

The message.

source: Arc<dyn Error + Send + Sync>

The underlying cause.

Store

A key store or state store failed; source() is its error.

Fields

message: String

The message.

source: Arc<StoreError>

The store’s error.

Other

Any other failure (code error).

Fields

message: String

The message.

Implementations

impl Error

pub fn code(&self) -> &str

The stable code, the same string Python’s .code reports.

pub fn kind(&self) -> ErrorKind

The kind of failure, from kind_of; for a server code this client does not know, from the HTTP status class (kind_of_status).

pub fn message(&self) -> &str

The whole message.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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, f: &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<InitError> for Error

fn from(e: InitError) -> Error

Converts to this type from the input type.