Struct CliError 

pub struct CliError {
    pub message: String,
    pub code: u8,
}

A failure: printed as {"error": message, "code": code} on stderr (or <tool>: <message> with --text), and code is the exit status.

Fields

message: String

code: u8

Implementations

impl CliError

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

The operation failed (exit 1).

pub fn usage(message: impl Into<String>) -> CliError

The command line was wrong (exit 2).

pub fn not_implemented(what: impl Into<String>) -> CliError

The verb exists and this driver cannot do it yet (exit 3). The message starts not implemented, which scripts may match on.

pub fn refused(message: impl Into<String>) -> CliError

The verb exists and the format cannot do it (exit 3).

pub fn with_code(self, code: u8) -> CliError

A failure with a tool-specific status (fsck’s 8).

pub fn to_json(&self) -> Json

The JSON form.

Trait Implementations

impl Clone for CliError

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CliError

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

Formats the value using the given formatter.

impl Eq for CliError

impl PartialEq for CliError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CliError