Struct FileLoader

pub struct FileLoader<'a, T> { /* private fields */ }

FileLoader is a utility for loading files from the filesystem using glob patterns or directory paths. It provides methods to read file contents and handle errors gracefully.

Errors

This module defines a custom error type FileLoaderError which can represent various errors that might occur during file loading operations, such as invalid glob patterns, IO errors, and glob errors.

Example Usage

use rig:loaders::FileLoader;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Create a FileLoader using a glob pattern
    let loader = FileLoader::with_glob("path/to/files/*.txt")?;

    // Read file contents, ignoring any errors
    let contents: Vec<String> = loader
        .read()
        .ignore_errors()

    for content in contents {
        println!("{}", content);
    }

    Ok(())
}

FileLoader uses strict typing between the iterator methods to ensure that transitions between different implementations of the loaders and it’s methods are handled properly by the compiler.

Implementations

impl<'a> FileLoader<'a, PathBuf>

pub fn read(self) -> FileLoader<'a, Result<String, FileLoaderError>>

pub fn read_with_path( self, ) -> FileLoader<'a, Result<(PathBuf, String), FileLoaderError>>

impl<'a> FileLoader<'a, Result<PathBuf, FileLoaderError>>

pub fn read(self) -> FileLoader<'a, Result<String, FileLoaderError>>

Reads the contents of the files within the iterator returned by FileLoader::with_glob or FileLoader::with_dir.

Example

Read files in directory “files/*.txt” and print the content for each file

let content = FileLoader::with_glob(...)?.read();
for result in content {
    match result {
        Ok(content) => println!("{}", content),
        Err(e) => eprintln!("Error reading file: {}", e),
    }
}

pub fn read_with_path( self, ) -> FileLoader<'a, Result<(PathBuf, String), FileLoaderError>>

Reads the contents of the files within the iterator returned by FileLoader::with_glob or FileLoader::with_dir and returns the path along with the content.

Example

Read files in directory “files/*.txt” and print the content for corresponding path for each file.

let content = FileLoader::with_glob("files/*.txt")?.read();
for (path, result) in content {
    match result {
        Ok((path, content)) => println!("{:?} {}", path, content),
        Err(e) => eprintln!("Error reading file: {}", e),
    }
}

impl<'a, T: 'a> FileLoader<'a, Result<T, FileLoaderError>>

pub fn ignore_errors(self) -> FileLoader<'a, T>

Ignores errors in the iterator, returning only successful results. This can be used on any FileLoader state of iterator whose items are results.

Example

Read files in directory “files/*.txt” and ignore errors from unreadable files.

let content = FileLoader::with_glob("files/*.txt")?.read().ignore_errors();
for result in content {
    println!("{}", content)
}

impl FileLoader<'_, Result<PathBuf, FileLoaderError>>

pub fn with_glob( pattern: &str, ) -> Result<FileLoader<'_, Result<PathBuf, FileLoaderError>>, FileLoaderError>

Creates a new FileLoader using a glob pattern to match files.

Example

Create a FileLoader for all .txt files that match the glob “files/*.txt”.

let loader = FileLoader::with_glob("files/*.txt")?;

pub fn with_dir( directory: &str, ) -> Result<FileLoader<'_, Result<PathBuf, FileLoaderError>>, FileLoaderError>

Creates a new FileLoader on all files within a directory.

Example

Create a FileLoader for all files that are in the directory “files” (ignores subdirectories).

let loader = FileLoader::with_dir("files")?;

Trait Implementations

impl<'a, T> IntoIterator for FileLoader<'a, T>

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.