gitignore-template-generator 0.14.0

A binary crate to generate templates for .gitignore 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

use std::io::Error;

pub use crate::fs::impls::DirectoryHandler;

/// File system handler trait to handle common file system operations.
pub trait FileSystemHandler {
    /// Fetches the file content.
    ///
    /// File location is not taken into consideration here. It is up to
    /// the struct implementing this trait to take that decision.
    ///
    /// # Arguments
    ///
    /// * `file_name` - The name of the file to be fetched
    ///
    /// # Returns
    ///
    /// A result containing the fetched file content, or a
    /// [`std::io::Error`] on error (e.g. file system failure, insufficient
    /// privilege...).
    fn fetch_content(&self, file_name: &str) -> Result<String, Error>;

    /// List files.
    ///
    /// File location is not taken into consideration here. It is up to
    /// the struct implementing this trait to take that decision.
    ///
    /// # Returns
    ///
    /// A result containing the list of files, or a
    /// [`std::io::Error`] on error (e.g. file system failure, insufficient
    /// privilege...).
    fn list_files(&self) -> Result<Vec<String>, Error>;
}