Struct StreamScanOptions 

pub struct StreamScanOptions {
    pub scan: ScanOptions,
    pub include_key: bool,
    pub key_column_name: Option<String>,
    pub include_id: bool,
    pub include_timestamp: bool,
    pub include_sequence: bool,
    pub row_index: Option<RowIndex>,
    pub start_id: String,
    pub end_id: String,
    pub count_per_stream: Option<usize>,
    pub fields: Option<Vec<String>>,
}

Options for scanning Redis streams.

Example

use polars_redis::options::StreamScanOptions;

let opts = StreamScanOptions::new("events:*")
    .with_start_id("-")
    .with_end_id("+")
    .with_count_per_stream(1000);

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.

include_id: bool

Whether to include the entry ID.

include_timestamp: bool

Whether to include timestamp.

include_sequence: bool

Whether to include sequence number.

row_index: Option<RowIndex>

Row index configuration.

start_id: String

Start ID for XRANGE (default: “-”).

end_id: String

End ID for XRANGE (default: “+”).

count_per_stream: Option<usize>

Maximum entries per stream.

fields: Option<Vec<String>>

Fields to extract from stream entries.

Implementations

impl StreamScanOptions

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

Create new StreamScanOptions 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_id(self, include: bool) -> Self

Enable or disable the entry ID column.

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

Enable or disable the timestamp column.

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

Enable or disable the sequence column.

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

Set the row index configuration.

pub fn with_start_id(self, id: impl Into<String>) -> Self

Set the start ID for XRANGE.

pub fn with_end_id(self, id: impl Into<String>) -> Self

Set the end ID for XRANGE.

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

Set the maximum entries to fetch per stream.

pub fn with_fields(self, fields: Vec<impl Into<String>>) -> Self

Set the fields to extract from stream entries.

Trait Implementations

impl Clone for StreamScanOptions

fn clone(&self) -> StreamScanOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamScanOptions

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

Formats the value using the given formatter.

impl Default for StreamScanOptions

fn default() -> Self

Returns the “default value” for a type.