Struct uucore::error::ClapErrorWrapper

pub struct ClapErrorWrapper { /* private fields */ }

A wrapper for clap::Error that implements UError

Contains a custom error code. When Display::fmt is called on this struct the [clap::Error] will be printed directly to stdout or stderr. This is because clap only supports colored output when it prints directly.

ClapErrorWrapper is generally created by calling the UClapError::with_exit_code method on [clap::Error] or using the From implementation from [clap::Error] to Box<dyn UError>, which constructs a ClapErrorWrapper with an exit code of 1.

use uucore::error::{ClapErrorWrapper, UError, UClapError};
let command = clap::Command::new("test");
let result: Result<_, ClapErrorWrapper> = command.try_get_matches().with_exit_code(125);

let command = clap::Command::new("test");
let result: Result<_, Box<dyn UError>> = command.try_get_matches().map_err(Into::into);

Trait Implementations

impl Debug for ClapErrorWrapper

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

Formats the value using the given formatter.

impl Display for ClapErrorWrapper

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

Formats the value using the given formatter.

impl Error for ClapErrorWrapper

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

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, demand: &mut Demand<'a>)

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

Provides type based access to context intended for error reports.

impl UClapError<ClapErrorWrapper> for Error

fn with_exit_code(self, code: i32) -> ClapErrorWrapper

impl UError for ClapErrorWrapper

fn code(&self) -> i32

Error code of a custom error.

fn usage(&self) -> bool

Print usage help to a custom error.