Struct StringScanOptions 

pub struct StringScanOptions {
    pub scan: ScanOptions,
    pub include_key: bool,
    pub key_column_name: Option<String>,
    pub value_column_name: Option<String>,
    pub row_index: Option<RowIndex>,
}

Options for scanning Redis strings.

Example

use polars_redis::options::StringScanOptions;

let opts = StringScanOptions::new("counter:*")
    .with_batch_size(1000)
    .with_value_column_name("count");

Fields

scan: ScanOptions

Base scan options.

include_key: bool

Whether to include the key column.

key_column_name: Option<String>

Custom name for the key column.

value_column_name: Option<String>

Custom name for the value column.

row_index: Option<RowIndex>

Row index configuration.

Implementations

impl StringScanOptions

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

Create new StringScanOptions 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_n_rows(self, n: usize) -> Self

Set the maximum number of rows to return.

pub fn with_key(self, include: bool) -> Self

Enable or disable the key column.

pub fn with_key_column_name(self, name: impl Into<String>) -> Self

Set a custom name for the key column.

pub fn with_value_column_name(self, name: impl Into<String>) -> Self

Set a custom name for the value column.

pub fn with_row_index(self, name: impl Into<String>, offset: u64) -> Self

Set the row index configuration.

Trait Implementations

impl Clone for StringScanOptions

fn clone(&self) -> StringScanOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StringScanOptions

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

Formats the value using the given formatter.

impl Default for StringScanOptions

fn default() -> Self

Returns the “default value” for a type.