Directory

Trait Directory 

Source
pub trait Directory {
    // Required method
    fn files(&self) -> Vec<File>;

    // Provided method
    fn glob(&self, search: &str) -> Result<Vec<File>, Error> { ... }
}
Expand description

All generated structs implement this.

Required Methods§

Source

fn files(&self) -> Vec<File>

Gives you all the files in a directory or other such struct recursively.

The paths returned from this will use periods as seperators as it looks when you are accessing the files as fields on a struct.

A generated implementation may look like this:

impl ::include_folder::Directory for TestDirSrc {
    fn files(&self) -> Vec<::include_folder::File> {
        use ::include_folder::Data;
        <[_]>::into_vec(
            #[rustc_box]
            ::alloc::boxed::Box::new([
                ::include_folder::File {
                    path: "nested.folders.test.txt".to_string(),
                    data: self.nested.folders.test.txt.clone().to_file_data(),
                },
                ::include_folder::File {
                    path: "parsing.lexer.txt".to_string(),
                    data: self.parsing.lexer.txt.clone().to_file_data(),
                },
                ::include_folder::File {
                    path: "parsing.lexer.rs".to_string(),
                    data: self.parsing.lexer.rs.clone().to_file_data(),
                },
                ::include_folder::File {
                    path: "main.rs".to_string(),
                    data: self.main.rs.clone().to_file_data(),
                },
            ]),
        )
    }
}

Provided Methods§

Source

fn glob(&self, search: &str) -> Result<Vec<File>, Error>

Implementors§