Enum DetoxError 

#[non_exhaustive]
pub enum DetoxError {
    Io {
        path: PathBuf,
        source: Error,
    },
    Config {
        path: PathBuf,
        message: String,
    },
    Parse {
        path: PathBuf,
        line: usize,
        column: usize,
        message: String,
    },
    Collision {
        path: PathBuf,
        attempts: u32,
    },
    CrossDevice {
        source_path: PathBuf,
        target: PathBuf,
        source_err: Error,
    },
    PathInvalid {
        path: PathBuf,
        reason: String,
    },
}

Error type returned by Detox operations.

Pattern-matchable; carries structured payload (path + source-error where applicable). The #[non_exhaustive] marker allows additive variants in SemVer-minor releases.

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.

Io

Filesystem I/O failure for a specific path.

Fields

path: PathBuf

Path being operated on when the error occurred.

source: Error

Underlying std::io::Error.

Config

Configuration file (detoxrc) could not be opened or was invalid.

Fields

path: PathBuf

Config file path (resolved or user-supplied).

message: String

Human-readable explanation.

Parse

detoxrc parse error with line + column.

Fields

path: PathBuf

Config file path.

line: usize

1-indexed line number.

column: usize

1-indexed column number.

message: String

Parser diagnostic message.

Collision

Collision-resolution exhausted (more than collision_cap attempts).

Fields

path: PathBuf

Source path being detoxed.

attempts: u32

Number of suffix-disambiguation attempts before giving up.

CrossDevice

Cross-device rename (EXDEV) — the fallback chain also failed.

Fields

source_path: PathBuf

Source path.

target: PathBuf

Intended target path on the other device.

source_err: Error

Underlying error from the fallback chain (copy/fsync/rename/unlink).

PathInvalid

Path was invalid for the active platform (e.g., contains characters not representable in the target OS filesystem).

Fields

path: PathBuf

Offending path.

reason: String

Human-readable explanation.

Trait Implementations

impl Debug for DetoxError

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

Formats the value using the given formatter.

impl Display for DetoxError

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

Formats the value using the given formatter.

impl Error for DetoxError

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.