Enum pathrs::error::Error

pub enum Error {
    NotImplemented {
        feature: String,
        backtrace: Backtrace,
    },
    NotSupported {
        feature: String,
        backtrace: Backtrace,
    },
    InvalidArgument {
        name: String,
        description: String,
        backtrace: Backtrace,
    },
    SafetyViolation {
        description: String,
        backtrace: Backtrace,
    },
    OsError {
        operation: String,
        source: IOError,
        backtrace: Backtrace,
    },
    RawOsError {
        operation: String,
        source: SyscallError,
    },
    Wrapped {
        context: String,
        source: Box<Error>,
    },
}

The primary error type returned by libpathrs.

All public interfaces of libpathrs will return this error in Results. In order to enable or disable backtrace-generation for libpathrs Errors, modify BACKTRACES_ENABLED.

Caveats

Until Error::chain is stabilised, it will be necessary for callers to manually implement their own version of this feature.

Variants

NotImplemented

The requested feature is not yet implemented.

Fields of NotImplemented

feature: String

Feature which is not implemented.

backtrace: Backtrace

Backtrace captured at time of error.

NotSupported

The requested feature is not supported by this kernel.

Fields of NotSupported

feature: String

Feature which is not supported.

backtrace: Backtrace

Backtrace captured at time of error.

InvalidArgument

One of the provided arguments in invalid.

Fields of InvalidArgument

name: String

Name of the invalid argument.

description: String

Description of what makes the argument invalid.

backtrace: Backtrace

Backtrace captured at time of error.

SafetyViolation

libpathrs has detected some form of safety requirement violation. This might be an attempted breakout by an attacker or even a bug internal to libpathrs.

Fields of SafetyViolation

description: String

Description of safety requirement which was violated.

backtrace: Backtrace

Backtrace captured at time of error.

OsError

The requested libpathrs operation resulted in an IOError. This should be contrasted with RawOsError -- which indicates an error triggered by one of libpathrs's syscall wrappers.

Fields of OsError

operation: String

Operation which was being attempted.

source: IOError

Underlying error.

backtrace: Backtrace

Backtrace captured at time of error.

RawOsError

The requested libpathrs operation resulted in a SyscallError by one of libpathrs's syscall wrappers. This should be contrasted with OsError -- which indicates an error triggered by a Rust stdlib function.

Fields of RawOsError

operation: String

Operation which was being attempted.

source: SyscallError

Underlying syscall wrapper error.

Wrapped

Wrapped represents an Error which has some simple string-wrapping information. This is used to allow for some additional context to be added at call-sites.

Fields of Wrapped

context: String

Additional context information about the contained error.

source: Box<Error>

Underlying wrapped error.

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, __snafu_display_formatter: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Error for Error where
    Self: Debug + Display, 

fn description(&self) -> &str

Deprecated since 1.41.0:

use the Display impl or to_string()

if let Err(e) = "xc".parse::<u32>() { // Print e itself, no need for description(). eprintln!("Error: {}", e); }

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

Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

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

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

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

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

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

impl ErrorCompat for Error

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

Returns a Backtrace that may be printed.