Skip to main content

CliError

Enum CliError 

Source
pub enum CliError {
    Usage(String),
    ReadInput {
        label: String,
        kind: ErrorKind,
    },
    WriteOutput {
        label: String,
        kind: ErrorKind,
    },
    Codec(Error),
    Format(String),
    RawConfig(String),
}
Expand description

A command-line failure, carrying enough context for a helpful message and a meaningful process exit code.

Variants§

§

Usage(String)

The arguments were used incorrectly (exit code 2, matching clap).

§

ReadInput

The input could not be read (exit code 3).

Fields

§label: String

The source label (a path, or <stdin>).

§kind: ErrorKind

The underlying I/O error kind.

§

WriteOutput

The output could not be written (exit code 4).

Fields

§label: String

The sink label (a path, or <stdout>).

§kind: ErrorKind

The underlying I/O error kind.

§

Codec(Error)

The codec rejected the input or output (exit code 5–8, by variant).

§

Format(String)

An input image format (PNG/PPM) could not be parsed (exit code 9).

§

RawConfig(String)

Raw-pixel input was misconfigured, e.g. missing dimensions (exit code 8).

Implementations§

Source§

impl CliError

Source

pub fn read_input(label: String, err: &Error) -> Self

Build a CliError::ReadInput from a labeled I/O error.

Source

pub fn write_output(label: String, err: &Error) -> Self

Build a CliError::WriteOutput from a labeled I/O error.

Source

pub fn exit_code(&self) -> ExitCode

The process exit code for this failure.

Codes are meaningful and stable: 2 usage, 3 input I/O, 4 output I/O, 5 decode/bitstream, 6 unsupported feature, 7 limit exceeded, 8 invalid image or raw config, 9 input-format parse.

Trait Implementations§

Source§

impl Debug for CliError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for CliError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Error for CliError

1.30.0 · Source§

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

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

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. Read more
Source§

impl From<Error> for CliError

Source§

fn from(err: CodecError) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.