Enum CommandError 

pub enum CommandError {
    Reported {
        message: String,
        exit_code: i32,
        hint: Option<String>,
        source: Option<Error>,
    },
    Cancelled,
    Fatal(String),
}

Variants

Reported

Fields

message: String

exit_code: i32

hint: Option<String>

source: Option<Error>

Cancelled

Fatal(String)

Implementations

impl CommandError

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

pub fn cancelled() -> Self

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

pub fn with_hint(self, hint: impl Into<String>) -> Self

pub fn with_exit_code(self, exit_code: i32) -> Self

pub fn with_source(self, source: Option<Error>) -> Self

pub fn as_reported(&self) -> Option<(&str, i32, Option<&str>)>

pub fn exit_code(&self) -> i32

pub fn is_fatal(&self) -> bool

pub fn hint(&self) -> Option<&str>

Trait Implementations

impl Debug for CommandError

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

Formats the value using the given formatter.

impl Display for CommandError

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

Formats the value using the given formatter.

impl Error for CommandError

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<&CommandError> for ExitCode

fn from(err: &CommandError) -> Self

Converts to this type from the input type.

impl From<CommandError> for ExitCode

fn from(err: CommandError) -> Self

Converts to this type from the input type.

impl PartialEq for CommandError

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for CommandError