Enum SinkError 

#[non_exhaustive]
pub enum SinkError {
    Io,
    Capacity,
    Closed,
    Other,
}

Opaque error returned by crate::Sink implementations.

Backends map their internal failures to one of a small set of categories. Categories are deliberately coarse: callers either retry the write or surface the audit failure upstream.

Example

use audit_trail::SinkError;

let err = SinkError::Io;
assert_eq!(err.to_string(), "sink i/o failure");

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.

Io

Underlying I/O failure (disk, socket, etc.).

Capacity

Sink has reached its capacity and cannot accept more records.

Closed

Sink has been closed and will accept no further writes.

Other

Sink-specific failure not covered by the other variants.

Trait Implementations

impl Clone for SinkError

fn clone(&self) -> SinkError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SinkError

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

Formats the value using the given formatter.

impl Display for SinkError

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

Formats the value using the given formatter.

impl Error for SinkError

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 SinkError

fn eq(&self, other: &SinkError) -> 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 SinkError

impl Eq for SinkError

impl StructuralPartialEq for SinkError