Struct TuffError 

pub struct TuffError { /* private fields */ }

One failure, with the kind of thing that went wrong, what happened, and optionally what to do about it.

Implementations

impl TuffError

pub fn of(kind: ErrorKind, message: impl Into<String>) -> Self

Build an error of a given kind. Prefer the per-kind constructors.

pub fn new(message: impl Into<String>) -> Self

An error for an invariant Tuff itself broke.

This is also the landing spot for messages not yet classified during the migration to typed kinds, which is why the lint gate counts its uses outside this module and only lets that count fall.

pub fn usage(message: impl Into<String>) -> Self

pub fn not_found(message: impl Into<String>) -> Self

pub fn refused(message: impl Into<String>) -> Self

pub fn drift(message: impl Into<String>) -> Self

pub fn source_failed(message: impl Into<String>) -> Self

pub fn corrupt(message: impl Into<String>) -> Self

pub fn unsupported(message: impl Into<String>) -> Self

pub fn with_hint(self, hint: impl Into<String>) -> Self

Attach one imperative line telling the user what to do next. Kept separate from the message so --json can carry it as its own field and humans get it on its own line.

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

Attach the underlying error, preserving the cause chain.

pub fn kind(&self) -> ErrorKind

pub fn message(&self) -> &str

pub fn hint(&self) -> Option<&str>

pub fn exit_code(&self) -> i32

Trait Implementations

impl Debug for TuffError

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

Formats the value using the given formatter.

impl Display for TuffError

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

Formats the value using the given formatter.

impl Error for TuffError

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 TuffError

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<Error> for TuffError

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<Error> for TuffError

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<Error> for TuffError

fn from(error: Error) -> Self

Converts to this type from the input type.