rufl 0.1.3

A powerful util function library for 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

use std::fs::File;
use std::io::Error;
use std::io::Read;
use std::path::Path;

/// Reads file to string.
///
/// # Arguments
///
/// * `path` - The path of file to read.
///
/// # Returns
///
/// Returns file content string.
///
/// # Examples
///
/// ```
/// use rufl::file;
///
/// let result = file::read_to_string("./src/file/read_to_string.rs");
/// assert_eq!(true, result.is_ok());
///
/// match result {
///     Ok(content) => {
///         println!("Success, content is: {}", content);
///     }
///     Err(err) => {
///         println!("Error: {}", err);
///     }
/// }
///
/// ```

pub fn read_to_string<P: AsRef<Path>>(path: P) -> Result<String, Error> {
    let mut file = File::open(path)?;

    let mut content = String::new();

    file.read_to_string(&mut content)?;

    Ok(content)
}

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

    #[test]
    fn test_read_to_string() {
        let result = read_to_string("./src/file/read_to_string.rs");
        assert_eq!(true, result.is_ok());

        match result {
            Ok(content) => {
                println!("Success, content is: {}", content);
            }
            Err(err) => {
                println!("Error: {}", err);
            }
        }
    }
}