Struct redis_stream::types::ConsumerOpts[][src]

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: boolgroup: Option<(String, String)>process_pending: boolstart_pos: StartPositiontimeout: usize

Implementations

impl ConsumerOpts[src]

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

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
[src]

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

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

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

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

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

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

Where to start reading messages in the stream.

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

Maximum ms duration to block waiting for messages.

Trait Implementations

impl Debug for ConsumerOpts[src]

impl Default for ConsumerOpts[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.