Struct path_abs::Error

pub struct Error { /* fields omitted */ }

An error produced by performing an filesystem operation on a Path.

This error type is a light wrapper around std::io::Error. In particular, it adds the following information:

• The action being performed when the error occured
• The path associated with the IO error.

To maintain good ergonomics, this type has a impl From<Error> for std::io::Error defined so that you may use an io::Result with methods in this crate if you don't care about accessing the underlying error data in a structured form (the pretty format will be preserved however).

Examples

use path_abs::Error as PathError;
use path_abs::PathFile;

/// main function, note that you can use `io::Error`
fn try_main() -> Result<(), ::std::io::Error> {
    let lib = PathFile::new("src/lib.rs")?;
    Ok(())
}

Implementations

impl Error

pub fn new(io_err: Error, action: &str, path: Arc<PathBuf>) -> Error

Create a new error when the path and action are known.

impl Error

pub fn path(&self) -> &Path

Returns the path associated with this error.

pub fn io_error(&self) -> &Error

Returns the std::io::Error associated with this errors.

pub fn action(&self) -> &str

Returns the action being performed when this error occured.

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 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

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

The lower-level source of this error, if any.

pub fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred.