Skip to main content

BatchConfig

Struct BatchConfig 

Source
pub struct BatchConfig {
    pub parallel_threshold: usize,
    pub max_threads: Option<usize>,
    pub progress_interval: usize,
    pub verbose: bool,
    pub max_files: Option<usize>,
}
Expand description

Configuration for batch processing operations.

Controls parallelization strategy, progress reporting, and error handling behavior.

§Examples

use hedl_cli::batch::BatchConfig;

// Default configuration (auto parallelization)
let config = BatchConfig::default();

// Custom configuration
let config = BatchConfig {
    parallel_threshold: 5,  // Parallelize if >= 5 files
    max_threads: Some(4),   // Use at most 4 threads
    progress_interval: 10,  // Update progress every 10 files
    verbose: true,          // Show detailed progress
    max_files: Some(10_000), // Limit to 10,000 files
};

Fields§

§parallel_threshold: usize

Minimum number of files to trigger parallel processing.

Files below this threshold are processed serially to avoid thread pool overhead. Default: 10

§max_threads: Option<usize>

Maximum number of threads to use for parallel processing.

When set, creates a local thread pool isolated to this batch operation. This ensures configuration always takes effect and prevents global state pollution.

§Behavior

  • None (default): Uses Rayon’s global thread pool (typically number of CPU cores)
  • Some(n): Creates a local thread pool with exactly n threads for this operation

§Thread Pool Isolation

Local thread pools provide complete isolation:

  • No global state modification
  • Concurrent batch operations can use different thread counts
  • Configuration is guaranteed to take effect or error explicitly
  • Thread pool lifetime matches the process() call duration

§Performance Considerations

Local thread pool creation has small overhead (~0.5-1ms) and memory cost (~2-8MB per thread). For maximum performance with default configuration, leave as None.

§Examples

use hedl_cli::batch::BatchConfig;

// Default: uses global pool
let config = BatchConfig::default();

// Custom: creates local pool with 4 threads
let config = BatchConfig {
    max_threads: Some(4),
    ..Default::default()
};

Default: None

§progress_interval: usize

Number of files between progress updates.

Progress is printed every N files processed. Set to 0 to disable. Default: 1 (update after each file)

§verbose: bool

Enable verbose progress reporting.

When true, shows file names and detailed status for each file. Default: false

§max_files: Option<usize>

Maximum number of files allowed in a batch operation.

This prevents resource exhaustion when processing very large file sets.

  • Some(n): Limit to n files (default: 10,000)
  • None: No limit (use with caution)

§Security

Protects against:

  • Memory exhaustion from storing millions of file paths
  • File descriptor exhaustion from concurrent operations
  • Excessive CPU time from unbounded processing

§Configuration

Can be overridden via:

  • Environment variable: HEDL_MAX_BATCH_FILES
  • CLI flag: --max-files <N>
  • Programmatic: BatchConfig { max_files: Some(n), .. }

§Examples

use hedl_cli::batch::BatchConfig;

// Default limit (10,000 files)
let config = BatchConfig::default();

// Custom limit
let config = BatchConfig {
    max_files: Some(50_000),
    ..Default::default()
};

// Unlimited (use with caution)
let config = BatchConfig {
    max_files: None,
    ..Default::default()
};

Trait Implementations§

Source§

impl Clone for BatchConfig

Source§

fn clone(&self) -> BatchConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for BatchConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for BatchConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,