Struct SaddleError 

pub struct SaddleError { /* private fields */ }

An error safe to propagate across Saddle component boundaries.

message must not contain credentials, SQL parameters, request payloads or other sensitive implementation details.

Implementations

impl SaddleError

pub fn new( kind: ErrorKind, code: &'static str, message: impl Into<String>, ) -> Self

pub const fn kind(&self) -> ErrorKind

pub const fn code(&self) -> &'static str

pub fn message(&self) -> &str

pub fn with_diagnostic(self, diagnostic: Diagnostic) -> Self

pub fn diagnostic(&self) -> Option<&Diagnostic>

pub fn with_source_receipt<T: Any + Send + Sync>(self, receipt: T) -> Self

Carry the writer’s concrete receipt across a component boundary. This slot alone does not claim that the original source was written.

pub fn source_receipt<T: Any + Send + Sync>(&self) -> Option<&T>

pub fn with_unconfirmed_original( self, original: Box<dyn Error + Send + Sync>, ) -> Self

Retain an original whose controlled write was not confirmed. This is negative evidence and cannot be consumed as a source receipt.

pub fn unconfirmed_original(&self) -> Option<&(dyn Error + Send + Sync)>

pub fn take_unconfirmed_original( &mut self, ) -> Option<Box<dyn Error + Send + Sync>>

pub fn with_cleanup_source_record<T: Any + Send + Sync>( self, diagnostic: Diagnostic, receipt: T, ) -> Self

Keep an independent cleanup occurrence alongside the unchanged primary. Only the concrete writer receipt can establish that its original was written.

pub fn cleanup_diagnostic(&self) -> Option<&Diagnostic>

pub fn cleanup_source_receipt<T: Any + Send + Sync>(&self) -> Option<&T>

pub fn with_unconfirmed_cleanup_diagnostic(self, diagnostic: Diagnostic) -> Self

Retain the independent cleanup occurrence when its original write was unavailable. No receipt is attached to this negative fact.

pub fn with_unconfirmed_source(self) -> Self

The primary error’s original source record could not be confirmed.

pub const fn source_unavailable(&self) -> bool

pub fn with_unconfirmed_cleanup_source(self) -> Self

A separate cleanup failure could not obtain a written source record. This negative fact never claims the primary or cleanup was recorded.

pub const fn cleanup_source_unavailable(&self) -> bool

pub fn during_cleanup_of(self, primary: &Self) -> Self

Preserve this cleanup occurrence and link it to the independent primary.

pub fn during_cleanup_of_occurrence( self, primary: &DiagnosticOccurrence, ) -> Self

Link a later cleanup failure to a captured primary occurrence.

pub fn wrap_diagnostic(self, cause: DiagnosticCause) -> Self

Propagate existing diagnosis without changing its origin or error semantics. An uninstrumented upstream error remains uninstrumented, never fabricated.

Trait Implementations

impl Debug for SaddleError

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

Formats the value using the given formatter.

impl Display for SaddleError

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

Formats the value using the given formatter.

impl Error for SaddleError

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.