file-io 0.1.9

Easy interfaces for file i/o.
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

use std::path::{Path, PathBuf};

/// Lists the contents of a folder at the specified path.
///
/// # Arguments
///
/// * `path` - The path to the folder (can be a `&str`, `String`, `Path`, or `PathBuf`).
///
/// # Returns
///
/// Paths of the files and folders in the specified directory (in alphabetical order). Note that
/// folders are included in the list, but their contents are not recursively listed.
///
/// # Panics
///
/// If the provided path is not a folder or if an error occurs while reading the folder.
///
/// # Examples
///
/// ## Using a string literal
///
/// ```
/// use file_io::list_folder_contents;
/// use std::path::PathBuf;
///     
/// let contents: Vec<PathBuf> = list_folder_contents(".vscode");
///
/// assert_eq!(
///     contents,
///     vec![PathBuf::from(".vscode/extensions.json"), PathBuf::from(".vscode/settings.json")]
/// );
/// ```
///
/// ## Using a `Path` reference
///
/// ```
/// use file_io::list_folder_contents;
/// use std::path::{Path, PathBuf};
///
/// let contents: Vec<PathBuf> = list_folder_contents(Path::new(".vscode"));
///
/// assert_eq!(
///    contents,
///    vec![PathBuf::from(".vscode/extensions.json"), PathBuf::from(".vscode/settings.json")]
/// );
/// ```
pub fn list_folder_contents<P: AsRef<Path>>(path: P) -> Vec<PathBuf> {
    // Convert the input path to a Path reference.
    let path = path.as_ref();

    // Ensure the path is a folder.
    if !path.is_dir() {
        panic!("The provided path is not a folder: {path:?}");
    }

    // Read the folder entries into a vector.
    let mut entries = match std::fs::read_dir(path) {
        Ok(entries) => entries
            .filter_map(Result::ok)
            .map(|e| e.path())
            .collect::<Vec<PathBuf>>(),
        Err(_) => panic!("Failed to read directory: {path:?}"),
    };

    // Sort the entries alphabetically.
    entries.sort();

    entries
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::save::save_string_to_file;
    use crate::test_utils::get_temp_dir_path;
    use tempfile::tempdir;

    #[test]
    fn test_list_folder_contents() {
        // Create a temporary directory to work in.
        let temp_dir = tempdir().unwrap();

        // Get the path to the temporary directory.
        let temp_dir_path = get_temp_dir_path(&temp_dir);

        // Create some test files and folders.
        save_string_to_file("Content 1", temp_dir_path.join("file1.txt"));
        save_string_to_file("Content 2", temp_dir_path.join("file2.txt"));
        save_string_to_file("Content 3", temp_dir_path.join("subfolder/file3.txt"));

        // List the contents of the temporary directory.
        let contents = list_folder_contents(&temp_dir_path);

        // Check that the contents are as expected.
        assert_eq!(
            contents,
            vec![
                temp_dir_path.join("file1.txt"),
                temp_dir_path.join("file2.txt"),
                temp_dir_path.join("subfolder")
            ]
        );
    }
}