Enum Error 

pub enum Error {
    Io {
        path: PathBuf,
        source: Error,
    },
    Stdio(Error),
    Unsupported(String),
    Corrupt(String),
    Encoding(String),
    Usage(String),
    Plugin {
        name: String,
        message: String,
    },
}

Variants

Io

Fields

path: PathBuf

source: Error

Stdio(Error)

Unsupported(String)

Corrupt(String)

Encoding(String)

Usage(String)

Plugin

Fields

name: String

message: String

Implementations

impl Error

pub fn exit_code(&self) -> i32

The associated exit code. The single place where this is decided, so the CLI does not end up with duplicated match arms that drift apart.

pub fn is_broken_pipe(&self) -> bool

true when the error is simply “the consumer closed the pipe”.

That is not a failure: termdoc doc.md | head -5 must finish silently.

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, __formatter: &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<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.