Struct StreamClaimOptions 

pub struct StreamClaimOptions { /* private fields */ }

Options for XCLAIM.

Mirrors redis-rs’s streams::StreamClaimOptions type.

Implementations

impl StreamClaimOptions

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

Set the idle time (ms) of the claimed messages (IDLE).

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

Set the idle time to a specific Unix time in ms (TIME).

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

Set the retry counter (RETRYCOUNT).

pub fn with_force(self) -> Self

Create the PEL entry even if the message is not already pending (FORCE).

pub fn with_justid(self) -> Self

Return only the claimed IDs (JUSTID). The reply type changes with this option.

pub fn with_lastid(self, lastid: impl Into<String>) -> Self

Set the group’s last-delivered ID (LASTID).

Trait Implementations

impl Clone for StreamClaimOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StreamClaimOptions

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

Formats the value using the given formatter.

impl Default for StreamClaimOptions

fn default() -> Self

Returns the “default value” for a type.

impl Eq for StreamClaimOptions

impl PartialEq for StreamClaimOptions

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for StreamClaimOptions

impl ToValkeyArgs for StreamClaimOptions

fn write_valkey_args<W: ?Sized + ValkeyWrite>(&self, out: &mut W)

Writes this value’s argument encoding to out.

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

Returns this value’s argument encoding as a vector.

fn describe_numeric_behavior(&self) -> ValkeyNumericBehavior

The value’s numeric behavior. Defaults to NonNumeric.

fn num_of_args(&self) -> usize

The number of command arguments this value encodes to.