Enum Error 

pub enum Error {
    CorruptHeader,
    UnsupportedFormatVersion {
        artifact: ArtifactKind,
        found: u32,
        supported: u32,
    },
    CorruptRecord,
    CorruptVaultRecord(String),
    InvalidKey,
    NotFound(String),
    AlreadyExists(String),
    InvalidPath(String),
    InvalidInput(String),
    InvalidKeyMaterial(String),
    InvalidOperation(String),
    VaultUnavailable(String),
    LockUnavailable(String),
    Configuration(String),
    UnsupportedHostPath(String),
    Io(String),
    SecurityLimitExceeded(String),
    Truncated,
}

Error type returned by lockbox operations.

Variants

CorruptHeader

The public header could not be parsed or authenticated.

UnsupportedFormatVersion

A valid artifact uses a native format this build cannot read.

Fields

artifact: ArtifactKind

found: u32

supported: u32

CorruptRecord

An encrypted record or decoded page failed validation.

CorruptVaultRecord(String)

Stored vault metadata failed validation.

InvalidKey

The supplied key was wrong or authentication failed.

NotFound(String)

A requested logical path was not found.

AlreadyExists(String)

A caller tried to add an entry where one already exists.

InvalidPath(String)

A caller supplied an invalid logical or host path.

InvalidInput(String)

A caller supplied invalid non-path input.

InvalidKeyMaterial(String)

Key bytes, key text, or a key file could not be decoded as the expected key type.

InvalidOperation(String)

The requested operation conflicts with the current lockbox state.

VaultUnavailable(String)

A vault-backed operation could not use the local vault or open cache.

LockUnavailable(String)

A lockbox or vault write lock could not be acquired.

Configuration(String)

A required host or process configuration value is missing or invalid.

UnsupportedHostPath(String)

A host filesystem path cannot be imported by the requested operation.

Io(String)

Filesystem or platform IO failed.

SecurityLimitExceeded(String)

A configured safety limit rejected the operation.

Truncated

The input ended before a complete lockbox structure could be read.

Implementations

impl Error

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

Return user-facing recovery guidance for this error.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

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<(), Error>

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Eq for Error

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

fn from(err: Error) -> Error

Converts to this type from the input type.

impl PartialEq for Error

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Error