Struct redis::streams::StreamClaimOptions

pub struct StreamClaimOptions { /* fields omitted */ }

This is supported on crate feature streams only.

Builder options for xclaim_options command.

Implementations

impl StreamClaimOptions

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

Set IDLE cmd arg.

pub fn time(self, ms_time: usize) -> Self

Set TIME cmd arg.

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

Set RETRYCOUNT cmd arg.

pub fn with_force(self) -> Self

Set FORCE cmd arg to true.

pub fn with_justid(self) -> Self

Set JUSTID cmd arg to true. Be advised: the response type changes with this option.

Trait Implementations

impl Debug for StreamClaimOptions

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

Formats the value using the given formatter.

impl Default for StreamClaimOptions

pub fn default() -> StreamClaimOptions

Returns the "default value" for a type.

impl ToRedisArgs for StreamClaimOptions

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.