Struct redis::SetOptions

pub struct SetOptions { /* private fields */ }

Options for the SET command

Example

use redis::{Commands, RedisResult, SetOptions, SetExpiry, ExistenceCheck};
fn set_key_value(
    con: &mut redis::Connection,
    key: &str,
    value: &str,
) -> RedisResult<Vec<usize>> {
    let opts = SetOptions::default()
        .conditional_set(ExistenceCheck::NX)
        .get(true)
        .with_expiration(SetExpiry::EX(60));
    con.set_options(key, value, opts)
}

Implementations

impl SetOptions

pub fn conditional_set(self, existence_check: ExistenceCheck) -> Self

Set the existence check for the SET command

pub fn get(self, get: bool) -> Self

Set the GET option for the SET command

pub fn with_expiration(self, expiration: SetExpiry) -> Self

Set the expiration for the SET command

Trait Implementations

impl Default for SetOptions

fn default() -> SetOptions

Returns the “default value” for a type.

impl ToRedisArgs for SetOptions

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 is_single_arg(&self) -> bool

Returns an indiciation if the value contained is exactly one argument. It returns false if it’s zero or more than one. This is used in some high level functions to intelligently switch between GET and MGET variants.