Struct BatchConfig 

pub struct BatchConfig {
    pub pattern: String,
    pub batch_size: usize,
    pub count_hint: usize,
    pub max_rows: Option<usize>,
    pub parallel: ParallelStrategy,
}

Configuration for batch iteration.

This struct configures how keys are scanned and batched when reading from Redis. It supports environment variable defaults:

• POLARS_REDIS_BATCH_SIZE: Default batch size (default: 1000)
• POLARS_REDIS_COUNT_HINT: Default SCAN COUNT hint (default: 100)

Example

use polars_redis::BatchConfig;

let config = BatchConfig::new("user:*")
    .with_batch_size(500)
    .with_count_hint(200)
    .with_max_rows(10000);

Fields

pattern: String

Key pattern to match (e.g., “user:*”).

batch_size: usize

Number of keys to process per batch.

count_hint: usize

SCAN COUNT hint for Redis.

max_rows: Option<usize>

Maximum total rows to return (None for unlimited).

parallel: ParallelStrategy

Parallel processing strategy.

Implementations

impl BatchConfig

pub fn new(pattern: impl Into<String>) -> Self

Create a new BatchConfig with the given pattern.

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

Set the batch size.

pub fn with_count_hint(self, count: usize) -> Self

Set the COUNT hint for SCAN.

pub fn with_max_rows(self, max: usize) -> Self

Set the maximum number of rows to return.

pub fn with_parallel(self, strategy: ParallelStrategy) -> Self

Set the parallel processing strategy.

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.

impl From<BatchConfig> for ScanOptions

fn from(config: BatchConfig) -> Self

Converts to this type from the input type.

impl From<ScanOptions> for BatchConfig

fn from(opts: ScanOptions) -> Self

Converts to this type from the input type.