Enum AppError 

pub enum AppError {
    Usage(String),
    Violations {
        count: usize,
    },
    ManifestMissing(Utf8PathBuf),
    ManifestInvalid(String),
    Marker(MarkerError),
    Debt(DebtError),
    Refused(String),
    Git {
        message: String,
        code: u8,
    },
    Io(Error),
    Other(Error),
}

Every failure the binary can exit with.

Variants

Usage(String)

Semantically invalid arguments clap cannot reject on shape alone.

Violations

A check ran to completion and found violations; the findings are already on stdout, so the process only carries the red exit.

Fields

count: usize

How many findings were reported.

ManifestMissing(Utf8PathBuf)

The target has no instance manifest where one is required.

ManifestInvalid(String)

The manifest exists but does not parse as a supported schema.

Marker(MarkerError)

The managed pre-commit block or its host file is malformed.

Debt(DebtError)

The instance’s debt file cannot be trusted, or a debt verb was asked for a state it refuses.

Refused(String)

The install or upgrade refused to touch the target as found, and the target was left (or restored) unchanged.

Git

A tracked-upstream lookup failed. The code is the sysexit the failure class maps to, chosen where the git adapter is called.

Fields

message: String

The redacted failure reason.

code: u8

The sysexit code for this failure class.

Io(Error)

Filesystem failure, classified by its I/O kind.

Other(Error)

Escape hatch for ad-hoc contexts at the binary boundary.

Implementations

impl AppError

pub fn exit_code(&self) -> u8

Map to the process exit code.

1 means a completed check found violations; 64..=78 follow BSD sysexits(3) and mean the tool itself could not do its job.

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

Stable machine-readable kind for the error envelope.

Trait Implementations

impl Debug for AppError

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

Formats the value using the given formatter.

impl Display for AppError

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

Formats the value using the given formatter.

impl Error for AppError

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<DebtError> for AppError

fn from(source: DebtError) -> Self

Converts to this type from the input type.

impl From<Error> for AppError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for AppError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<GateError> for AppError

fn from(error: GateError) -> Self

Converts to this type from the input type.

impl From<MarkerError> for AppError

fn from(source: MarkerError) -> Self

Converts to this type from the input type.