Skip to main content

Error

Enum Error 

Source
pub enum Error {
    Encrypt(EncryptError),
    Decrypt(DecryptError),
}
Expand description

The universal error type for this crate.

This enum represents every possible error that a function in this library can return. It is a thin wrapper around the domain‑specific error types:

The #[from] attribute generates From<EncryptError> and From<DecryptError> implementations, so conversions are automatic (see module documentation for details). This keeps the public API clean – all functions return a single error type, yet callers can still inspect the underlying cause.

§Display format

Each variant prefixes the error message with the domain:

Encrypt error: Invalid recipient 'abc': reason
Decrypt error: Invalid identity: something

§Example of error propagation with ?

use age_crypto::{encrypt_with_passphrase, Error};

fn safe_encrypt(plaintext: &[u8], passphrase: &str) -> Result<Vec<u8>, Error> {
    // encrypt_with_passphrase already returns Result<_, Error>
    // so we can use `?` directly for propagation
    let encrypted = encrypt_with_passphrase(plaintext, passphrase)?;
    Ok(encrypted.as_bytes().to_vec())
}

Variants§

§

Encrypt(EncryptError)

An encryption‑related error occurred.

The inner EncryptError provides detailed information about missing recipients, invalid keys, or internal failures.

§

Decrypt(DecryptError)

A decryption‑related error occurred.

The inner DecryptError provides detailed information about invalid identities, broken ciphertext, or decryption mismatches.

Trait Implementations§

Source§

impl Debug for Error

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for Error

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Error for Error

Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

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. Read more
Source§

impl From<DecryptError> for Error

Source§

fn from(source: DecryptError) -> Self

Converts to this type from the input type.
Source§

impl From<EncryptError> for Error

Source§

fn from(source: EncryptError) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl Freeze for Error

§

impl !RefUnwindSafe for Error

§

impl Send for Error

§

impl Sync for Error

§

impl Unpin for Error

§

impl UnsafeUnpin for Error

§

impl !UnwindSafe for Error

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V