Struct SanthErrorBuilder 

pub struct SanthErrorBuilder<State = NoFix> { /* private fields */ }

Builder for SanthError.

Uses a typestate pattern to enforce at compile time that .fix() is called before .build().

Implementations

impl<State> SanthErrorBuilder<State>

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.

impl SanthErrorBuilder<NoFix>

pub fn fix(self, fix: impl Into<String>) -> SanthErrorBuilder<HasFix>

Provide the mandatory fix hint.

Transitions the builder to the HasFix state, allowing .build() to be called.

impl SanthErrorBuilder<HasFix>

pub fn build(self) -> SanthError

Build the SanthError.

A fix hint that does not already start with "Fix: " is normalised by prefixing it, so the built error always upholds the "Fix: " contract. This never panics.

Trait Implementations

impl<State: Debug> Debug for SanthErrorBuilder<State>

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

Formats the value using the given formatter.