Struct Error

pub struct Error { /* private fields */ }

An error in a command-line operation.

Implementations

impl Error

pub fn new<E: Into<Box<dyn Error + Sync + Send>>>( kind: ErrorKind, error: E, ) -> Self

Constructs a new Error with the specified ErrorKind and extended error information.

Example

use clapi::{Error, ErrorKind};

let error = Error::new(ErrorKind::InvalidArgumentCount, "expect 1 or more arguments");
assert!(matches!(error.kind(), ErrorKind::InvalidArgumentCount));

pub fn kind(&self) -> &ErrorKind

Returns the ErrorKind of this error.

pub fn with_message<S: Into<Box<dyn Error + Sync + Send>>>( &self, msg: S, ) -> Self

Returns this error with the given message.

Example

use clapi::{Error, ErrorKind};

let error = Error::from(ErrorKind::InvalidArgument("xyz".to_string()));
let new_error = error.with_message("expected a number");
assert_eq!(new_error.to_string(), "invalid value for argument 'xyz': expected a number".to_string())

pub fn exit(self) -> !

Prints this error in the stderr and exit this process with status 0.

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)>

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<ErrorKind> for Error

fn from(kind: ErrorKind) -> Self

Converts to this type from the input type.