Enum ValueComparison 

#[non_exhaustive]
pub enum ValueComparison {
    IFEQ(String),
    IFNE(String),
    IFDEQ(String),
    IFDNE(String),
}

Helper enum that is used to define comparisons between values and their digests

Example

use redis::ValueComparison;

// Create comparisons using constructor methods
let eq_comparison = ValueComparison::ifeq("my_value");
let ne_comparison = ValueComparison::ifne("other_value");
let deq_comparison = ValueComparison::ifdeq("digest_hash");
let dne_comparison = ValueComparison::ifdne("other_digest");

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

IFEQ(String)

Value is equal

IFNE(String)

Value is not equal

IFDEQ(String)

Value’s digest is equal

IFDNE(String)

Value’s digest is not equal

Implementations

impl ValueComparison

pub fn ifeq(value: impl ToSingleRedisArg) -> Self

Create a new IFEQ (if equal) comparison

Performs the operation only if the key’s current value is equal to the provided value.

For SET: Sets the key only if its current value matches. Non-existent keys are not created. For DEL_EX: Deletes the key only if its current value matches. Non-existent keys are ignored.

pub fn ifne(value: impl ToSingleRedisArg) -> Self

Create a new IFNE (if not equal) comparison

Performs the operation only if the key’s current value is not equal to the provided value.

For SET: Sets the key only if its current value doesn’t match. Non-existent keys are created. For DEL_EX: Deletes the key only if its current value doesn’t match. Non-existent keys are ignored.

pub fn ifdeq(digest: impl ToSingleRedisArg) -> Self

Create a new IFDEQ (if digest equal) comparison

Performs the operation only if the digest of the key’s current value is equal to the provided digest.

For SET: Sets the key only if its current value’s digest matches. Non-existent keys are not created. For DEL_EX: Deletes the key only if its current value’s digest matches. Non-existent keys are ignored.

Use calculate_value_digest to compute the digest of a value.

pub fn ifdne(digest: impl ToSingleRedisArg) -> Self

Create a new IFDNE (if digest not equal) comparison

Performs the operation only if the digest of the key’s current value is not equal to the provided digest.

For SET: Sets the key only if its current value’s digest doesn’t match. Non-existent keys are created. For DEL_EX: Deletes the key only if its current value’s digest doesn’t match. Non-existent keys are ignored.

Use calculate_value_digest to compute the digest of a value.

Trait Implementations

impl Clone for ValueComparison

fn clone(&self) -> ValueComparison

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ValueComparison

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

Formats the value using the given formatter.

impl ToRedisArgs for ValueComparison

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.