rusty-detox 0.1.0

Sanitize messy filenames — a Rust port of Doug Harple's `detox(1)` with the filter pipeline (uncgi, iso8859_1, utf_8, safe, wipeup, max_length), `detoxrc` config grammar, recursive collision-safe batch rename, EXDEV cross-device fallback, and a typed library API.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77

//! Public error type for the rusty-detox library API (FR-042).

use std::path::PathBuf;

/// Error type returned by [`Detox`](crate::Detox) operations.
///
/// Pattern-matchable; carries structured payload (path + source-error where
/// applicable). The `#[non_exhaustive]` marker allows additive variants in
/// SemVer-minor releases.
#[non_exhaustive]
#[derive(Debug, thiserror::Error)]
pub enum DetoxError {
    /// Filesystem I/O failure for a specific path.
    #[error("rusty-detox: I/O error on '{path}': {source}")]
    Io {
        /// Path being operated on when the error occurred.
        path: PathBuf,
        /// Underlying `std::io::Error`.
        #[source]
        source: std::io::Error,
    },

    /// Configuration file (`detoxrc`) could not be opened or was invalid.
    #[error("rusty-detox: config error at '{path}': {message}")]
    Config {
        /// Config file path (resolved or user-supplied).
        path: PathBuf,
        /// Human-readable explanation.
        message: String,
    },

    /// `detoxrc` parse error with line + column.
    #[error("rusty-detox: parse error at {path}:{line}:{column}: {message}")]
    Parse {
        /// Config file path.
        path: PathBuf,
        /// 1-indexed line number.
        line: usize,
        /// 1-indexed column number.
        column: usize,
        /// Parser diagnostic message.
        message: String,
    },

    /// Collision-resolution exhausted (more than `collision_cap` attempts).
    #[error("rusty-detox: cannot resolve collision for '{path}' ({attempts} attempts)")]
    Collision {
        /// Source path being detoxed.
        path: PathBuf,
        /// Number of suffix-disambiguation attempts before giving up.
        attempts: u32,
    },

    /// Cross-device rename (EXDEV) — the fallback chain also failed.
    #[error(
        "rusty-detox: cross-device rename failed from '{source_path}' to '{target}': {source_err}"
    )]
    CrossDevice {
        /// Source path.
        source_path: PathBuf,
        /// Intended target path on the other device.
        target: PathBuf,
        /// Underlying error from the fallback chain (copy/fsync/rename/unlink).
        #[source]
        source_err: std::io::Error,
    },

    /// Path was invalid for the active platform (e.g., contains characters not
    /// representable in the target OS filesystem).
    #[error("rusty-detox: invalid path '{path}': {reason}")]
    PathInvalid {
        /// Offending path.
        path: PathBuf,
        /// Human-readable explanation.
        reason: String,
    },
}