Enum argyle::ArgyleError

pub enum ArgyleError {
    Custom(&'static str),
    Empty,
    NoArg,
    NoSubCmd,
    Passthru(i32),
    TooManyArgs,
    TooManyKeys,
    WantsDynamicHelp(Option<Box<[u8]>>),
    WantsHelp,
    WantsVersion,
}

Error Struct.

Variants

Custom(&'static str)

Tuple Fields

0: &'static str

A custom error.

Empty

Missing anything/everything.

NoArg

No trailing args.

NoSubCmd

Expected subcommand.

Passthru(i32)

Tuple Fields

0: i32

Miscellaneous Silent Failure.

This has no corresponding error text, but does have its own exit code.

TooManyArgs

Too many arguments.

TooManyKeys

Too many options defined.

WantsDynamicHelp(Option<Box<[u8]>>)

Tuple Fields

0: Option<Box<[u8]>>

Wants subcommand help.

WantsHelp

Wants help.

WantsVersion

Wants version.

Implementations

impl ArgyleError

pub const fn exit_code(&self) -> i32

Exit code.

This returns the exit code for the error. Non-error errors like help and version have a non-error exit code of 0. ArgyleError::Passthru returns whatever code was defined, while everything else just returns 1.

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

As Str.

Return as a string slice.

Trait Implementations

impl AsRef<str> for ArgyleError

fn as_ref(&self) -> &str

Performs the conversion.

impl Clone for ArgyleError

fn clone(&self) -> ArgyleError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ArgyleError

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

Formats the value using the given formatter.

impl Display for ArgyleError

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

Formats the value using the given formatter.

impl Error for ArgyleError

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred.

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

impl PartialEq<ArgyleError> for ArgyleError

fn eq(&self, other: &ArgyleError) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ArgyleError) -> bool

This method tests for !=.

impl Eq for ArgyleError

impl StructuralEq for ArgyleError

impl StructuralPartialEq for ArgyleError