Struct CliError 

pub struct CliError {
    pub source: Option<Box<dyn Error>>,
    pub kind: CliErrorKind,
}

An error that occurred during command line parsing or argument processing.

This error type provides detailed information about what went wrong during command line parsing, including helpful error messages for users.

Fields

source: Option<Box<dyn Error>>

The underlying error that caused this error (if any)

kind: CliErrorKind

The specific kind of error that occurred

Implementations

impl CliError

pub fn new_inner(source: Box<dyn Error>) -> Self

Creates a new CliError with an underlying source error.

This is typically used when an error occurs during type conversion or other internal operations.

Arguments

• source - The underlying error that caused this error

Returns

A new CliError with kind set to Inner and the provided source error.

pub fn new_kind(kind: CliErrorKind) -> Self

Creates a new CliError with a specific error kind.

This is typically used for command line parsing errors that don’t have an underlying source error.

Arguments

• kind - The specific kind of error that occurred

Returns

A new CliError with the provided kind and no source error.

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 From<AddrParseError> for CliError

fn from(error: AddrParseError) -> Self

Converts to this type from the input type.

impl From<Box<dyn Error>> for CliError

fn from(error: Box<dyn Error>) -> Self

Converts to this type from the input type.

impl From<CliErrorKind> for CliError

fn from(kind: CliErrorKind) -> Self

Converts to this type from the input type.

impl From<Error> for CliError

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<Infallible> for CliError

fn from(error: ParseError) -> Self

Converts to this type from the input type.

impl From<ParseBoolError> for CliError

fn from(error: ParseBoolError) -> Self

Converts to this type from the input type.

impl From<ParseCharError> for CliError

fn from(error: ParseCharError) -> Self

Converts to this type from the input type.

impl From<ParseFloatError> for CliError

fn from(error: ParseFloatError) -> Self

Converts to this type from the input type.

impl From<ParseIntError> for CliError

fn from(error: ParseIntError) -> Self

Converts to this type from the input type.