Struct CliError 

pub struct CliError {
    pub message: String,
    pub hint: Option<String>,
    pub exit_code: i32,
}

A user-facing CLI error: a message, an optional help: hint, and the exit code the process should terminate with.

The largo binary downcasts Box<dyn Error> values to this type and renders them as:

error: <message>
help: <hint>

Fields

message: String

The primary error message (rendered after error:).

hint: Option<String>

An optional actionable hint (rendered after help:).

exit_code: i32

The process exit code to terminate with.

Implementations

impl CliError

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

Create an error with the default failure exit code and no hint.

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

Create an error carrying an actionable help: hint.

pub fn exit_code(self, code: i32) -> Self

Override the exit code (builder style).

Trait Implementations

impl Debug for CliError

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

Formats the value using the given formatter.

impl Display for CliError

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

Formats the value using the given formatter.

impl Error for CliError

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.