Struct StreamAddOptions 

pub struct StreamAddOptions { /* private fields */ }

Available on crate feature streams only.

Builder options for xadd_options command

Implementations

impl StreamAddOptions

pub fn nomkstream(self) -> Self

Set the NOMKSTREAM flag on which prevents creating a stream for the XADD operation

pub fn trim(self, trim: StreamTrimStrategy) -> Self

Enable trimming when adding using the given trim strategy

pub fn set_deletion_policy(self, deletion_policy: StreamDeletionPolicy) -> Self

Set the deletion policy for the XADD operation

pub fn idmp( self, producer_id: impl Into<String>, idempotent_id: impl Into<String>, ) -> Self

Enable idempotent message production with manual mode (IDMP)

Manual mode requires both producer ID and idempotent ID to be provided. The producer ID uniquely identifies the message producer. The idempotent ID uniquely identifies this specific message.

Example

use redis::{Commands, streams::StreamAddOptions};

let opts = StreamAddOptions::default()
    .idmp("producer-1", "iid-1");
let _: Option<String> = con.xadd_options(
    "key",
    "*",
    &[("field", "value")],
    &opts
).unwrap();

pub fn idmpauto(self, producer_id: impl Into<String>) -> Self

Enable idempotent message production with automatic mode (IDMPAUTO)

Automatic mode requires only a producer ID to be provided. Redis automatically generates the idempotent ID based on the message content.

Example

use redis::{Commands, streams::StreamAddOptions};

let opts = StreamAddOptions::default()
    .idmpauto("producer-1");
let _: Option<String> = con.xadd_options(
    "key",
    "*",
    &[("field", "value")],
    &opts
).unwrap();

Trait Implementations

impl Debug for StreamAddOptions

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

Formats the value using the given formatter.

impl Default for StreamAddOptions

fn default() -> StreamAddOptions

Returns the “default value” for a type.

impl ToRedisArgs for StreamAddOptions

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.