Enum CliError 

pub enum CliError {
    InvalidHandler(String),
    Failed,
    FailedWithMessage(String),
    FailedWithMessageAndCode(String, u8),
    ClapError(Error),
    InputString,
    Other(Error),
    OtherWithCode(Error, u8),
}

An error type for the CLI application.

This error type handles exit codes, pretty printing of error messages, and include some handy utilities.

Variants

InvalidHandler(String)

Failed

FailedWithMessage(String)

FailedWithMessageAndCode(String, u8)

ClapError(Error)

InputString

Other(Error)

OtherWithCode(Error, u8)

Implementations

impl CliError

pub fn print(&self) -> Result<()>

Pretty print the error to stderr.

pub fn exit_code(&self) -> u8

What is the exit code for this error?

pub fn exit(self) -> !

Terminate the program with this error’s exit code.

pub fn into_finished<T: Run + Parser>(self) -> ClingFinished<T>

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.

impl<T: Run + Parser> From<CliError> for ClingFinished<T>

Convert a CliError into a ClingFinished.

fn from(value: CliError) -> Self

Converts to this type from the input type.

impl From<Error> for CliError

A helper to allow anyhow users from returning anyhow::Error errors in cling handlers without writing an [Into<CliError>] implementation for every error type.

fn from(value: Error) -> Self

Converts to this type from the input type.

impl From<Error> for CliError

fn from(value: Error) -> Self

Converts to this type from the input type.

impl From<Error> for CliError

fn from(value: Error) -> Self

Converts to this type from the input type.