Struct FileHierarchy

pub struct FileHierarchy { /* private fields */ }

File hierarchy definition, handles file path generation.

Implementations

impl FileHierarchy

pub fn new() -> Self

Creates a new file hierarchy instance.

pub fn mountpoint(&self) -> PathBuf

Returns the directory where the file hierarchy is mounted.

pub fn folder<COMP: Component>(&self, component: &COMP) -> PathBuf

Generates the folder path according to the file hierarchy. The folder that contains the file_type always corresponds to the extension of the files contained.

pub fn get_file_list<COMP: Component>( &self, component: &COMP, ) -> Result<Vec<PathBuf>, LewpError>

Collects all filenames in the given component. The resulting vector contains the filepath including the mountpoint of the FileHierarchy. This function is not recursive.

pub fn collect_component_ids( &self, kind: ComponentType, level: Level, ) -> Result<Vec<String>, LewpError>

Collects all filenames in the given directory.

The directory is relative to the mountpoint of the file hierarchy. Gets a list of the component ids available for this ComponentType on the given Level.

Trait Implementations

impl Default for FileHierarchy

fn default() -> Self

Returns the “default value” for a type.