ntfsanitise 0.3.0

Sanitise filenames for use on NTFS filesystems
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

#[cfg(feature = "std")]
mod path;
#[cfg(all(windows, feature = "std"))]
mod windows;

#[cfg(all(feature = "alloc", not(feature = "std")))]
use alloc::string::String;

#[cfg(feature = "alloc")]
use proptest::property_test;

#[cfg(feature = "alloc")]
use crate::{generate_banned, sanitise};
use crate::{is_clean, is_dirty};

#[test]
fn clean() {
	let clean = ["a", "bb", "ccc"];
	for example in clean {
		assert!(is_clean(example));
		assert!(!is_dirty(example));

		#[cfg(feature = "alloc")]
		assert_eq!(example, sanitise(example, "_"));
	}
}

#[test]
fn dirty() {
	let dirty = ["<", "?", ":"];
	for example in dirty {
		assert!(!is_clean(example));
		assert!(is_dirty(example));

		#[cfg(feature = "alloc")]
		assert_eq!(String::from("_"), sanitise(example, "_"));
	}
}

#[test]
fn empty() {
	assert!(is_clean(""));
	assert!(!is_dirty(""));
	#[cfg(feature = "alloc")]
	assert_eq!("", sanitise("", "_"));
}

#[property_test]
#[cfg(feature = "alloc")]
fn random_clean(#[strategy = r"[\w \.,]+"] input: String) {
	assert!(is_clean(&input));
	assert!(!is_dirty(&input));
	assert_eq!(input, sanitise(&input, "_"));
}

#[property_test]
#[cfg(feature = "alloc")]
fn random_dirty(#[strategy = r#"[\t\?\:<>/\\\|\*"]+"#] input: String) {
	assert!(!is_clean(&input));
	assert!(is_dirty(&input));
	assert_eq!(input.len(), sanitise(&input, "X").chars().filter(|c| *c == 'X').count());
}

#[property_test]
#[cfg(feature = "alloc")]
fn sanitise_sanitises(input: String) {
	assert_eq!(sanitise(&input, "_"), input.replace(generate_banned(), "_"));
}