Enum Error 

#[non_exhaustive]
pub enum Error {
    Sink(SinkError),
    ChainBroken,
    Capacity,
    NonMonotonicClock,
    HashMismatch(RecordId),
    LinkMismatch(RecordId),
    IdMismatch(RecordId),
    Truncated,
    InvalidFormat,
    Io,
}

Error categories produced by audit-trail.

Variants are intentionally coarse-grained. Concrete backends communicate finer-grained failures via SinkError wrapped inside Error::Sink.

Example

use audit_trail::Error;

let err = Error::ChainBroken;
assert_eq!(err.to_string(), "audit hash chain broken");

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.

Sink(SinkError)

A configured sink failed to persist a record.

ChainBroken

The running hash chain failed a generic integrity check.

Verification surfaces more specific variants (Error::HashMismatch, Error::LinkMismatch, Error::IdMismatch) when possible.

Capacity

A fixed-size buffer or counter exceeded its capacity (for example, the record id counter overflowed).

NonMonotonicClock

The configured clock returned a timestamp that violates monotonicity.

HashMismatch(RecordId)

A record’s stored hash does not match the digest recomputed from its fields. Carries the failing record’s id.

LinkMismatch(RecordId)

A record’s prev_hash does not equal the previous record’s hash. Carries the failing record’s id.

IdMismatch(RecordId)

A record’s id is not the expected next id in the chain. Carries the id that was found.

Truncated

Input ended before a complete record could be decoded.

InvalidFormat

Encoded bytes are present but do not parse as a valid record (bad magic, bad version, invalid UTF-8, length-prefix mismatch, …).

Io

Underlying I/O failure (only emitted by std-gated readers/sinks). Detail is suppressed to keep Error both Copy and no_std-safe; callers needing the full std::io::Error should use the constructor methods that return std::io::Result directly.

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

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

Available on crate feature std only.

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

fn from(value: SinkError) -> Self

Converts to this type from the input type.

impl PartialEq for Error

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Error

impl Eq for Error

impl StructuralPartialEq for Error