filehash-rs 1.1.0

A small, fast library for hashing files written in Rust.
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

use std::{
    collections::hash_map::DefaultHasher,
    fs::File,
    hash::{Hash, Hasher},
    io::{Error, Read},
    path::Path,
};

/// ```rust
/// // A simple example of a program that queries the user
/// // for a file to hash and prints the result.
/// # use std::error::Error;
/// # use filehash_rs::filehash;
/// fn main() -> Result<(), Box<dyn Error>> {
///    let mut input_string = String::new();
///    println!("Path to the file:");
///
///    std::io::stdin().read_line(&mut input_string)?;
/// #  input_string = String::from("./mock/mock.txt");
///
///    let result = filehash(&mut input_string);
///
///    match result {
///        Ok(value) => {
///            println!("{}", value);
///            return Ok(());
///        }
///        Err(err) => {
///            println!("Error: {}", err);
///            return Err(Box::new(err));
///        }
///    }
/// }
/// ```

pub fn filehash(file_path: &mut String) -> Result<u64, Error> {
    let tmp = file_path.trim();
    let path_input = Path::new(&tmp);

    let path_canonicalized = path_input.canonicalize()?;
    let path_os_string = path_canonicalized.as_os_str();
    let mut buffer: Vec<u8> = Vec::new();

    let mut f = File::open(path_os_string)?;
    f.read_to_end(&mut buffer)?;

    let mut hasher = DefaultHasher::new();
    buffer.hash(&mut hasher);
    let finished_hash = hasher.finish();
    return Ok(finished_hash);
}

#[cfg(test)]
mod tests {
    use super::filehash;

    #[test]
    fn it_generates_consistent_results_png() {
        let mut mock_file1 = String::from("./mock/mock.png");
        let mut mock_file2 = String::from("./mock/mock.png");
        let result1 = filehash(&mut mock_file1);
        let result2 = filehash(&mut mock_file2);
        assert_eq!(result1.unwrap(), result2.unwrap());
    }
    #[test]
    fn it_generates_consistent_results_txt() {
        let mut mock_file1 = String::from("./mock/mock.txt");
        let mut mock_file2 = String::from("./mock/mock.txt");
        let result1 = filehash(&mut mock_file1);
        let result2 = filehash(&mut mock_file2);
        assert_eq!(result1.unwrap(), result2.unwrap());
    }
    #[test]
    fn it_generates_consistent_results_json() {
        let mut mock_file1 = String::from("./mock/mock.json");
        let mut mock_file2 = String::from("./mock/mock.json");
        let result1 = filehash(&mut mock_file1);
        let result2 = filehash(&mut mock_file2);
        assert_eq!(result1.unwrap(), result2.unwrap());
    }
}