file-ext 12.0.0

Collection of utility functions to work with files
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

use crate::file_ext_impl::FileExtImpl;
use crate::FileExt;
use crate::path_ext_impl::PathExtImpl;

#[test]
fn write() {
    let filename = "write-test.content";
    FileExtImpl::create_file(filename).unwrap();

    let expected_content = "<!DOCTYPE html>\n<html lang=\"en\">\n<head>\n    <meta charset=\"UTF-8\">\n    <title>Title</title>\n</head>\n<body>\n\n</body>\n</html>";
    FileExtImpl::write_file(filename, expected_content.as_bytes()).unwrap();

    let actual = FileExtImpl::read_file(filename).unwrap();
    assert_eq!(actual, expected_content.as_bytes());

    FileExtImpl::delete_file(filename).unwrap();

}

#[test]
fn file_content() {
    let path = "test/index.html";
    let file_raw_bytes = FileExtImpl::read_file(path).unwrap();
    let content = String::from_utf8(file_raw_bytes).unwrap();

    let content_escaped_newline_carriage_return = str::replace(content.as_str(), "\r\n", "\n");

    let expected_content = "<!DOCTYPE html>\n<html lang=\"en\">\n<head>\n    <meta charset=\"UTF-8\">\n    <title>Title</title>\n</head>\n<body>\n\n</body>\n</html>";

    assert_eq!(expected_content, content_escaped_newline_carriage_return);
}

#[test]
fn partial_read() {
    let path = "test/index.html";
    let file_raw_bytes = FileExtImpl::read_file_partially(path, 4, 10).unwrap();
    let content = String::from_utf8(file_raw_bytes).unwrap();

    let expected_content = "CTYPE h";

    assert_eq!(expected_content, content);
}

#[test]
fn does_not_exist() {
    let path = "test/non_existing_file";
    let exists = FileExtImpl::does_file_exist(path);
    assert!(!exists);
}

#[test]
fn read_or_create_and_write() {
    let content = "data".as_bytes();
    let tmp_folder = PathExtImpl::get_temp_folder_path().unwrap();

    let path = [tmp_folder, "test.txt".to_string()].join(PathExtImpl::get_path_separator().as_str());

    let doesnt_exist = !FileExtImpl::does_file_exist(path.as_str());
    assert!(doesnt_exist);

    FileExtImpl::read_or_create_and_write(path.as_str(), content).unwrap();

    let does_exist = FileExtImpl::does_file_exist(path.as_str());
    assert!(does_exist);

    let new_content = "updated data".as_bytes();
    FileExtImpl::read_or_create_and_write(path.as_str(), new_content).unwrap();

    let file_content = FileExtImpl::read_file(path.as_str()).unwrap();
    assert_eq!(content, file_content);

    FileExtImpl::delete_file(path.as_str()).unwrap();
    let doesnt_exist = !FileExtImpl::does_file_exist(path.as_str());
    assert!(doesnt_exist);
}

#[test]
fn file_creation_deletion() {
    let path = "test/file-creation.txt";

    let exists = FileExtImpl::does_file_exist(path);
    assert!(!exists);

    FileExtImpl::create_file(path).unwrap();

    let content = FileExtImpl::read_file(path).unwrap();
    assert_eq!(content.len(), 0);

    FileExtImpl::delete_file(path).unwrap();

    let exists = FileExtImpl::does_file_exist(path);
    assert!(!exists);
}

#[test]
fn length() {
    let pwd = FileExt::working_directory().unwrap();
    let boxed_length = FileExt::file_length(vec![pwd.as_str(), "LICENSE"]);

    assert!(boxed_length.is_ok());
}


#[test]
fn copy_file() {
    let pwd = FileExt::working_directory().unwrap();
    FileExt::copy_file(vec![pwd.as_str(), "LICENSE"], vec![pwd.as_str(), "LICENSE_copy2"]).unwrap();

    let path = FileExt::build_path(vec![pwd.as_str(), "LICENSE_copy2"].as_slice());
    FileExt::delete_file(path.as_str()).unwrap();
}

#[test]
fn copy_file_with_callback_and_block_size() {
    let block_size : u64 = 10;
    let pwd = FileExt::working_directory().unwrap();
    let mut label = "".to_string();
    let progress_callback = |start, end, total| {
        // this callback is invoked before each block copy
        label = format!("copying block {}-{} of {} bytes", start, end, total).to_string();
    };
    let cancel_callback = |_start, _end, _total| {
        // false -> do not cancel the copy
        // this callback is invoked after each block copy
        // if true is returned the copy process will stop
        false
    };
    FileExt::copy_file_with_callbacks(
        vec![pwd.as_str(), "LICENSE"],
        vec![pwd.as_str(), "LICENSE_copy3"],
        Some(block_size),
        progress_callback,
        cancel_callback
    ).unwrap();

    let path = FileExt::build_path(vec![pwd.as_str(), "LICENSE_copy3"].as_slice());
    FileExt::delete_file(path.as_str()).unwrap();
}

#[test]
fn copy_file_with_callback_and_block_size_starting_from_byte() {
    let block_size : u64 = 1000000;
    let pwd = FileExt::working_directory().unwrap();
    let mut label = "".to_string();
    let progress_callback = |start, end, total| { label = format!("copying block {}-{} of {} bytes", start, end, total).to_string(); };
    let cancel_callback = |_start, _end, _total| { false };
    let starting_byte = 4;
    FileExt::copy_file_with_callbacks_starting_from_byte(
        vec![pwd.as_str(), "LICENSE"],
        vec![pwd.as_str(), "LICENSE_copy4"],
        starting_byte,
        Some(block_size),
        progress_callback,
        cancel_callback
    ).unwrap();

    let path = FileExt::build_path(vec![pwd.as_str(), "LICENSE_copy4"].as_slice());
    FileExt::delete_file(path.as_str()).unwrap();
}

#[test]
fn copy_file_with_callback_and_block_size_starting_from_byte_and_ending_byte() {
    let block_size : u64 = 1000000;
    let pwd = FileExt::working_directory().unwrap();
    let mut label = "".to_string();
    let progress_callback = |start, end, total| { label = format!("copying block {}-{} of {} bytes", start, end, total).to_string(); };
    let cancel_callback = |_start, _end, _total| { false };
    let starting_byte = 4;
    let ending_byte = 10;
    FileExt::copy_file_with_callbacks_starting_from_byte_and_ending_at_byte(
        vec![pwd.as_str(), "LICENSE"],
        vec![pwd.as_str(), "LICENSE_copy5"],
        starting_byte,
        ending_byte,
        Some(block_size),
        progress_callback,
        cancel_callback
    ).unwrap();

    let path = FileExt::build_path(vec![pwd.as_str(), "LICENSE_copy5"].as_slice());
    FileExt::delete_file(path.as_str()).unwrap();
}