Struct FileProcessor 

pub struct FileProcessor { /* private fields */ }

Parallel file processor for batch YAML operations.

Processes multiple YAML files in parallel using Rayon’s work-stealing scheduler. Automatically chooses optimal reading strategy based on file size (in-memory vs mmap).

Security: Path Trust Boundary

This is a library crate providing file processing primitives. Path validation is the responsibility of the caller:

• For CLI tools: Validate paths before passing to this API
• For libraries: Document that paths must be trusted
• Path traversal: No canonicalization or “..” filtering is performed
• Symlinks: Followed without validation (use OS permissions for access control)

If your application accepts user-controlled paths, validate them before calling these methods. Example validation:

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

fn validate_path(path: &Path, base_dir: &Path) -> Result<PathBuf, String> {
    let canonical = path.canonicalize()
        .map_err(|e| format!("invalid path: {}", e))?;

    if !canonical.starts_with(base_dir) {
        return Err("path outside allowed directory".to_string());
    }

    Ok(canonical)
}

Implementations

impl FileProcessor

pub fn new() -> Self

Creates a processor with default config.

pub const fn with_config(config: Config) -> Self

Creates a processor with custom config.

pub fn process<F, R>(&self, paths: &[PathBuf], f: F) -> BatchResult

where F: Fn(&Path, &str) -> Result<R> + Sync, R: Send,

Process files with custom operation.

Generic function for applying custom processing to files in parallel.

pub fn parse_files(&self, paths: &[PathBuf]) -> BatchResult

Parse all files and return BatchResult.

pub fn format_files( &self, paths: &[PathBuf], emitter_config: &EmitterConfig, ) -> Vec<(PathBuf, Result<String>)>

Format files and return (path, formatted_content) pairs.

pub fn format_in_place( &self, paths: &[PathBuf], emitter_config: &EmitterConfig, ) -> BatchResult

Format files in place (write back if changed).

Trait Implementations

impl Debug for FileProcessor

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for FileProcessor

fn default() -> Self

Returns the “default value” for a type.