Struct StreamReadOptions

pub struct StreamReadOptions { /* private fields */ }

Available 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

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

Formats the value using the given formatter.

impl Default for StreamReadOptions

fn default() -> StreamReadOptions

Returns the “default value” for a type.

impl ToRedisArgs for StreamReadOptions

fn write_redis_args<W>(&self, out: &mut W)

where W: ?Sized + 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 num_of_args(&self) -> usize

Returns the number of arguments this value will generate.