Struct parkour::Error

pub struct Error { /* fields omitted */ }

The error type when parsing command-line arguments. You can create an Error by creating an ErrorInner and converting it with .into().

This error type supports an error source for attaching context to the error.

Implementations

impl Error

pub fn with_source(self, source: impl Error + Sync + Send + 'static) -> Self

Attach context to the error.

Usage

use parkour::{Error, util::Flag};

Error::missing_value()
    .with_source(Error::in_subcommand("test"))

This could produce the following output:

missing value
    source: in subcommand `test`

pub fn no_value() -> Self

Create a NoValue error

pub fn is_no_value(&self) -> bool

Returns true if this is a NoValue error

pub fn missing_value() -> Self

Create a MissingValue error

pub fn is_missing_value(&self) -> bool

Returns true if this is a MissingValue error

pub fn early_exit() -> Self

Create a EarlyExit error

pub fn is_early_exit(&self) -> bool

Returns true if this is a EarlyExit error

pub fn unexpected_value(got: impl ToString, expected: impl ToString) -> Self

Create a UnexpectedValue error

pub fn missing_argument(arg: impl ToString) -> Self

Create a MissingArgument error

pub fn in_argument(flag: &Flag<'_>) -> Self

Create a InArgument error

pub fn in_subcommand(cmd: impl ToString) -> Self

Create a InSubcommand error

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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

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

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

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

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

pub fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

pub fn cause(&self) -> Option<&dyn Error>

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl From<ErrorInner> for Error

fn from(inner: ErrorInner) -> Self

Performs the conversion.

impl From<ParseFloatError> for Error

fn from(e: ParseFloatError) -> Self

Performs the conversion.

impl From<ParseIntError> for Error

fn from(e: ParseIntError) -> Self

Performs the conversion.