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

//! `safe` filter — replace shell-hostile bytes with `replacement` (FR-004).

/// Replace each byte in `input` matching `unsafe_chars` with `replacement`.
pub fn apply(input: &[u8], replacement: u8, unsafe_chars: &[u8]) -> Vec<u8> {
    input
        .iter()
        .map(|&b| {
            if unsafe_chars.contains(&b) {
                replacement
            } else {
                b
            }
        })
        .collect()
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::filter::DEFAULT_UNSAFE_CHARS;

    #[test]
    fn spaces_become_underscores_with_default_set() {
        assert_eq!(
            apply(b"hello world.txt", b'_', DEFAULT_UNSAFE_CHARS),
            b"hello_world.txt"
        );
    }

    #[test]
    fn parens_become_underscores() {
        assert_eq!(
            apply(b"foo (1).pdf", b'_', DEFAULT_UNSAFE_CHARS),
            b"foo__1_.pdf"
        );
    }

    #[test]
    fn decoded_slash_becomes_underscore_q10() {
        // FR-004 + clarification Q10: `/` is in the default unsafe set
        assert_eq!(apply(b"a/b", b'_', DEFAULT_UNSAFE_CHARS), b"a_b");
    }

    #[test]
    fn custom_replacement_byte() {
        assert_eq!(apply(b"a b", b'-', b" "), b"a-b");
    }
}