Struct CliError 

pub struct CliError {
    pub message: String,
    pub kind: CliErrorKind,
}

A command that could not complete, carrying the message to print and the kind that decides the process exit status.

Every failing branch below returns one of these instead of calling std::process::exit where it stands: main.rs is the single place that prints and exits, so each command body stays a plain function a test can call and assert on.

Fields

message: String

The line printed to stderr.

kind: CliErrorKind

What the process exits with.

Implementations

impl CliError

pub fn failed(message: impl Into<String>) -> Self

A Failed error — the host could not carry out the request.

pub fn bad_request(message: impl Into<String>) -> Self

A BadRequest error — the request cannot be satisfied as written.

pub fn kind(&self) -> CliErrorKind

The kind this error carries.

pub fn exit_code(&self) -> u8

The process exit status for this error: 1 for CliErrorKind::Failed, 3 for CliErrorKind::BadRequest. main.rs is the only caller.

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, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for CliError

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<&str> for CliError

fn from(message: &str) -> 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<String> for CliError

fn from(message: String) -> Self

Converts to this type from the input type.

impl PartialEq for CliError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CliError