Struct SanthError 

pub struct SanthError { /* private fields */ }

The shared error type for the Santh ecosystem.

Every error carries:

• A stable error code.
• A human-readable title.
• A mandatory fix hint starting with "Fix: ".
• Optional diagnostic context.
• An optional source error chain.
• An optional location in source or configuration.

Implementations

impl SanthError

pub fn new( code: &'static str, title: impl Into<String>, ) -> SanthErrorBuilder<NoFix>

Start building a new SanthError.

The returned builder enforces at compile time that .fix() is called before .build().

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

Returns the stable error code, e.g. "KEYHOG-E001".

pub fn title(&self) -> &str

Returns the one-line title.

pub fn fix_hint(&self) -> &str

Returns the fix hint (including the "Fix: " prefix).

pub fn actionable_message(&self) -> String

Returns an actionable, human-readable message with all diagnostic details.

Secrets are redacted from the output. The source chain is included so that causal information is never lost.

Delegates to [compose_message], the single formatter shared with the default SanthErrorContract::actionable_message, so the canonical type and any domain error enum that implements the contract render byte-identically.

pub fn with_context( self, key: impl Into<Cow<'static, str>>, value: impl Display, ) -> Self

Add a key-value diagnostic context entry.

pub fn with_source(self, source: impl Error + Send + Sync + 'static) -> Self

Attach a source error to the cause chain.

pub fn with_location(self, location: ErrorLocation) -> Self

Attach a location to the error.

Trait Implementations

impl Debug for SanthError

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

Formats the value using the given formatter.

impl Display for SanthError

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

Formats the value using the given formatter.

impl Eq for SanthError

impl Error for SanthError

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

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for SanthError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for SanthError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<FromUtf8Error> for SanthError

fn from(err: FromUtf8Error) -> Self

Converts to this type from the input type.

impl PartialEq for SanthError

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

Equality operator ==.

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

Inequality operator !=.

impl SanthErrorContract for SanthError

fn error_code(&self) -> &'static str

Stable, machine-readable error code, e.g. "KEYHOG-E001".

fn fix_hint(&self) -> Cow<'_, str>

The actionable fix hint. Must start with "Fix: ".

fn title(&self) -> Cow<'_, str>

One-line human-readable title. Defaults to the Display output, which is correct for thiserror-style enums whose Display is the short message.

fn context(&self) -> Vec<(Cow<'static, str>, String)>

Key-value diagnostic context. Empty by default.

fn location(&self) -> Option<&ErrorLocation>

Optional source or configuration location. None by default.

fn actionable_message(&self) -> String

Actionable, human-readable message: title, fix, context, location, and the source chain, with secrets redacted. The default matches SanthError exactly; override only for a custom layout.