Enum StreamTrimStrategy

pub enum StreamTrimStrategy {
    MaxLen(StreamTrimmingMode, usize, Option<usize>),
    MinId(StreamTrimmingMode, String, Option<usize>),
}

Utility enum for passing <MAXLEN|MINID> [=|~] threshold [LIMIT count] arguments into StreamCommands. The enum values the trimming mode (=|~), the threshold, and the optional limit

Variants

MaxLen(StreamTrimmingMode, usize, Option<usize>)

Evicts entries as long as the streams length exceeds threshold. With an optional limit.

MinId(StreamTrimmingMode, String, Option<usize>)

Evicts entries with IDs lower than threshold, where threshold is a stream ID With an optional limit.

Implementations

impl StreamTrimStrategy

pub fn maxlen(trim: StreamTrimmingMode, max_entries: usize) -> Self

Define a MAXLEN trim strategy with the given maximum number of entries

pub fn minid(trim: StreamTrimmingMode, stream_id: impl Into<String>) -> Self

Defines a MINID trim strategy with the given minimum stream ID

pub fn limit(self, limit: usize) -> Self

Set a limit to the number of records to trim in a single operation

Trait Implementations

impl Debug for StreamTrimStrategy

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

Formats the value using the given formatter.

impl ToRedisArgs for StreamTrimStrategy

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.