iocore 2.3.2

IOCore is a safe library for unix CLI tools and Systems programming. IOCore provides the [`iocore::Path`] abstraction of file-system paths designed to replace most [`std::path`] and [`std::fs`] operations with practical methods, other abstractions include: - handling file-system permissions via [`iocore::PathPermissions`] powered by the crate [`trilobyte`]. - handling file-system timestamps via [`iocore::PathTimestamps`] granularly via [`iocore::PathDateTime`]. IOCore provides the [`iocore::walk_dir`] function and its companion trait [`iocore::WalkProgressHandler`] which traverses file-systems quickly via threads. IOcore provides [`iocore::User`] which provides unix user information such as uid, path to home etc. The module [`iocore::env`] provides [`iocore::env:args`] returns a [`Vec<String>`] from [`std::env:args`], and [`iocore::env:var`] that returns environment variables as string.
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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213

#[cfg(test)]
mod test_very_specific_ordering_files {
    use iocore::Path;
    use iocore_test::path_to_test_file;
    #[test]
    fn test_paths_should_be_ordered_alphabetically() {
        let mut paths = vec![
            path_to_test_file!("zzzzz"),
            path_to_test_file!("mmmmm"),
            path_to_test_file!("nnnnn"),
            path_to_test_file!("aaaaa"),
        ];
        paths.sort();
        assert_eq!(
            paths,
            vec![
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_files/test_paths_should_be_ordered_alphabetically/aaaaa"),
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_files/test_paths_should_be_ordered_alphabetically/mmmmm"),
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_files/test_paths_should_be_ordered_alphabetically/nnnnn"),
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_files/test_paths_should_be_ordered_alphabetically/zzzzz"),
            ]
        );
    }
    #[test]
    fn but_paths_should_be_ordered_by_length() {
        let mut paths = vec![
            path_to_test_file!("mmmmm"),
            path_to_test_file!("mmm"),
            path_to_test_file!("aaa"),
            path_to_test_file!("aaaa"),
        ];
        paths.sort();
        assert_eq!(
            paths,
            vec![
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_files/but_paths_should_be_ordered_by_length/aaa"),
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_files/but_paths_should_be_ordered_by_length/aaaa"),
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_files/but_paths_should_be_ordered_by_length/mmm"),
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_files/but_paths_should_be_ordered_by_length/mmmmm"),
            ]
        );
    }
    #[test]
    fn but_paths_should_be_ordered_by_depth_of_folders() {
        let mut paths = vec![
            path_to_test_file!("abcdefg"),
            path_to_test_file!("nopqrst"),
            path_to_test_file!("a/bcdefg"),
            path_to_test_file!("no/pqrst"),
            path_to_test_file!("u/v/w/x/y"),
            path_to_test_file!("uv/wx/y"),
        ];
        paths.sort();
        assert_eq!(
            paths,
            vec![
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_files/but_paths_should_be_ordered_by_depth_of_folders/abcdefg"),
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_files/but_paths_should_be_ordered_by_depth_of_folders/nopqrst"),
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_files/but_paths_should_be_ordered_by_depth_of_folders/a/bcdefg"),
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_files/but_paths_should_be_ordered_by_depth_of_folders/no/pqrst"),
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_files/but_paths_should_be_ordered_by_depth_of_folders/uv/wx/y"),
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_files/but_paths_should_be_ordered_by_depth_of_folders/u/v/w/x/y"),
            ]
        );
    }
}
#[cfg(test)]
mod test_very_specific_ordering_folders {
    use iocore::Path;
    use iocore_test::path_to_test_folder;
    #[test]
    fn test_paths_should_be_ordered_alphabetically() {
        let mut paths = vec![
            path_to_test_folder!("zzzzz"),
            path_to_test_folder!("mmmmm"),
            path_to_test_folder!("nnnnn"),
            path_to_test_folder!("aaaaa"),
        ];
        paths.sort();
        assert_eq!(
            paths,
            vec![
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_folders/test_paths_should_be_ordered_alphabetically/aaaaa"),
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_folders/test_paths_should_be_ordered_alphabetically/mmmmm"),
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_folders/test_paths_should_be_ordered_alphabetically/nnnnn"),
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_folders/test_paths_should_be_ordered_alphabetically/zzzzz"),
            ]
        );
    }
    #[test]
    fn but_paths_should_be_ordered_by_length() {
        let mut paths = vec![
            path_to_test_folder!("mmmmm"),
            path_to_test_folder!("mmm"),
            path_to_test_folder!("aaa"),
            path_to_test_folder!("aaaa"),
        ];
        paths.sort();
        assert_eq!(
            paths,
            vec![
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_folders/but_paths_should_be_ordered_by_length/aaa"),
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_folders/but_paths_should_be_ordered_by_length/aaaa"),
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_folders/but_paths_should_be_ordered_by_length/mmm"),
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_folders/but_paths_should_be_ordered_by_length/mmmmm"),
            ]
        );
    }
    #[test]
    fn but_paths_should_be_ordered_by_depth_of_folders() {
        let mut paths = vec![
            path_to_test_folder!("abcdefg"),
            path_to_test_folder!("nopqrst"),
            path_to_test_folder!("a/bcdefg"),
            path_to_test_folder!("no/pqrst"),
            path_to_test_folder!("u/v/w/x/y"),
            path_to_test_folder!("uv/wx/y"),
        ];
        paths.sort();
        assert_eq!(
            paths,
            vec![
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_folders/but_paths_should_be_ordered_by_depth_of_folders/abcdefg"),
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_folders/but_paths_should_be_ordered_by_depth_of_folders/nopqrst"),
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_folders/but_paths_should_be_ordered_by_depth_of_folders/a/bcdefg"),
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_folders/but_paths_should_be_ordered_by_depth_of_folders/no/pqrst"),
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_folders/but_paths_should_be_ordered_by_depth_of_folders/uv/wx/y"),
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_folders/but_paths_should_be_ordered_by_depth_of_folders/u/v/w/x/y"),
            ]
        );
    }
}

