Struct ProgrammaticError 

pub struct ProgrammaticError {
    pub message: String,
    pub exit_code: u8,
    pub code: Option<String>,
    pub help: Option<String>,
    pub context: Option<String>,
}

Structured error surface for the programmatic API.

Fields

message: String

Human-readable description; also the Display output.

exit_code: u8

Process exit code the CLI maps this failure to.

code: Option<String>

Stable machine-readable code such as FALLOW_INVALID_COVERAGE_PATH.

help: Option<String>

Optional remediation hint for the caller.

context: Option<String>

Dotted path of the offending input, such as health.coverage.

Implementations

impl ProgrammaticError

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

Create an error from the required message and exit code, with all optional fields left empty.

pub fn with_help(self, help: impl Into<String>) -> Self

Attach a remediation hint shown to the caller alongside the message.

pub fn with_code(self, code: impl Into<String>) -> Self

Attach a stable machine-readable code such as FALLOW_INVALID_COVERAGE_PATH.

pub fn with_context(self, context: impl Into<String>) -> Self

Attach the dotted path of the offending input, such as health.coverage.

Trait Implementations

impl Clone for ProgrammaticError

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ProgrammaticError

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

Formats the value using the given formatter.

impl Display for ProgrammaticError

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

Formats the value using the given formatter.

impl Error for ProgrammaticError

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 Serialize for ProgrammaticError

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.