Struct StreamConfigOptions 

pub struct StreamConfigOptions { /* private fields */ }

Configuration options for xcfgset command

Configures idempotency parameters for a stream. Use the constructor methods to create an instance with at least one parameter set, or use the setter methods to add parameters to an existing instance.

Example

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

// Create with idempotency duration in seconds, optionally add maxsize
let opts1 = StreamConfigOptions::with_idempotency_seconds(300)
    .unwrap()
    .idempotency_maxsize(1000)
    .unwrap();
let _: String = con.xcfgset("key", &opts1).unwrap();

// Or create with maxsize only and optionally add idempotency duration in seconds
let opts2 = StreamConfigOptions::with_idempotency_maxsize(500)
    .unwrap()
    .idempotency_seconds(300)
    .unwrap();
let _: String = con.xcfgset("key", &opts2).unwrap();

Implementations

impl StreamConfigOptions

pub fn with_idempotency_seconds(seconds: u32) -> Result<Self, String>

Create configuration options with IDMP-DURATION parameter

Sets the duration in seconds that each idempotent ID (iid) is kept in the stream’s IDMP map. Default: 100 seconds.

Errors

Returns an error if seconds is not in the valid range 1..=86400 (see IDMP_DURATION_MIN and IDMP_DURATION_MAX)

pub fn with_idempotency_maxsize(size: u16) -> Result<Self, String>

Create configuration options with IDMP-MAXSIZE parameter

Sets the maximum number of most recent idempotent IDs kept for each producer in the stream’s IDMP map. Default: 100 entries.

Errors

Returns an error if size is not in the valid range 1..=10000 (see IDMP_MAXSIZE_MIN and IDMP_MAXSIZE_MAX)

pub fn idempotency_seconds(self, seconds: u32) -> Result<Self, String>

Set or update the IDMP-DURATION parameter

Errors

Returns an error if seconds is not in the valid range 1..=86400 (see IDMP_DURATION_MIN and IDMP_DURATION_MAX)

pub fn idempotency_maxsize(self, size: u16) -> Result<Self, String>

Set or update the IDMP-MAXSIZE parameter

Errors

Returns an error if size is not in the valid range 1..=10000 (see IDMP_MAXSIZE_MIN and IDMP_MAXSIZE_MAX)

Trait Implementations

impl Debug for StreamConfigOptions

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

Formats the value using the given formatter.

impl ToRedisArgs for StreamConfigOptions

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.