Struct OutOfCoreConfig 

pub struct OutOfCoreConfig {
    pub memory_fraction: f64,
    pub memory_budget_bytes: Option<usize>,
    pub parallelism: Option<usize>,
    pub queue_depth: usize,
    pub async_io: bool,
}

Configuration for out-of-core batching.

Fields

memory_fraction: f64

Fraction of available system memory to target (0.0 < fraction <= 1.0).

memory_budget_bytes: Option<usize>

Explicit memory budget override (bytes). If set, memory_fraction is ignored.

parallelism: Option<usize>

Optional number of worker threads for parallel slice processing.

queue_depth: usize

Bounded queue depth for pipeline stages.

async_io: bool

Enable async pipeline stage execution.

Implementations

impl OutOfCoreConfig

pub fn with_memory_fraction(self, fraction: f64) -> Self

Set the fraction of available system memory to target.

pub fn with_memory_budget_bytes(self, bytes: usize) -> Self

Set an explicit memory budget in bytes.

pub fn with_parallelism(self, threads: usize) -> Self

Set the number of worker threads for slice processing.

Values less than 1 are clamped to 1. Use Self::try_with_parallelism to surface invalid values as an error instead.

pub fn with_queue_depth(self, depth: usize) -> Self

Set the bounded queue depth for pipeline stages.

Values less than 1 are clamped to 1. Use Self::try_with_queue_depth to surface invalid values as an error instead.

pub fn with_async_io(self, enabled: bool) -> Self

Enable or disable async pipeline stage execution.

pub fn try_with_parallelism(self, threads: usize) -> Result<Self>

Fallible variant of Self::with_parallelism.

Errors

Returns an error if threads is 0.

pub fn try_with_queue_depth(self, depth: usize) -> Result<Self>

Fallible variant of Self::with_queue_depth.

Errors

Returns an error if depth is 0.

pub fn effective_parallelism(&self) -> usize

Return the configured worker thread count, clamped to at least 1.

pub fn effective_queue_depth(&self) -> usize

Return the configured queue depth, clamped to at least 1.

pub fn use_threaded_pipeline(&self) -> bool

Returns true when the threaded pipeline should be used.

pub fn resolve_budget_bytes(&self) -> Result<usize>

Resolve the target memory budget in bytes.

Errors

Returns an error if the memory fraction is invalid or system memory cannot be queried.

Trait Implementations

impl Clone for OutOfCoreConfig

fn clone(&self) -> OutOfCoreConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OutOfCoreConfig

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

Formats the value using the given formatter.

impl Default for OutOfCoreConfig

fn default() -> Self

Returns the “default value” for a type.