Struct BatchConfig 

pub struct BatchConfig {
    pub batch_size: NonZeroUsize,
    pub string_capacity: usize,
    pub binary_capacity: usize,
    pub coerce_types: bool,
    pub max_lob_bytes: Option<usize>,
}

Configuration for batch processing.

Controls memory allocation and processing behavior for batch conversion.

Fields

batch_size: NonZeroUsize

Maximum number of rows per batch.

Uses NonZeroUsize to prevent division-by-zero and infinite loops. Default: 65536 (64K rows).

string_capacity: usize

Initial capacity for string builders (bytes).

Pre-allocating string capacity reduces reallocations. Default: 1MB.

binary_capacity: usize

Initial capacity for binary builders (bytes).

Pre-allocating binary capacity reduces reallocations. Default: 1MB.

coerce_types: bool

Whether to coerce types when possible.

When true, numeric types may be widened (e.g., INT to BIGINT) to avoid precision loss. Default: false.

max_lob_bytes: Option<usize>

Maximum LOB size in bytes before rejecting.

When set, LOB values exceeding this size will trigger an error instead of being materialized. This prevents OOM conditions when processing result sets with large LOB values.

Default: None (no limit).

Implementations

impl BatchConfig

pub fn with_batch_size(batch_size: usize) -> Self

Create a new configuration with the specified batch size.

Panics

Panics if batch_size is zero. Use try_with_batch_size for fallible construction.

pub fn try_with_batch_size(batch_size: usize) -> Option<Self>

Create a new configuration with the specified batch size.

Returns None if batch_size is zero.

pub const fn batch_size_usize(&self) -> usize

Get batch size as usize for iteration.

pub const fn string_capacity(self, capacity: usize) -> Self

Set the string builder capacity.

pub const fn binary_capacity(self, capacity: usize) -> Self

Set the binary builder capacity.

pub const fn coerce_types(self, coerce: bool) -> Self

Enable or disable type coercion.

pub const fn max_lob_bytes(self, max: Option<usize>) -> Self

Set the maximum LOB size in bytes.

LOB values exceeding this size will cause an error during conversion. Set to None to disable the limit (default).

pub const fn small() -> Self

Create a configuration optimized for small result sets.

Uses smaller batch size and buffer capacities.

Panics

Never panics - the batch size is a compile-time constant.

pub const fn large() -> Self

Create a configuration optimized for large result sets.

Uses larger batch size and buffer capacities.

Panics

Never panics - the batch size is a compile-time constant.

Trait Implementations

impl Clone for BatchConfig

fn clone(&self) -> BatchConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BatchConfig

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

Formats the value using the given formatter.

impl Default for BatchConfig

fn default() -> Self

Returns the “default value” for a type.