#[cfg(test)]
mod test_very_specific_ordering_files_and_dictories {
    use iocore::Path;
    use iocore_test::{path_to_test_file, path_to_test_folder};
    #[test]
    fn test_paths_should_be_ordered_alphabetically() {
        let mut paths = vec![
            path_to_test_file!("zzzzz"),
            path_to_test_file!("mmmmm/mmmmm"),
            path_to_test_folder!("mmmmm"),
            path_to_test_folder!("nnnnn"),
            path_to_test_file!("nnnnn/nnnn"),
            path_to_test_file!("aaaaa"),
        ];
        paths.sort();
        assert_eq!(
            paths,
            vec![
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_files_and_dictories/test_paths_should_be_ordered_alphabetically/aaaaa"),
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_files_and_dictories/test_paths_should_be_ordered_alphabetically/mmmmm"),
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_files_and_dictories/test_paths_should_be_ordered_alphabetically/nnnnn"),
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_files_and_dictories/test_paths_should_be_ordered_alphabetically/zzzzz"),
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_files_and_dictories/test_paths_should_be_ordered_alphabetically/mmmmm/mmmmm"),
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_files_and_dictories/test_paths_should_be_ordered_alphabetically/nnnnn/nnnn"),
            ]
        );
    }
    #[test]
    fn but_paths_should_be_ordered_by_length() {
        let mut paths = vec![
            path_to_test_file!("mmmmm"),
            path_to_test_folder!("mmm"),
            path_to_test_file!("aaa"),
            path_to_test_folder!("aaaa"),
        ];
        paths.sort();
        assert_eq!(
            paths,
            vec![
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_files_and_dictories/but_paths_should_be_ordered_by_length/aaa"),
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_files_and_dictories/but_paths_should_be_ordered_by_length/aaaa"),
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_files_and_dictories/but_paths_should_be_ordered_by_length/mmm"),
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_files_and_dictories/but_paths_should_be_ordered_by_length/mmmmm"),
            ]
        );
    }
    #[test]
    fn but_paths_should_be_ordered_by_depth_of_folders() {
        let mut paths = vec![
            path_to_test_file!("abcdefg"),
            path_to_test_file!("nopqrst"),
            path_to_test_file!("a/bcdefg"),
            path_to_test_folder!("a"),
            path_to_test_file!("no/pqrst"),
            path_to_test_folder!("u"),
            path_to_test_folder!("u/v"),
            path_to_test_folder!("u/v/w"),
            path_to_test_folder!("u/v/w/x"),
            path_to_test_file!("u/v/w/x/y"),
            path_to_test_file!("uv/wx/y"),
        ];
        paths.sort();
        assert_eq!(
            paths,
            vec![
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_files_and_dictories/but_paths_should_be_ordered_by_depth_of_folders/a"),
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_files_and_dictories/but_paths_should_be_ordered_by_depth_of_folders/u"),
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_files_and_dictories/but_paths_should_be_ordered_by_depth_of_folders/abcdefg"),
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_files_and_dictories/but_paths_should_be_ordered_by_depth_of_folders/nopqrst"),
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_files_and_dictories/but_paths_should_be_ordered_by_depth_of_folders/u/v"),
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_files_and_dictories/but_paths_should_be_ordered_by_depth_of_folders/a/bcdefg"),
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_files_and_dictories/but_paths_should_be_ordered_by_depth_of_folders/no/pqrst"),
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_files_and_dictories/but_paths_should_be_ordered_by_depth_of_folders/u/v/w"),
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_files_and_dictories/but_paths_should_be_ordered_by_depth_of_folders/u/v/w/x"),
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_files_and_dictories/but_paths_should_be_ordered_by_depth_of_folders/uv/wx/y"),
                Path::raw("tests/__test_files__/test_path_cmp/test_very_specific_ordering_files_and_dictories/but_paths_should_be_ordered_by_depth_of_folders/u/v/w/x/y"),
            ]
        );
    }
}