Struct CipherError 

pub struct CipherError { /* private fields */ }

Error returned by SegmentCipher implementations.

Deliberately minimal: the cipher operates on bytes, not files, so it has no path or sequence context to carry. The segment I/O layer enriches this into a crate::SegmentError::Cipher with the offending file’s path.

Construct with CipherError::msg for a plain message, or CipherError::with_source when you want to preserve the underlying AEAD (or other) error type for std::error::Error::source() chaining. The fields are private so that adding context later is non-breaking.

Implementations

impl CipherError

pub fn msg(message: impl Display) -> Self

Construct a CipherError from anything displayable, with no underlying cause.

Example

use segment_buffer::CipherError;

let err = CipherError::msg("key not configured");
assert_eq!(err.to_string(), "key not configured");
assert!(std::error::Error::source(&err).is_none());

pub fn with_source<E>(message: impl Display, source: E) -> Self

where E: Error + Send + Sync + 'static,

Construct a CipherError that preserves the underlying error so operators can inspect it via std::error::Error::source.

Use this when wrapping a typed error from an AEAD implementation (aes_gcm::Error, chacha20poly1305::Error, …) so the original failure is not erased behind a format!.

Example

use segment_buffer::CipherError;
use std::fmt;
use std::error::Error;

/// A tiny typed error an AEAD crate might expose.
#[derive(Debug)]
struct AeadError;
impl fmt::Display for AeadError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str("tag mismatch")
    }
}
impl std::error::Error for AeadError {}

let err = CipherError::with_source("AES-GCM decryption failed", AeadError);
assert_eq!(err.to_string(), "AES-GCM decryption failed");
// The underlying cause is preserved via `source()`:
let src = err.source().expect("source should be set by with_source");
assert_eq!(src.to_string(), "tag mismatch");

Trait Implementations

impl Clone for CipherError

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 CipherError

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

Formats the value using the given formatter.

impl Display for CipherError

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

Formats the value using the given formatter.

impl Error for CipherError

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.