Struct redis::streams::StreamReadOptions

pub struct StreamReadOptions { /* fields omitted */ }

This is supported on crate feature streams only.

Builder options for xread_options command.

Implementations

impl StreamReadOptions

pub fn read_only(&self) -> bool

Indicates whether the command is participating in a group and generating ACKs

pub fn noack(self) -> Self

Sets the command so that it avoids adding the message to the PEL in cases where reliability is not a requirement and the occasional message loss is acceptable.

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

Sets the block time in milliseconds.

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

Sets the maximum number of elements to return per stream.

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

Sets the name of a consumer group associated to the stream.

Trait Implementations

impl Debug for StreamReadOptions

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

Formats the value using the given formatter.

impl Default for StreamReadOptions

pub fn default() -> StreamReadOptions

Returns the "default value" for a type.

impl ToRedisArgs for StreamReadOptions

pub 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.

pub 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.

pub 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).

pub 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.