Struct Config 

pub struct Config { /* private fields */ }

Configuration for parallel processing behavior.

Simplified configuration with essential fields for both document-level and file-level parallelism.

Security Limits

To prevent denial-of-service attacks and resource exhaustion:

• Maximum threads: 128
• Maximum input size: 100MB (configurable via max_input_size)

Examples

use fast_yaml_parallel::Config;

let config = Config::new()
    .with_workers(Some(8))
    .with_sequential_threshold(2048);

Implementations

impl Config

pub fn new() -> Self

Creates default configuration.

Examples

use fast_yaml_parallel::Config;

let config = Config::new();

pub const fn with_workers(self, workers: Option<usize>) -> Self

Sets worker count.

• None: Auto-detect CPU count (default, capped at 128)
• Some(0): Sequential processing (no parallelism)
• Some(n): Use exactly n threads (capped at 128)

Security

Thread count is capped at 128 to prevent resource exhaustion.

Examples

use fast_yaml_parallel::Config;

let config = Config::new().with_workers(Some(4));

pub const fn with_mmap_threshold(self, threshold: usize) -> Self

Sets memory-map threshold for file reading.

Files larger than this threshold will use memory-mapped I/O. Default: 512KB

Tuning Guidance

The optimal threshold depends on your workload:

• Lower (256KB-512KB): Better for many medium files (100KB-1MB)

  • Pros: Less virtual memory pressure, faster for small-to-medium files
  • Cons: More heap allocations for files just above threshold

• Higher (1MB-2MB): Better for fewer large files (>2MB)

  • Pros: Fewer mmaps, better for very large files
  • Cons: More heap usage for medium files

Consider your typical file size distribution and available memory. Profile with real data before changing the default.

Examples

use fast_yaml_parallel::Config;

let config = Config::new()
    .with_mmap_threshold(1024 * 1024); // 1MB

pub const fn with_max_input_size(self, size: usize) -> Self

Sets maximum input size in bytes.

Input exceeding this size will be rejected. Default: 100MB

Security

This limit prevents denial-of-service attacks via extremely large inputs.

Examples

use fast_yaml_parallel::Config;

let config = Config::new()
    .with_max_input_size(200 * 1024 * 1024); // 200MB

pub const fn with_sequential_threshold(self, threshold: usize) -> Self

Sets sequential processing threshold.

Inputs smaller than this threshold will use sequential processing to avoid parallelism overhead. Default: 4KB

Examples

use fast_yaml_parallel::Config;

let config = Config::new()
    .with_sequential_threshold(2048);

pub const fn workers(&self) -> Option<usize>

Returns worker count setting.

pub const fn mmap_threshold(&self) -> usize

Returns mmap threshold.

pub const fn max_input_size(&self) -> usize

Returns maximum input size.

pub const fn sequential_threshold(&self) -> usize

Returns sequential threshold.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.