Struct ConsumerOpts

pub struct ConsumerOpts {
    pub count: Option<usize>,
    pub create_stream_if_not_exists: bool,
    pub group: Option<(String, String)>,
    pub process_pending: bool,
    pub start_pos: StartPosition,
    pub timeout: usize,
}

Builder options for Consumer::init.

Configuration settings for stream consumers (simple or group).

Basic usage

use redis_stream::consumer::{ConsumerOpts, StartPosition};

let opts = ConsumerOpts::default().start_pos(StartPosition::StartOfStream);

Group consumer

Specifying a group (with group_name and consumer_name), will instruct the Consumer to use consumer groups specific commands (like XGROUP CREATE, XREADGROUP or XACK).

use redis_stream::consumer::{ConsumerOpts, StartPosition};

let opts = ConsumerOpts::default()
  .group("my-group", "consumer.1")
  .start_pos(StartPosition::StartOfStream);

Fields

count: Option<usize>

create_stream_if_not_exists: bool

group: Option<(String, String)>

process_pending: bool

start_pos: StartPosition

timeout: usize

Implementations

impl ConsumerOpts

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

Maximum number of message to read from the stream in one batch

pub fn create_stream_if_not_exists( self, create_stream_if_not_exists: bool, ) -> Self

Create the stream in Redis before registering the group (default: true).

pub fn group(self, group_name: &str, consumer_name: &str) -> Self

Name of the group and consumer. Enables Redis group consumer behavior if specified

pub fn process_pending(self, process_pending: bool) -> Self

Start by processing pending messages before switching to real time data (default: true)

pub fn start_pos(self, start_pos: StartPosition) -> Self

Where to start reading messages in the stream.

pub fn timeout(self, timeout: usize) -> Self

Maximum ms duration to block waiting for messages.

Trait Implementations

impl Debug for ConsumerOpts

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

Formats the value using the given formatter.

impl Default for ConsumerOpts

fn default() -> Self

Returns the “default value” for a type.