Struct SetSchema 

pub struct SetSchema {
    pub include_key: bool,
    pub key_column_name: String,
    pub member_column_name: String,
    pub include_row_index: bool,
    pub row_index_column_name: String,
}

Schema configuration for Redis set scanning.

Defines output columns when scanning Redis sets. Each set member becomes a row in the output DataFrame.

Example

use polars_redis::SetSchema;

let schema = SetSchema::new()
    .with_key(true)
    .with_member_column_name("tag");

Output Schema

• _key (optional): The Redis key
• member: The set member value (Utf8)
• _index (optional): Row number

Fields

include_key: bool

Whether to include the Redis key as a column.

key_column_name: String

Name of the key column.

member_column_name: String

Name of the member column.

include_row_index: bool

Whether to include a row index column.

row_index_column_name: String

Name of the row index column.

Implementations

impl SetSchema

pub fn new() -> Self

Create a new SetSchema with default settings.

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

Set whether to include the key column.

pub fn with_key_column_name(self, name: &str) -> Self

Set the key column name.

pub fn with_member_column_name(self, name: &str) -> Self

Set the member column name.

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

Set whether to include a row index column.

pub fn with_row_index_column_name(self, name: &str) -> Self

Set the row index column name.

pub fn to_arrow_schema(&self) -> Schema

Build the Arrow schema for this configuration.

Trait Implementations

impl Clone for SetSchema

fn clone(&self) -> SetSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SetSchema

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

Formats the value using the given formatter.

impl Default for SetSchema

fn default() -> Self

Returns the “default value” for a type.