Struct rustis::commands::FtWithCursorOptions

pub struct FtWithCursorOptions { /* private fields */ }

Available on crate feature redis-search only.

options for the withcursor aggregate option

Implementations

impl FtWithCursorOptions

pub fn count(self, read_size: usize) -> FtWithCursorOptions

Control how many rows are read per each cursor fetch.

pub fn maxidle(self, idle_time_ms: u64) -> FtWithCursorOptions

Because cursors are stateful resources which occupy memory on the server, they have a limited lifetime.

In order to safeguard against orphaned/stale cursors, cursors have an idle timeout value. If no activity occurs on the cursor before the idle timeout, the cursor is deleted. The idle timer resets to 0 whenever the cursor is read from using CURSOR READ.

The default idle timeout is 300000 milliseconds (or 300 seconds). You can modify the idle timeout using the MAXIDLE keyword when creating the cursor. Note that the value cannot exceed the default 300s.

Trait Implementations

impl Default for FtWithCursorOptions

fn default() -> FtWithCursorOptions

Returns the “default value” for a type.

impl ToArgs for FtWithCursorOptions

fn write_args(&self, args: &mut CommandArgs)

Write this Rust type as one ore multiple args into CommandArgs.

fn num_args(&self) -> usize

Number arguments generated by this Rust type