Enum Error 

#[non_exhaustive]
pub enum Error {
    BrokenPipe(Error),
    Io(Error),
}

Why writing failed.

A closed pipe is its own variant because it is not a failure of the program. A reader such as head that has read enough closes the stream, and the caller usually exits quietly. This crate does not choose the exit code.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

BrokenPipe(Error)

The reader closed the stream before the output was written.

Io(Error)

Any other write or flush failure.

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

Formats the value using the given formatter.

impl Error for Error

fn source(&self) -> Option<&(dyn StdError + '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(error: Error) -> Self

Sorts a closed pipe from every other failure.

impl From<Error> for Error

fn from(error: Error) -> Self

Error::Io gives back the error it holds, with its message. Error::BrokenPipe always converts to an error of io::ErrorKind::BrokenPipe. When the error it holds already reports BrokenPipe, as every one From<io::Error> builds does, it gives that error back, so the OS error code survives. Otherwise it gives a new BrokenPipe error.

Nothing is boxed, so a caller that returns io::Result keeps a closed pipe apart without carrying this type’s formatting code.