Struct redis_streams::StreamReadOptions

pub struct StreamReadOptions { /* fields omitted */ }

Builder options for xread_options command.

Methods

impl StreamReadOptions

pub fn read_only(&self) -> bool

pub fn noack(self) -> Self

pub fn block(self, ms: usize) -> Self

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

pub fn group<GN: ToRedisArgs, CN: ToRedisArgs>(
    self,
    group_name: GN,
    consumer_name: CN
) -> Self

Trait Implementations

impl Default for StreamReadOptions

fn default() -> StreamReadOptions

Returns the "default value" for a type.

impl Debug for StreamReadOptions

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

Formats the value using the given formatter.

impl ToRedisArgs for StreamReadOptions

fn write_redis_args<W: ?Sized>(&self, out: &mut W) where
    W: RedisWrite, 

This writes the value into a vector of bytes. Each item is a single argument. Most items generate a single item.

fn to_redis_args(&self) -> Vec<Vec<u8>>

This converts the value into a vector of bytes. Each item is a single argument. Most items generate a vector of a single item.

fn describe_numeric_behavior(&self) -> NumericBehavior

Returns an information about the contained value with regards to it's numeric behavior in a redis context. This is used in some high level concepts to switch between different implementations of redis functions (for instance INCR vs INCRBYFLOAT).

fn is_single_arg(&self) -> bool

Returns an indiciation if the value contained is exactly one argument. It returns false if it's zero or more than one. This is used in some high level functions to intelligently switch between GET and MGET variants.