Struct uucore::error::UIoError

pub struct UIoError { /* private fields */ }

Wrapper type around std::io::Error.

The messages displayed by UIoError should match the error messages displayed by GNU coreutils.

There are two ways to construct this type: with UIoError::new or by calling the FromIo::map_err_context method on a std::io::Result or std::io::Error.

use uucore::{
    display::Quotable,
    error::{FromIo, UResult, UIoError, UError}
};
use std::fs::File;
use std::path::Path;
let path = Path::new("test.txt");

// Manual construction
let e: Box<dyn UError> = UIoError::new(
    std::io::ErrorKind::NotFound,
    format!("cannot access {}", path.quote())
);
let res: UResult<()> = Err(e.into());

// Converting from an `std::io::Error`.
let res: UResult<File> = File::open(path).map_err_context(|| format!("cannot access {}", path.quote()));

Implementations

impl UIoError

pub fn new<S: Into<String>>(kind: ErrorKind, context: S) -> Box<dyn UError>

Trait Implementations

impl Debug for UIoError

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

Formats the value using the given formatter.

impl Display for UIoError

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

Formats the value using the given formatter.

impl Error for UIoError

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

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 self, req: &mut Demand<'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 UIoError

fn from(f: Error) -> Self

Converts to this type from the input type.

impl UError for UIoError

fn code(&self) -> i32

Error code of a custom error.

fn usage(&self) -> bool

Print usage help to a custom error.