rusty-detox 0.2.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

//! `inline-detox` companion binary (FR-044/FR-045).
//!
//! Reads stdin to EOF as a single name byte-sequence, applies the configured
//! sequence, writes the sanitized name to stdout.
//!
//! Gated at the file level by `#[cfg(feature = "inline-detox")]` (in
//! addition to `required-features = ["inline-detox"]` in Cargo.toml) so the
//! portfolio-wide feature-lint phantom-leaf sub-check (FR-008 / FR-052
//! sub-rule 3) recognizes the v0.1.x `inline-detox` feature as
//! source-gated. The `required-features` attribute is the binding gate for
//! the binary entry; this `cfg` is a no-op for build purposes (the binary
//! is only compiled when the feature is enabled either way).

#![cfg(feature = "inline-detox")]

use std::io::{self, Read, Write};

use clap::Parser;
use rusty_detox::{DetoxBuilder, Sequence};

/// Stream-detox a single name from stdin to stdout.
#[derive(Parser, Debug)]
#[command(name = "inline-detox", about, version)]
struct Args {
    /// Sequence to apply (default `default`).
    #[arg(short = 's', long = "sequence", value_name = "NAME")]
    sequence: Option<String>,

    /// Override config-file resolution (currently ignored in v0.1.0 — see US6).
    #[arg(short = 'f', long = "config-file", value_name = "PATH")]
    _config_file: Option<String>,
}

fn main() {
    let args = Args::parse();
    let sequence = match args.sequence.as_deref() {
        Some("default") | None => Sequence::default(),
        Some("iso8859_1") => Sequence::iso8859_1(),
        Some("utf_8") => Sequence::utf_8(),
        Some(other) => {
            eprintln!("inline-detox: sequence '{other}' not found");
            std::process::exit(1);
        }
    };
    let detox = DetoxBuilder::new().sequence(sequence).build();

    let mut buf = Vec::new();
    if let Err(e) = io::stdin().read_to_end(&mut buf) {
        eprintln!("inline-detox: {e}");
        std::process::exit(1);
    }
    let out = detox.sanitize_bytes(&buf);
    if let Err(e) = io::stdout().write_all(&out) {
        eprintln!("inline-detox: {e}");
        std::process::exit(1);
    }
}