ClusterPipeline in redis::cluster - Rust
Description: Represents a Redis Cluster command pipeline.

Skip to main content

## ClusterPipeline

# Struct ClusterPipeline

Source

    pub struct ClusterPipeline { /* private fields */ }

Available on crate feature `cluster` only.
Expand description

Represents a Redis Cluster command pipeline.

## Implementations§

Source§

### impl ClusterPipeline

A cluster pipeline is almost identical to a normal Pipeline, with two exceptions:

- It does not support transactions
- The following commands can not be used in a cluster pipeline:

    BGREWRITEAOF, BGSAVE, BITOP, BRPOPLPUSH
    CLIENT GETNAME, CLIENT KILL, CLIENT LIST, CLIENT SETNAME, CONFIG GET,
    CONFIG RESETSTAT, CONFIG REWRITE, CONFIG SET
    DBSIZE
    ECHO, EVALSHA
    FLUSHALL, FLUSHDB
    INFO
    KEYS
    LASTSAVE
    MGET, MOVE, MSET, MSETNX, MSETEX
    PING, PUBLISH
    RANDOMKEY, RENAME, RENAMENX, RPOPLPUSH
    SAVE, SCAN, SCRIPT EXISTS, SCRIPT FLUSH, SCRIPT KILL, SCRIPT LOAD, SDIFF, SDIFFSTORE,
    SENTINEL GET MASTER ADDR BY NAME, SENTINEL MASTER, SENTINEL MASTERS, SENTINEL MONITOR,
    SENTINEL REMOVE, SENTINEL SENTINELS, SENTINEL SET, SENTINEL SLAVES, SHUTDOWN, SINTER,
    SINTERSTORE, SLAVEOF, SLOWLOG GET, SLOWLOG LEN, SLOWLOG RESET, SMOVE, SORT, SUNION, SUNIONSTORE
    TIME

Source

#### pub fn new() -> ClusterPipeline

Create an empty pipeline.

Source

#### pub fn with_capacity(capacity: usize) -> ClusterPipeline

Creates an empty pipeline with pre-allocated capacity.

Source

#### pub fn query<T: FromRedisValue>( &self, con: &mut ClusterConnection, ) -> RedisResult<T>

Executes the pipeline and fetches the return values:

    let mut pipe = redis::cluster::cluster_pipe();
    let (k1, k2) : (i32, i32) = pipe
        .cmd("SET").arg("key_1").arg(42).ignore()
        .cmd("SET").arg("key_2").arg(43).ignore()
        .cmd("GET").arg("key_1")
        .cmd("GET").arg("key_2").query(&mut con).unwrap();

Source

#### pub fn exec(&self, con: &mut ClusterConnection) -> RedisResult<()>

This is an alternative to `query`` that can be used if you want to be able to handle a command’s success or failure but don’t care about the command’s response. For example, this is useful for “SET” commands for which the response’s content is not important. It avoids the need to define generic bounds for ().

Source§

### impl ClusterPipeline

Source

#### pub fn add_command(&mut self, cmd: Cmd) -> &mut Self

Adds a command to the cluster pipeline.

Source

#### pub fn cmd(&mut self, name: &str) -> &mut Self

Starts a new command. Functions such as `arg` then become available to add more arguments to that command.

Source

#### pub fn cmd_iter(&self) -> impl Iterator<Item = &Cmd>

Returns an iterator over all the commands currently in this pipeline

Source

#### pub fn ignore(&mut self) -> &mut Self

Instructs the pipeline to ignore the return value of this command.

On any successful result the value from this command is thrown away. This makes result processing through tuples much easier because you do not need to handle all the items you do not care about. If any command received an error from the server, no result will be ignored, so that the user could retrace which command failed.

Source

#### pub fn arg<T: ToRedisArgs>(&mut self, arg: T) -> &mut Self

Adds an argument to the last started command. This works similar to the `arg` method of the `Cmd` object.

Note that this function fails the task if executed on an empty pipeline.

Source

#### pub fn clear(&mut self)

Clear a pipeline object’s internal data structure.

This allows reusing a pipeline object as a clear object while performing a minimal amount of memory released/reallocated.

Source§

### impl ClusterPipeline

Implements RedisJSON commands for cluster pipelines. Unlike the regular commands trait, this returns the cluster pipeline rather than a result directly. Other than that it works the same however.

Source

#### pub fn json_arr_append<'a, K: ToSingleRedisArg, P: ToSingleRedisArg, V: Serialize>( &mut self, key: K, path: P, value: &'a V, ) -> RedisResult<&mut Self>

Available on crate feature `json` only.

Append the JSON `value` to the array at `path` after the last element in it.

Source

#### pub fn json_arr_index<'a, K: ToSingleRedisArg, P: ToSingleRedisArg, V: Serialize>( &mut self, key: K, path: P, value: &'a V, ) -> RedisResult<&mut Self>

Available on crate feature `json` only.

Index array at `path`, returns first occurrence of `value`

Source

#### pub fn json_arr_index_ss<'a, K: ToSingleRedisArg, P: ToSingleRedisArg, V: Serialize>( &mut self, key: K, path: P, value: &'a V, start: &'a isize, stop: &'a isize, ) -> RedisResult<&mut Self>

Available on crate feature `json` only.

Same as `json_arr_index` except takes a `start` and a `stop` value, setting these to `0` will mean they make no effect on the query

The default values for `start` and `stop` are `0`, so pass those in if you want them to take no effect

Source

#### pub fn json_arr_insert<'a, K: ToSingleRedisArg, P: ToSingleRedisArg, V: Serialize>( &mut self, key: K, path: P, index: i64, value: &'a V, ) -> RedisResult<&mut Self>

Available on crate feature `json` only.

Inserts the JSON `value` in the array at `path` before the `index` (shifts to the right).

`index` must be within the array’s range.

Source

#### pub fn json_arr_len<'a, K: ToSingleRedisArg, P: ToSingleRedisArg>( &mut self, key: K, path: P, ) -> RedisResult<&mut Self>

Available on crate feature `json` only.

Reports the length of the JSON Array at `path` in `key`.

Source

#### pub fn json_arr_pop<'a, K: ToSingleRedisArg, P: ToSingleRedisArg>( &mut self, key: K, path: P, index: i64, ) -> RedisResult<&mut Self>

Available on crate feature `json` only.

Removes and returns an element from the `index` in the array.

`index` defaults to `-1` (the end of the array).

Source

#### pub fn json_arr_trim<'a, K: ToSingleRedisArg, P: ToSingleRedisArg>( &mut self, key: K, path: P, start: i64, stop: i64, ) -> RedisResult<&mut Self>

Available on crate feature `json` only.

Trims an array so that it contains only the specified inclusive range of elements.

This command is extremely forgiving and using it with out-of-range indexes will not produce an error. There are a few differences between how RedisJSON v2.0 and legacy versions handle out-of-range indexes.

Source

#### pub fn json_clear<'a, K: ToSingleRedisArg, P: ToSingleRedisArg>( &mut self, key: K, path: P, ) -> RedisResult<&mut Self>

Available on crate feature `json` only.

Clears container values (Arrays/Objects), and sets numeric values to 0.

Source

#### pub fn json_del<'a, K: ToSingleRedisArg, P: ToSingleRedisArg>( &mut self, key: K, path: P, ) -> RedisResult<&mut Self>

Available on crate feature `json` only.

Deletes a value at `path`.

Source

#### pub fn json_get<'a, K: ToSingleRedisArg, P: ToRedisArgs>( &mut self, key: K, path: P, ) -> RedisResult<&mut Self>

Available on crate feature `json` only.

Gets JSON Value at `path`.

With RedisJSON commands, you have to note that all results will be wrapped in square brackets (or empty brackets if not found). If you want to deserialize it with e.g. `serde_json` you have to use `Vec<T>` for your output type instead of `T`.

Source

#### pub fn json_mget<'a, K: ToRedisArgs, P: ToSingleRedisArg>( &mut self, key: K, path: P, ) -> RedisResult<&mut Self>

Available on crate feature `json` only.

Gets JSON Values at `path`.

With RedisJSON commands, you have to note that all results will be wrapped in square brackets (or empty brackets if not found). If you want to deserialize it with e.g. `serde_json` you have to use `Vec<T>` for your output type instead of `T`.

Source

#### pub fn json_num_incr_by<'a, K: ToSingleRedisArg, P: ToSingleRedisArg>( &mut self, key: K, path: P, value: i64, ) -> RedisResult<&mut Self>

Available on crate feature `json` only.

Increments the number value stored at `path` by `number`.

Source

#### pub fn json_obj_keys<'a, K: ToSingleRedisArg, P: ToSingleRedisArg>( &mut self, key: K, path: P, ) -> RedisResult<&mut Self>

Available on crate feature `json` only.

Returns the keys in the object that’s referenced by `path`.

Source

#### pub fn json_obj_len<'a, K: ToSingleRedisArg, P: ToSingleRedisArg>( &mut self, key: K, path: P, ) -> RedisResult<&mut Self>

Available on crate feature `json` only.

Reports the number of keys in the JSON Object at `path` in `key`.

Source

#### pub fn json_set<'a, K: ToSingleRedisArg, P: ToSingleRedisArg, V: Serialize>( &mut self, key: K, path: P, value: &'a V, ) -> RedisResult<&mut Self>

Available on crate feature `json` only.

Sets the JSON Value at `path` in `key`.

Source

#### pub fn json_mset<'a, K: ToSingleRedisArg, P: ToSingleRedisArg, V: Serialize>( &mut self, key_path_values: &'a [(K, P, V)], ) -> RedisResult<&mut Self>

Available on crate feature `json` only.

Sets the value at the path per key, for every given tuple.

Source

#### pub fn json_str_append<'a, K: ToSingleRedisArg, P: ToSingleRedisArg, V: ToSingleRedisArg>( &mut self, key: K, path: P, value: V, ) -> RedisResult<&mut Self>

Available on crate feature `json` only.

Appends the `json-string` values to the string at `path`.

Source

#### pub fn json_str_len<'a, K: ToSingleRedisArg, P: ToSingleRedisArg>( &mut self, key: K, path: P, ) -> RedisResult<&mut Self>

Available on crate feature `json` only.

Reports the length of the JSON String at `path` in `key`.

Source

#### pub fn json_toggle<'a, K: ToSingleRedisArg, P: ToSingleRedisArg>( &mut self, key: K, path: P, ) -> RedisResult<&mut Self>

Available on crate feature `json` only.

Toggle a `boolean` value stored at `path`.

Source

#### pub fn json_type<'a, K: ToSingleRedisArg, P: ToSingleRedisArg>( &mut self, key: K, path: P, ) -> RedisResult<&mut Self>

Available on crate feature `json` only.

Reports the type of JSON value at `path`.

Source§

### impl ClusterPipeline

Source

#### pub fn get<'a, K: ToSingleRedisArg>(&mut self, key: K) -> &mut Self

Get the value of a key. If key is a vec this becomes an `MGET` (if using `TypedCommands`, you should specifically use `mget` to get the correct return type. Redis Docs

Source

#### pub fn mget<'a, K: ToRedisArgs>(&mut self, key: K) -> &mut Self

Get values of keys Redis Docs

Source

#### pub fn keys<'a, K: ToSingleRedisArg>(&mut self, key: K) -> &mut Self

Gets all keys matching pattern Redis Docs

Source

#### pub fn set<'a, K: ToSingleRedisArg, V: ToSingleRedisArg>( &mut self, key: K, value: V, ) -> &mut Self

Set the string value of a key. Redis Docs

Source

#### pub fn set_options<'a, K: ToSingleRedisArg, V: ToSingleRedisArg>( &mut self, key: K, value: V, options: SetOptions, ) -> &mut Self

Set the string value of a key with options. Redis Docs

Source

#### pub fn mset<'a, K: ToRedisArgs, V: ToRedisArgs>( &mut self, items: &'a [(K, V)], ) -> &mut Self

Sets multiple keys to their values. Redis Docs

Source

#### pub fn set_ex<'a, K: ToSingleRedisArg, V: ToSingleRedisArg>( &mut self, key: K, value: V, seconds: u64, ) -> &mut Self

Set the value and expiration of a key. Redis Docs

Source

#### pub fn pset_ex<'a, K: ToSingleRedisArg, V: ToSingleRedisArg>( &mut self, key: K, value: V, milliseconds: u64, ) -> &mut Self

Set the value and expiration in milliseconds of a key. Redis Docs

Source

#### pub fn set_nx<'a, K: ToSingleRedisArg, V: ToSingleRedisArg>( &mut self, key: K, value: V, ) -> &mut Self

Set the value of a key, only if the key does not exist Redis Docs

Source

#### pub fn mset_nx<'a, K: ToRedisArgs, V: ToRedisArgs>( &mut self, items: &'a [(K, V)], ) -> &mut Self

Sets multiple keys to their values failing if at least one already exists. Redis Docs

Source

#### pub fn mset_ex<'a, K: ToRedisArgs, V: ToRedisArgs>( &mut self, items: &'a [(K, V)], options: MSetOptions, ) -> &mut Self

Sets the given keys to their respective values. This command is an extension of the MSETNX that adds expiration and XX options. Redis Docs

Source

#### pub fn getset<'a, K: ToSingleRedisArg, V: ToSingleRedisArg>( &mut self, key: K, value: V, ) -> &mut Self

Set the string value of a key and return its old value. Redis Docs

Source

#### pub fn getrange<'a, K: ToSingleRedisArg>( &mut self, key: K, from: isize, to: isize, ) -> &mut Self

Get a range of bytes/substring from the value of a key. Negative values provide an offset from the end of the value. Redis returns an empty string if the key doesn’t exist, not Nil Redis Docs

Source

#### pub fn setrange<'a, K: ToSingleRedisArg, V: ToSingleRedisArg>( &mut self, key: K, offset: isize, value: V, ) -> &mut Self

Overwrite the part of the value stored in key at the specified offset. Redis Docs

Source

#### pub fn del<'a, K: ToRedisArgs>(&mut self, key: K) -> &mut Self

Delete one or more keys. Returns the number of keys deleted. Redis Docs

Source

#### pub fn del_ex<'a, K: ToSingleRedisArg>( &mut self, key: K, value_comparison: ValueComparison, ) -> &mut Self

Conditionally removes the specified key. A key is ignored if it does not exist. IFEQ `match-value` - Delete the key only if its value is equal to `match-value` IFNE `match-value` - Delete the key only if its value is not equal to `match-value` IFDEQ `match-digest` - Delete the key only if the digest of its value is equal to `match-digest` IFDNE `match-digest` - Delete the key only if the digest of its value is not equal to `match-digest` Redis Docs

Source

#### pub fn digest<'a, K: ToSingleRedisArg>(&mut self, key: K) -> &mut Self

Get the hex signature of the value stored in the specified key. For the digest, Redis will use XXH3 Redis Docs

Source

#### pub fn exists<'a, K: ToRedisArgs>(&mut self, key: K) -> &mut Self

Determine if a key exists. Redis Docs

Source

#### pub fn key_type<'a, K: ToSingleRedisArg>(&mut self, key: K) -> &mut Self

Determine the type of key. Redis Docs

Source

#### pub fn expire<'a, K: ToSingleRedisArg>( &mut self, key: K, seconds: i64, ) -> &mut Self

Set a key’s time to live in seconds. Returns whether expiration was set. Redis Docs

Source

#### pub fn expire_at<'a, K: ToSingleRedisArg>( &mut self, key: K, ts: i64, ) -> &mut Self

Set the expiration for a key as a UNIX timestamp. Returns whether expiration was set. Redis Docs

Source

#### pub fn pexpire<'a, K: ToSingleRedisArg>(&mut self, key: K, ms: i64) -> &mut Self

Set a key’s time to live in milliseconds. Returns whether expiration was set. Redis Docs

Source

#### pub fn pexpire_at<'a, K: ToSingleRedisArg>( &mut self, key: K, ts: i64, ) -> &mut Self

Set the expiration for a key as a UNIX timestamp in milliseconds. Returns whether expiration was set. Redis Docs

Source

#### pub fn expire_time<'a, K: ToSingleRedisArg>(&mut self, key: K) -> &mut Self

Get the absolute Unix expiration timestamp in seconds. Returns `ExistsButNotRelevant` if key exists but has no expiration time. Redis Docs

Source

#### pub fn pexpire_time<'a, K: ToSingleRedisArg>(&mut self, key: K) -> &mut Self

Get the absolute Unix expiration timestamp in milliseconds. Returns `ExistsButNotRelevant` if key exists but has no expiration time. Redis Docs

Source

#### pub fn persist<'a, K: ToSingleRedisArg>(&mut self, key: K) -> &mut Self

Remove the expiration from a key. Returns whether a timeout was removed. Redis Docs

Source

#### pub fn ttl<'a, K: ToSingleRedisArg>(&mut self, key: K) -> &mut Self

Get the time to live for a key in seconds. Returns `ExistsButNotRelevant` if key exists but has no expiration time. Redis Docs

Source

#### pub fn pttl<'a, K: ToSingleRedisArg>(&mut self, key: K) -> &mut Self

Get the time to live for a key in milliseconds. Returns `ExistsButNotRelevant` if key exists but has no expiration time. Redis Docs

Source

#### pub fn get_ex<'a, K: ToSingleRedisArg>( &mut self, key: K, expire_at: Expiry, ) -> &mut Self

Get the value of a key and set expiration Redis Docs

Source

#### pub fn get_del<'a, K: ToSingleRedisArg>(&mut self, key: K) -> &mut Self

Get the value of a key and delete it Redis Docs

Source

#### pub fn copy<'a, KSrc: ToSingleRedisArg, KDst: ToSingleRedisArg, Db: ToString>( &mut self, source: KSrc, destination: KDst, options: CopyOptions<Db>, ) -> &mut Self

Copy the value from one key to another, returning whether the copy was successful. Redis Docs

Source

#### pub fn rename<'a, K: ToSingleRedisArg, N: ToSingleRedisArg>( &mut self, key: K, new_key: N, ) -> &mut Self

Rename a key. Errors if key does not exist. Redis Docs

Source

#### pub fn rename_nx<'a, K: ToSingleRedisArg, N: ToSingleRedisArg>( &mut self, key: K, new_key: N, ) -> &mut Self

Rename a key, only if the new key does not exist. Errors if key does not exist. Returns whether the key was renamed, or false if the new key already exists. Redis Docs

Source

#### pub fn unlink<'a, K: ToRedisArgs>(&mut self, key: K) -> &mut Self

Unlink one or more keys. This is a non-blocking version of `DEL`. Returns number of keys unlinked. Redis Docs

Source

#### pub fn append<'a, K: ToSingleRedisArg, V: ToSingleRedisArg>( &mut self, key: K, value: V, ) -> &mut Self

Append a value to a key. Returns length of string after operation. Redis Docs

Source

#### pub fn incr<'a, K: ToSingleRedisArg, V: ToSingleRedisArg>( &mut self, key: K, delta: V, ) -> &mut Self

Increment the numeric value of a key by the given amount. This issues a `INCRBY` or `INCRBYFLOAT` depending on the type. If the key does not exist, it is set to 0 before performing the operation.

Source

#### pub fn decr<'a, K: ToSingleRedisArg, V: ToSingleRedisArg>( &mut self, key: K, delta: V, ) -> &mut Self

Decrement the numeric value of a key by the given amount. If the key does not exist, it is set to 0 before performing the operation. Redis Docs

Source

#### pub fn setbit<'a, K: ToSingleRedisArg>( &mut self, key: K, offset: usize, value: bool, ) -> &mut Self

Sets or clears the bit at offset in the string value stored at key. Returns the original bit value stored at offset. Redis Docs

Source

#### pub fn getbit<'a, K: ToSingleRedisArg>( &mut self, key: K, offset: usize, ) -> &mut Self

Returns the bit value at offset in the string value stored at key. Redis Docs

Source

#### pub fn bitcount<'a, K: ToSingleRedisArg>(&mut self, key: K) -> &mut Self

Count set bits in a string. Returns 0 if key does not exist. Redis Docs

Source

#### pub fn bitcount_range<'a, K: ToSingleRedisArg>( &mut self, key: K, start: usize, end: usize, ) -> &mut Self

Count set bits in a string in a range. Returns 0 if key does not exist. Redis Docs

Source

#### pub fn bit_and<'a, D: ToSingleRedisArg, S: ToRedisArgs>( &mut self, dstkey: D, srckeys: S, ) -> &mut Self

Perform a bitwise AND between multiple keys (containing string values) and store the result in the destination key. Returns size of destination string after operation. Redis Docs

Source

#### pub fn bit_or<'a, D: ToSingleRedisArg, S: ToRedisArgs>( &mut self, dstkey: D, srckeys: S, ) -> &mut Self

Perform a bitwise OR between multiple keys (containing string values) and store the result in the destination key. Returns size of destination string after operation. Redis Docs

Source

#### pub fn bit_xor<'a, D: ToSingleRedisArg, S: ToRedisArgs>( &mut self, dstkey: D, srckeys: S, ) -> &mut Self

Perform a bitwise XOR between multiple keys (containing string values) and store the result in the destination key. Returns size of destination string after operation. Redis Docs

Source

#### pub fn bit_not<'a, D: ToSingleRedisArg, S: ToSingleRedisArg>( &mut self, dstkey: D, srckey: S, ) -> &mut Self

Perform a bitwise NOT of the key (containing string values) and store the result in the destination key. Returns size of destination string after operation. Redis Docs

Source

#### pub fn bit_diff<'a, D: ToSingleRedisArg, S: ToRedisArgs>( &mut self, dstkey: D, srckeys: S, ) -> &mut Self

DIFF(X, Y1, Y2, …)
Perform a set difference to extract the members of X that are not members of any of Y1, Y2,….
Logical representation: X ∧ ¬(Y1 ∨ Y2 ∨ …)
Redis Docs

Source

#### pub fn bit_diff1<'a, D: ToSingleRedisArg, S: ToRedisArgs>( &mut self, dstkey: D, srckeys: S, ) -> &mut Self

DIFF1(X, Y1, Y2, …) (Relative complement difference)
Perform a relative complement set difference to extract the members of one or more of Y1, Y2,… that are not members of X.
Logical representation: ¬X ∧ (Y1 ∨ Y2 ∨ …)
Redis Docs

Source

#### pub fn bit_and_or<'a, D: ToSingleRedisArg, S: ToRedisArgs>( &mut self, dstkey: D, srckeys: S, ) -> &mut Self

ANDOR(X, Y1, Y2, …)
Perform an “intersection of union(s)” operation to extract the members of X that are also members of one or more of Y1, Y2,….
Logical representation: X ∧ (Y1 ∨ Y2 ∨ …)
Redis Docs

Source

#### pub fn bit_one<'a, D: ToSingleRedisArg, S: ToRedisArgs>( &mut self, dstkey: D, srckeys: S, ) -> &mut Self

ONE(X, Y1, Y2, …)
Perform an “exclusive membership” operation to extract the members of exactly one of X, Y1, Y2, ….
Logical representation: (X ∨ Y1 ∨ Y2 ∨ …) ∧ ¬((X ∧ Y1) ∨ (X ∧ Y2) ∨ (Y1 ∧ Y2) ∨ (Y1 ∧ Y3) ∨ …)
Redis Docs

Source

#### pub fn strlen<'a, K: ToSingleRedisArg>(&mut self, key: K) -> &mut Self

Get the length of the value stored in a key. 0 if key does not exist. Redis Docs

Source

#### pub fn hget<'a, K: ToSingleRedisArg, F: ToSingleRedisArg>( &mut self, key: K, field: F, ) -> &mut Self

Gets a single (or multiple) fields from a hash.

Source

#### pub fn hmget<'a, K: ToSingleRedisArg, F: ToRedisArgs>( &mut self, key: K, fields: F, ) -> &mut Self

Gets multiple fields from a hash. Redis Docs

Source

#### pub fn hget_ex<'a, K: ToSingleRedisArg, F: ToRedisArgs>( &mut self, key: K, fields: F, expire_at: Expiry, ) -> &mut Self

Get the value of one or more fields of a given hash key, and optionally set their expiration Redis Docs

Source

#### pub fn hdel<'a, K: ToSingleRedisArg, F: ToRedisArgs>( &mut self, key: K, field: F, ) -> &mut Self

Deletes a single (or multiple) fields from a hash. Returns number of fields deleted. Redis Docs

Source

#### pub fn hget_del<'a, K: ToSingleRedisArg, F: ToRedisArgs>( &mut self, key: K, fields: F, ) -> &mut Self

Get and delete the value of one or more fields of a given hash key Redis Docs

Source

#### pub fn hset<'a, K: ToSingleRedisArg, F: ToSingleRedisArg, V: ToSingleRedisArg>( &mut self, key: K, field: F, value: V, ) -> &mut Self

Sets a single field in a hash. Returns number of fields added. Redis Docs

Source

#### pub fn hset_ex<'a, K: ToSingleRedisArg, F: ToRedisArgs, V: ToRedisArgs>( &mut self, key: K, hash_field_expiration_options: &'a HashFieldExpirationOptions, fields_values: &'a [(F, V)], ) -> &mut Self

Set the value of one or more fields of a given hash key, and optionally set their expiration Redis Docs

Source

#### pub fn hset_nx<'a, K: ToSingleRedisArg, F: ToSingleRedisArg, V: ToSingleRedisArg>( &mut self, key: K, field: F, value: V, ) -> &mut Self

Sets a single field in a hash if it does not exist. Returns whether the field was added. Redis Docs

Source

#### pub fn hset_multiple<'a, K: ToSingleRedisArg, F: ToRedisArgs, V: ToRedisArgs>( &mut self, key: K, items: &'a [(F, V)], ) -> &mut Self

Sets multiple fields in a hash. Redis Docs

Source

#### pub fn hincr<'a, K: ToSingleRedisArg, F: ToSingleRedisArg, D: ToSingleRedisArg>( &mut self, key: K, field: F, delta: D, ) -> &mut Self

Increments a value. Returns the new value of the field after incrementation.

Source

#### pub fn hexists<'a, K: ToSingleRedisArg, F: ToSingleRedisArg>( &mut self, key: K, field: F, ) -> &mut Self

Checks if a field in a hash exists. Redis Docs

Source

#### pub fn httl<'a, K: ToSingleRedisArg, F: ToRedisArgs>( &mut self, key: K, fields: F, ) -> &mut Self

Get one or more fields’ TTL in seconds. Redis Docs

Source

#### pub fn hpttl<'a, K: ToSingleRedisArg, F: ToRedisArgs>( &mut self, key: K, fields: F, ) -> &mut Self

Get one or more fields’ TTL in milliseconds. Redis Docs

Source

#### pub fn hexpire<'a, K: ToSingleRedisArg, F: ToRedisArgs>( &mut self, key: K, seconds: i64, opt: ExpireOption, fields: F, ) -> &mut Self

Set one or more fields’ time to live in seconds. Returns an array where each element corresponds to the field at the same index in the fields argument. Each element of the array is either: 0 if the specified condition has not been met. 1 if the expiration time was updated. 2 if called with 0 seconds. Errors if provided key exists but is not a hash. Redis Docs

Source

#### pub fn hexpire_at<'a, K: ToSingleRedisArg, F: ToRedisArgs>( &mut self, key: K, ts: i64, opt: ExpireOption, fields: F, ) -> &mut Self

Set the expiration for one or more fields as a UNIX timestamp in seconds. Returns an array where each element corresponds to the field at the same index in the fields argument. Each element of the array is either: 0 if the specified condition has not been met. 1 if the expiration time was updated. 2 if called with a time in the past. Errors if provided key exists but is not a hash. Redis Docs

Source

#### pub fn hexpire_time<'a, K: ToSingleRedisArg, F: ToRedisArgs>( &mut self, key: K, fields: F, ) -> &mut Self

Returns the absolute Unix expiration timestamp in seconds. Redis Docs

Source

#### pub fn hpersist<'a, K: ToSingleRedisArg, F: ToRedisArgs>( &mut self, key: K, fields: F, ) -> &mut Self

Remove the expiration from a key. Returns 1 if the expiration was removed. Redis Docs

Source

#### pub fn hpexpire<'a, K: ToSingleRedisArg, F: ToRedisArgs>( &mut self, key: K, milliseconds: i64, opt: ExpireOption, fields: F, ) -> &mut Self

Set one or more fields’ time to live in milliseconds. Returns an array where each element corresponds to the field at the same index in the fields argument. Each element of the array is either: 0 if the specified condition has not been met. 1 if the expiration time was updated. 2 if called with 0 seconds. Errors if provided key exists but is not a hash. Redis Docs

Source

#### pub fn hpexpire_at<'a, K: ToSingleRedisArg, F: ToRedisArgs>( &mut self, key: K, ts: i64, opt: ExpireOption, fields: F, ) -> &mut Self

Set the expiration for one or more fields as a UNIX timestamp in milliseconds. Returns an array where each element corresponds to the field at the same index in the fields argument. Each element of the array is either: 0 if the specified condition has not been met. 1 if the expiration time was updated. 2 if called with a time in the past. Errors if provided key exists but is not a hash. Redis Docs

Source

#### pub fn hpexpire_time<'a, K: ToSingleRedisArg, F: ToRedisArgs>( &mut self, key: K, fields: F, ) -> &mut Self

Returns the absolute Unix expiration timestamp in seconds. Redis Docs

Source

#### pub fn hkeys<'a, K: ToSingleRedisArg>(&mut self, key: K) -> &mut Self

Gets all the keys in a hash. Redis Docs

Source

#### pub fn hvals<'a, K: ToSingleRedisArg>(&mut self, key: K) -> &mut Self

Gets all the values in a hash. Redis Docs

Source

#### pub fn hgetall<'a, K: ToSingleRedisArg>(&mut self, key: K) -> &mut Self

Gets all the fields and values in a hash. Redis Docs

Source

#### pub fn hlen<'a, K: ToSingleRedisArg>(&mut self, key: K) -> &mut Self

Gets the length of a hash. Returns 0 if key does not exist. Redis Docs

Source

#### pub fn blmove<'a, S: ToSingleRedisArg, D: ToSingleRedisArg>( &mut self, srckey: S, dstkey: D, src_dir: Direction, dst_dir: Direction, timeout: f64, ) -> &mut Self

Pop an element from a list, push it to another list and return it; or block until one is available Redis Docs

Source

#### pub fn blmpop<'a, K: ToRedisArgs>( &mut self, timeout: f64, numkeys: usize, key: K, dir: Direction, count: usize, ) -> &mut Self

Pops `count` elements from the first non-empty list key from the list of provided key names; or blocks until one is available. Redis Docs

Source

#### pub fn blpop<'a, K: ToRedisArgs>(&mut self, key: K, timeout: f64) -> &mut Self

Remove and get the first element in a list, or block until one is available. Redis Docs

Source

#### pub fn brpop<'a, K: ToRedisArgs>(&mut self, key: K, timeout: f64) -> &mut Self

Remove and get the last element in a list, or block until one is available. Redis Docs

Source

#### pub fn brpoplpush<'a, S: ToSingleRedisArg, D: ToSingleRedisArg>( &mut self, srckey: S, dstkey: D, timeout: f64, ) -> &mut Self

Pop a value from a list, push it to another list and return it; or block until one is available. Redis Docs

Source

#### pub fn lindex<'a, K: ToSingleRedisArg>( &mut self, key: K, index: isize, ) -> &mut Self

Get an element from a list by its index. Redis Docs

Source

#### pub fn linsert_before<'a, K: ToSingleRedisArg, P: ToSingleRedisArg, V: ToSingleRedisArg>( &mut self, key: K, pivot: P, value: V, ) -> &mut Self

Insert an element before another element in a list. Redis Docs

Source

#### pub fn linsert_after<'a, K: ToSingleRedisArg, P: ToSingleRedisArg, V: ToSingleRedisArg>( &mut self, key: K, pivot: P, value: V, ) -> &mut Self

Insert an element after another element in a list. Redis Docs

Source

#### pub fn llen<'a, K: ToSingleRedisArg>(&mut self, key: K) -> &mut Self

Returns the length of the list stored at key. Redis Docs

Source

#### pub fn lmove<'a, S: ToSingleRedisArg, D: ToSingleRedisArg>( &mut self, srckey: S, dstkey: D, src_dir: Direction, dst_dir: Direction, ) -> &mut Self

Pop an element a list, push it to another list and return it Redis Docs

Source

#### pub fn lmpop<'a, K: ToRedisArgs>( &mut self, numkeys: usize, key: K, dir: Direction, count: usize, ) -> &mut Self

Pops `count` elements from the first non-empty list key from the list of provided key names. Redis Docs

Source

#### pub fn lpop<'a, K: ToSingleRedisArg>( &mut self, key: K, count: Option<NonZeroUsize>, ) -> &mut Self

Removes and returns the up to `count` first elements of the list stored at key.

If `count` is not specified, then defaults to first element. Redis Docs

Source

#### pub fn lpos<'a, K: ToSingleRedisArg, V: ToSingleRedisArg>( &mut self, key: K, value: V, options: LposOptions, ) -> &mut Self

Returns the index of the first matching value of the list stored at key. Redis Docs

Source

#### pub fn lpush<'a, K: ToSingleRedisArg, V: ToRedisArgs>( &mut self, key: K, value: V, ) -> &mut Self

Insert all the specified values at the head of the list stored at key. Redis Docs

Source

#### pub fn lpush_exists<'a, K: ToSingleRedisArg, V: ToRedisArgs>( &mut self, key: K, value: V, ) -> &mut Self

Inserts a value at the head of the list stored at key, only if key already exists and holds a list. Redis Docs

Source

#### pub fn lrange<'a, K: ToSingleRedisArg>( &mut self, key: K, start: isize, stop: isize, ) -> &mut Self

Returns the specified elements of the list stored at key. Redis Docs

Source

#### pub fn lrem<'a, K: ToSingleRedisArg, V: ToSingleRedisArg>( &mut self, key: K, count: isize, value: V, ) -> &mut Self

Removes the first count occurrences of elements equal to value from the list stored at key. Redis Docs

Source

#### pub fn ltrim<'a, K: ToSingleRedisArg>( &mut self, key: K, start: isize, stop: isize, ) -> &mut Self

Trim an existing list so that it will contain only the specified range of elements specified. Redis Docs

Source

#### pub fn lset<'a, K: ToSingleRedisArg, V: ToSingleRedisArg>( &mut self, key: K, index: isize, value: V, ) -> &mut Self

Sets the list element at index to value Redis Docs

Source

#### pub fn ping<'a>(&mut self) -> &mut Self

Sends a ping to the server Redis Docs

Source

#### pub fn ping_message<'a, K: ToSingleRedisArg>(&mut self, message: K) -> &mut Self

Sends a ping with a message to the server Redis Docs

Source

#### pub fn rpop<'a, K: ToSingleRedisArg>( &mut self, key: K, count: Option<NonZeroUsize>, ) -> &mut Self

Removes and returns the up to `count` last elements of the list stored at key

If `count` is not specified, then defaults to last element. Redis Docs

Source

#### pub fn rpoplpush<'a, K: ToSingleRedisArg, D: ToSingleRedisArg>( &mut self, key: K, dstkey: D, ) -> &mut Self

Pop a value from a list, push it to another list and return it. Redis Docs

Source

#### pub fn rpush<'a, K: ToSingleRedisArg, V: ToRedisArgs>( &mut self, key: K, value: V, ) -> &mut Self

Insert all the specified values at the tail of the list stored at key. Redis Docs

Source

#### pub fn rpush_exists<'a, K: ToSingleRedisArg, V: ToRedisArgs>( &mut self, key: K, value: V, ) -> &mut Self

Inserts value at the tail of the list stored at key, only if key already exists and holds a list. Redis Docs

Source

#### pub fn sadd<'a, K: ToSingleRedisArg, M: ToRedisArgs>( &mut self, key: K, member: M, ) -> &mut Self

Add one or more members to a set. Redis Docs

Source

#### pub fn scard<'a, K: ToSingleRedisArg>(&mut self, key: K) -> &mut Self

Get the number of members in a set. Redis Docs

Source

#### pub fn sdiff<'a, K: ToRedisArgs>(&mut self, keys: K) -> &mut Self

Subtract multiple sets. Redis Docs

Source

#### pub fn sdiffstore<'a, D: ToSingleRedisArg, K: ToRedisArgs>( &mut self, dstkey: D, keys: K, ) -> &mut Self

Subtract multiple sets and store the resulting set in a key. Redis Docs

Source

#### pub fn sinter<'a, K: ToRedisArgs>(&mut self, keys: K) -> &mut Self

Intersect multiple sets. Redis Docs

Source

#### pub fn sinterstore<'a, D: ToSingleRedisArg, K: ToRedisArgs>( &mut self, dstkey: D, keys: K, ) -> &mut Self

Intersect multiple sets and store the resulting set in a key. Redis Docs

Source

#### pub fn sismember<'a, K: ToSingleRedisArg, M: ToSingleRedisArg>( &mut self, key: K, member: M, ) -> &mut Self

Determine if a given value is a member of a set. Redis Docs

Source

#### pub fn smismember<'a, K: ToSingleRedisArg, M: ToRedisArgs>( &mut self, key: K, members: M, ) -> &mut Self

Determine if given values are members of a set. Redis Docs

Source

#### pub fn smembers<'a, K: ToSingleRedisArg>(&mut self, key: K) -> &mut Self

Get all the members in a set. Redis Docs

Source

#### pub fn smove<'a, S: ToSingleRedisArg, D: ToSingleRedisArg, M: ToSingleRedisArg>( &mut self, srckey: S, dstkey: D, member: M, ) -> &mut Self

Move a member from one set to another. Redis Docs

Source

#### pub fn spop<'a, K: ToSingleRedisArg>(&mut self, key: K) -> &mut Self

Remove and return a random member from a set. Redis Docs

Source

#### pub fn srandmember<'a, K: ToSingleRedisArg>(&mut self, key: K) -> &mut Self

Get one random member from a set. Redis Docs

Source

#### pub fn srandmember_multiple<'a, K: ToSingleRedisArg>( &mut self, key: K, count: isize, ) -> &mut Self

Get multiple random members from a set. Redis Docs

Source

#### pub fn srem<'a, K: ToSingleRedisArg, M: ToRedisArgs>( &mut self, key: K, member: M, ) -> &mut Self

Remove one or more members from a set. Redis Docs

Source

#### pub fn sunion<'a, K: ToRedisArgs>(&mut self, keys: K) -> &mut Self

Add multiple sets. Redis Docs

Source

#### pub fn sunionstore<'a, D: ToSingleRedisArg, K: ToRedisArgs>( &mut self, dstkey: D, keys: K, ) -> &mut Self

Add multiple sets and store the resulting set in a key. Redis Docs

Source

#### pub fn zadd<'a, K: ToSingleRedisArg, S: ToSingleRedisArg, M: ToSingleRedisArg>( &mut self, key: K, member: M, score: S, ) -> &mut Self

Add one member to a sorted set, or update its score if it already exists. Redis Docs

Source

#### pub fn zadd_multiple<'a, K: ToSingleRedisArg, S: ToRedisArgs, M: ToRedisArgs>( &mut self, key: K, items: &'a [(S, M)], ) -> &mut Self

Add multiple members to a sorted set, or update its score if it already exists. Redis Docs

Source

#### pub fn zadd_options<'a, K: ToSingleRedisArg, S: ToSingleRedisArg, M: ToSingleRedisArg>( &mut self, key: K, member: M, score: S, options: &'a SortedSetAddOptions, ) -> &mut Self

Add one member to a sorted set, or update its score if it already exists. Redis Docs

Source

#### pub fn zadd_multiple_options<'a, K: ToSingleRedisArg, S: ToRedisArgs, M: ToRedisArgs>( &mut self, key: K, items: &'a [(S, M)], options: &'a SortedSetAddOptions, ) -> &mut Self

Add multiple members to a sorted set, or update its score if it already exists. Redis Docs

Source

#### pub fn zcard<'a, K: ToSingleRedisArg>(&mut self, key: K) -> &mut Self

Get the number of members in a sorted set. Redis Docs

Source

#### pub fn zcount<'a, K: ToSingleRedisArg, M: ToSingleRedisArg, MM: ToSingleRedisArg>( &mut self, key: K, min: M, max: MM, ) -> &mut Self

Count the members in a sorted set with scores within the given values. Redis Docs

Source

#### pub fn zincr<'a, K: ToSingleRedisArg, M: ToSingleRedisArg, D: ToSingleRedisArg>( &mut self, key: K, member: M, delta: D, ) -> &mut Self

Increments the member in a sorted set at key by delta. If the member does not exist, it is added with delta as its score. Redis Docs

Source

#### pub fn zinterstore<'a, D: ToSingleRedisArg, K: ToRedisArgs>( &mut self, dstkey: D, keys: K, ) -> &mut Self

Intersect multiple sorted sets and store the resulting sorted set in a new key using SUM as aggregation function. Redis Docs

Source

#### pub fn zinterstore_min<'a, D: ToSingleRedisArg, K: ToRedisArgs>( &mut self, dstkey: D, keys: K, ) -> &mut Self

Intersect multiple sorted sets and store the resulting sorted set in a new key using MIN as aggregation function. Redis Docs

Source

#### pub fn zinterstore_max<'a, D: ToSingleRedisArg, K: ToRedisArgs>( &mut self, dstkey: D, keys: K, ) -> &mut Self

Intersect multiple sorted sets and store the resulting sorted set in a new key using MAX as aggregation function. Redis Docs

Source

#### pub fn zinterstore_weights<'a, D: ToSingleRedisArg, K: ToRedisArgs, W: ToRedisArgs>( &mut self, dstkey: D, keys: &'a [(K, W)], ) -> &mut Self

`Commands::zinterstore`, but with the ability to specify a multiplication factor for each sorted set by pairing one with each key in a tuple. Redis Docs

Source

#### pub fn zinterstore_min_weights<'a, D: ToSingleRedisArg, K: ToRedisArgs, W: ToRedisArgs>( &mut self, dstkey: D, keys: &'a [(K, W)], ) -> &mut Self

`Commands::zinterstore_min`, but with the ability to specify a multiplication factor for each sorted set by pairing one with each key in a tuple. Redis Docs

Source

#### pub fn zinterstore_max_weights<'a, D: ToSingleRedisArg, K: ToRedisArgs, W: ToRedisArgs>( &mut self, dstkey: D, keys: &'a [(K, W)], ) -> &mut Self

`Commands::zinterstore_max`, but with the ability to specify a multiplication factor for each sorted set by pairing one with each key in a tuple. Redis Docs

Source

#### pub fn zlexcount<'a, K: ToSingleRedisArg, M: ToSingleRedisArg, MM: ToSingleRedisArg>( &mut self, key: K, min: M, max: MM, ) -> &mut Self

Count the number of members in a sorted set between a given lexicographical range. Redis Docs

Source

#### pub fn bzpopmax<'a, K: ToRedisArgs>( &mut self, key: K, timeout: f64, ) -> &mut Self

Removes and returns the member with the highest score in a sorted set. Blocks until a member is available otherwise. Redis Docs

Source

#### pub fn zpopmax<'a, K: ToSingleRedisArg>( &mut self, key: K, count: isize, ) -> &mut Self

Removes and returns up to count members with the highest scores in a sorted set Redis Docs

Source

#### pub fn bzpopmin<'a, K: ToRedisArgs>( &mut self, key: K, timeout: f64, ) -> &mut Self

Removes and returns the member with the lowest score in a sorted set. Blocks until a member is available otherwise. Redis Docs

Source

#### pub fn zpopmin<'a, K: ToSingleRedisArg>( &mut self, key: K, count: isize, ) -> &mut Self

Removes and returns up to count members with the lowest scores in a sorted set Redis Docs

Source

#### pub fn bzmpop_max<'a, K: ToRedisArgs>( &mut self, timeout: f64, keys: K, count: isize, ) -> &mut Self

Removes and returns up to count members with the highest scores, from the first non-empty sorted set in the provided list of key names. Blocks until a member is available otherwise. Redis Docs

Source

#### pub fn zmpop_max<'a, K: ToRedisArgs>( &mut self, keys: K, count: isize, ) -> &mut Self

Removes and returns up to count members with the highest scores, from the first non-empty sorted set in the provided list of key names. Redis Docs

Source

#### pub fn bzmpop_min<'a, K: ToRedisArgs>( &mut self, timeout: f64, keys: K, count: isize, ) -> &mut Self

Removes and returns up to count members with the lowest scores, from the first non-empty sorted set in the provided list of key names. Blocks until a member is available otherwise. Redis Docs

Source

#### pub fn zmpop_min<'a, K: ToRedisArgs>( &mut self, keys: K, count: isize, ) -> &mut Self

Removes and returns up to count members with the lowest scores, from the first non-empty sorted set in the provided list of key names. Redis Docs

Source

#### pub fn zrandmember<'a, K: ToSingleRedisArg>( &mut self, key: K, count: Option<isize>, ) -> &mut Self

Return up to count random members in a sorted set (or 1 if `count == None`) Redis Docs

Source

#### pub fn zrandmember_withscores<'a, K: ToSingleRedisArg>( &mut self, key: K, count: isize, ) -> &mut Self

Return up to count random members in a sorted set with scores Redis Docs

Source

#### pub fn zrange<'a, K: ToSingleRedisArg>( &mut self, key: K, start: isize, stop: isize, ) -> &mut Self

Return a range of members in a sorted set, by index Redis Docs

Source

#### pub fn zrange_withscores<'a, K: ToSingleRedisArg>( &mut self, key: K, start: isize, stop: isize, ) -> &mut Self

Return a range of members in a sorted set, by index with scores. Redis Docs

Source

#### pub fn zrangebylex<'a, K: ToSingleRedisArg, M: ToSingleRedisArg, MM: ToSingleRedisArg>( &mut self, key: K, min: M, max: MM, ) -> &mut Self

Return a range of members in a sorted set, by lexicographical range. Redis Docs

Source

#### pub fn zrangebylex_limit<'a, K: ToSingleRedisArg, M: ToSingleRedisArg, MM: ToSingleRedisArg>( &mut self, key: K, min: M, max: MM, offset: isize, count: isize, ) -> &mut Self

Return a range of members in a sorted set, by lexicographical range with offset and limit. Redis Docs

Source

#### pub fn zrevrangebylex<'a, K: ToSingleRedisArg, MM: ToSingleRedisArg, M: ToSingleRedisArg>( &mut self, key: K, max: MM, min: M, ) -> &mut Self

Return a range of members in a sorted set, by lexicographical range. Redis Docs

Source

#### pub fn zrevrangebylex_limit<'a, K: ToSingleRedisArg, MM: ToSingleRedisArg, M: ToSingleRedisArg>( &mut self, key: K, max: MM, min: M, offset: isize, count: isize, ) -> &mut Self

Return a range of members in a sorted set, by lexicographical range with offset and limit. Redis Docs

Source

#### pub fn zrangebyscore<'a, K: ToSingleRedisArg, M: ToSingleRedisArg, MM: ToSingleRedisArg>( &mut self, key: K, min: M, max: MM, ) -> &mut Self

Return a range of members in a sorted set, by score. Redis Docs

Source

#### pub fn zrangebyscore_withscores<'a, K: ToSingleRedisArg, M: ToSingleRedisArg, MM: ToSingleRedisArg>( &mut self, key: K, min: M, max: MM, ) -> &mut Self

Return a range of members in a sorted set, by score with scores. Redis Docs

Source

#### pub fn zrangebyscore_limit<'a, K: ToSingleRedisArg, M: ToSingleRedisArg, MM: ToSingleRedisArg>( &mut self, key: K, min: M, max: MM, offset: isize, count: isize, ) -> &mut Self

Return a range of members in a sorted set, by score with limit. Redis Docs

Source

#### pub fn zrangebyscore_limit_withscores<'a, K: ToSingleRedisArg, M: ToSingleRedisArg, MM: ToSingleRedisArg>( &mut self, key: K, min: M, max: MM, offset: isize, count: isize, ) -> &mut Self

Return a range of members in a sorted set, by score with limit with scores. Redis Docs

Source

#### pub fn zrank<'a, K: ToSingleRedisArg, M: ToSingleRedisArg>( &mut self, key: K, member: M, ) -> &mut Self

Determine the index of a member in a sorted set. Redis Docs

Source

#### pub fn zrem<'a, K: ToSingleRedisArg, M: ToRedisArgs>( &mut self, key: K, members: M, ) -> &mut Self

Remove one or more members from a sorted set. Redis Docs

Source

#### pub fn zrembylex<'a, K: ToSingleRedisArg, M: ToSingleRedisArg, MM: ToSingleRedisArg>( &mut self, key: K, min: M, max: MM, ) -> &mut Self

Remove all members in a sorted set between the given lexicographical range. Redis Docs

Source

#### pub fn zremrangebyrank<'a, K: ToSingleRedisArg>( &mut self, key: K, start: isize, stop: isize, ) -> &mut Self

Remove all members in a sorted set within the given indexes. Redis Docs

Source

#### pub fn zrembyscore<'a, K: ToSingleRedisArg, M: ToSingleRedisArg, MM: ToSingleRedisArg>( &mut self, key: K, min: M, max: MM, ) -> &mut Self

Remove all members in a sorted set within the given scores. Redis Docs

Source

#### pub fn zrevrange<'a, K: ToSingleRedisArg>( &mut self, key: K, start: isize, stop: isize, ) -> &mut Self

Return a range of members in a sorted set, by index, ordered from high to low. Redis Docs

Source

#### pub fn zrevrange_withscores<'a, K: ToSingleRedisArg>( &mut self, key: K, start: isize, stop: isize, ) -> &mut Self

Return a range of members in a sorted set, by index, with scores ordered from high to low. Redis Docs

Source

#### pub fn zrevrangebyscore<'a, K: ToSingleRedisArg, MM: ToSingleRedisArg, M: ToSingleRedisArg>( &mut self, key: K, max: MM, min: M, ) -> &mut Self

Return a range of members in a sorted set, by score. Redis Docs

Source

#### pub fn zrevrangebyscore_withscores<'a, K: ToSingleRedisArg, MM: ToSingleRedisArg, M: ToSingleRedisArg>( &mut self, key: K, max: MM, min: M, ) -> &mut Self

Return a range of members in a sorted set, by score with scores. Redis Docs

Source

#### pub fn zrevrangebyscore_limit<'a, K: ToSingleRedisArg, MM: ToSingleRedisArg, M: ToSingleRedisArg>( &mut self, key: K, max: MM, min: M, offset: isize, count: isize, ) -> &mut Self

Return a range of members in a sorted set, by score with limit. Redis Docs

Source

#### pub fn zrevrangebyscore_limit_withscores<'a, K: ToSingleRedisArg, MM: ToSingleRedisArg, M: ToSingleRedisArg>( &mut self, key: K, max: MM, min: M, offset: isize, count: isize, ) -> &mut Self

Return a range of members in a sorted set, by score with limit with scores. Redis Docs

Source

#### pub fn zrevrank<'a, K: ToSingleRedisArg, M: ToSingleRedisArg>( &mut self, key: K, member: M, ) -> &mut Self

Determine the index of a member in a sorted set, with scores ordered from high to low. Redis Docs

Source

#### pub fn zscore<'a, K: ToSingleRedisArg, M: ToSingleRedisArg>( &mut self, key: K, member: M, ) -> &mut Self

Get the score associated with the given member in a sorted set. Redis Docs

Source

#### pub fn zscore_multiple<'a, K: ToSingleRedisArg, M: ToRedisArgs>( &mut self, key: K, members: &'a [M], ) -> &mut Self

Get the scores associated with multiple members in a sorted set. Redis Docs

Source

#### pub fn zunionstore<'a, D: ToSingleRedisArg, K: ToRedisArgs>( &mut self, dstkey: D, keys: K, ) -> &mut Self

Unions multiple sorted sets and store the resulting sorted set in a new key using SUM as aggregation function. Redis Docs

Source

#### pub fn zunionstore_min<'a, D: ToSingleRedisArg, K: ToRedisArgs>( &mut self, dstkey: D, keys: K, ) -> &mut Self

Unions multiple sorted sets and store the resulting sorted set in a new key using MIN as aggregation function. Redis Docs

Source

#### pub fn zunionstore_max<'a, D: ToSingleRedisArg, K: ToRedisArgs>( &mut self, dstkey: D, keys: K, ) -> &mut Self

Unions multiple sorted sets and store the resulting sorted set in a new key using MAX as aggregation function. Redis Docs

Source

#### pub fn zunionstore_weights<'a, D: ToSingleRedisArg, K: ToRedisArgs, W: ToRedisArgs>( &mut self, dstkey: D, keys: &'a [(K, W)], ) -> &mut Self

`Commands::zunionstore`, but with the ability to specify a multiplication factor for each sorted set by pairing one with each key in a tuple. Redis Docs

Source

#### pub fn zunionstore_min_weights<'a, D: ToSingleRedisArg, K: ToRedisArgs, W: ToRedisArgs>( &mut self, dstkey: D, keys: &'a [(K, W)], ) -> &mut Self

`Commands::zunionstore_min`, but with the ability to specify a multiplication factor for each sorted set by pairing one with each key in a tuple. Redis Docs

Source

#### pub fn zunionstore_max_weights<'a, D: ToSingleRedisArg, K: ToRedisArgs, W: ToRedisArgs>( &mut self, dstkey: D, keys: &'a [(K, W)], ) -> &mut Self

`Commands::zunionstore_max`, but with the ability to specify a multiplication factor for each sorted set by pairing one with each key in a tuple. Redis Docs

Source

#### pub fn vadd<'a, K: ToRedisArgs, E: ToRedisArgs>( &mut self, key: K, input: VectorAddInput<'a>, element: E, ) -> &mut Self

Available on crate feature `vector-sets` only.

Add a new element into the vector set specified by key. Redis Docs

Source

#### pub fn vadd_options<'a, K: ToRedisArgs, E: ToRedisArgs>( &mut self, key: K, input: VectorAddInput<'a>, element: E, options: &'a VAddOptions, ) -> &mut Self

Available on crate feature `vector-sets` only.

Add a new element into the vector set specified by key with optional parameters for fine-tuning the insertion process. Redis Docs

Source

#### pub fn vcard<'a, K: ToRedisArgs>(&mut self, key: K) -> &mut Self

Available on crate feature `vector-sets` only.

Get the number of members in a vector set. Redis Docs

Source

#### pub fn vdim<'a, K: ToRedisArgs>(&mut self, key: K) -> &mut Self

Available on crate feature `vector-sets` only.

Return the number of dimensions of the vectors in the specified vector set. Redis Docs

Source

#### pub fn vemb<'a, K: ToRedisArgs, E: ToRedisArgs>( &mut self, key: K, element: E, ) -> &mut Self

Available on crate feature `vector-sets` only.

Return the approximate vector associated with a given element in the vector set. Redis Docs

Source

#### pub fn vemb_options<'a, K: ToRedisArgs, E: ToRedisArgs>( &mut self, key: K, element: E, options: &'a VEmbOptions, ) -> &mut Self

Available on crate feature `vector-sets` only.

Return the raw internal representation of the approximate vector associated with a given element in the vector set. Vector sets normalize and may quantize vectors on insertion. VEMB reverses this process to approximate the original vector by de-normalizing and de-quantizing it. Redis Docs

Source

#### pub fn vrem<'a, K: ToRedisArgs, E: ToRedisArgs>( &mut self, key: K, element: E, ) -> &mut Self

Available on crate feature `vector-sets` only.

Remove an element from a vector set. Redis Docs

Source

#### pub fn vsetattr<'a, K: ToRedisArgs, E: ToRedisArgs, J: Serialize>( &mut self, key: K, element: E, json_object: &'a J, ) -> &mut Self

Available on crate feature `vector-sets` only.

Associate a JSON object with an element in a vector set. Use this command to store attributes that can be used in filtered similarity searches with VSIM. Redis Docs

Source

#### pub fn vdelattr<'a, K: ToRedisArgs, E: ToRedisArgs>( &mut self, key: K, element: E, ) -> &mut Self

Available on crate feature `vector-sets` only.

Delete the JSON attributes associated with an element in a vector set. This is an utility function that uses VSETATTR with an empty string. Redis Docs

Source

#### pub fn vgetattr<'a, K: ToRedisArgs, E: ToRedisArgs>( &mut self, key: K, element: E, ) -> &mut Self

Available on crate feature `vector-sets` only.

Return the JSON attributes associated with an element in a vector set. Redis Docs

Source

#### pub fn vinfo<'a, K: ToRedisArgs>(&mut self, key: K) -> &mut Self

Available on crate feature `vector-sets` only.

Return metadata and internal details about a vector set, including size, dimensions, quantization type, and graph structure. Redis Docs

Source

#### pub fn vlinks<'a, K: ToRedisArgs, E: ToRedisArgs>( &mut self, key: K, element: E, ) -> &mut Self

Available on crate feature `vector-sets` only.

Return the neighbors of a specified element in a vector set. The command shows the connections for each layer of the HNSW graph. Redis Docs

Source

#### pub fn vlinks_with_scores<'a, K: ToRedisArgs, E: ToRedisArgs>( &mut self, key: K, element: E, ) -> &mut Self

Available on crate feature `vector-sets` only.

Return the neighbors of a specified element in a vector set. The command shows the connections for each layer of the HNSW graph and includes similarity scores for each neighbor. Redis Docs]

Source

#### pub fn vrandmember<'a, K: ToRedisArgs>(&mut self, key: K) -> &mut Self

Available on crate feature `vector-sets` only.

Return one random elements from a vector set. Redis Docs

Source

#### pub fn vrandmember_multiple<'a, K: ToRedisArgs>( &mut self, key: K, count: usize, ) -> &mut Self

Available on crate feature `vector-sets` only.

Return multiple random elements from a vector set. Redis Docs

Source

#### pub fn vsim<'a, K: ToRedisArgs>( &mut self, key: K, input: VectorSimilaritySearchInput<'a>, ) -> &mut Self

Available on crate feature `vector-sets` only.

Perform vector similarity search. Redis Docs

Source

#### pub fn vsim_options<'a, K: ToRedisArgs>( &mut self, key: K, input: VectorSimilaritySearchInput<'a>, options: &'a VSimOptions, ) -> &mut Self

Available on crate feature `vector-sets` only.

Performs a vector similarity search with optional parameters for customization. Redis Docs

Source

#### pub fn pfadd<'a, K: ToSingleRedisArg, E: ToRedisArgs>( &mut self, key: K, element: E, ) -> &mut Self

Adds the specified elements to the specified HyperLogLog. Redis Docs

Source

#### pub fn pfcount<'a, K: ToRedisArgs>(&mut self, key: K) -> &mut Self

Return the approximated cardinality of the set(s) observed by the HyperLogLog at key(s). Redis Docs

Source

#### pub fn pfmerge<'a, D: ToSingleRedisArg, S: ToRedisArgs>( &mut self, dstkey: D, srckeys: S, ) -> &mut Self

Merge N different HyperLogLogs into a single one. Redis Docs

Source

#### pub fn publish<'a, K: ToSingleRedisArg, E: ToSingleRedisArg>( &mut self, channel: K, message: E, ) -> &mut Self

Posts a message to the given channel. Redis Docs

Source

#### pub fn spublish<'a, K: ToSingleRedisArg, E: ToSingleRedisArg>( &mut self, channel: K, message: E, ) -> &mut Self

Posts a message to the given sharded channel. Redis Docs

Source

#### pub fn object_encoding<'a, K: ToSingleRedisArg>(&mut self, key: K) -> &mut Self

Returns the encoding of a key. Redis Docs

Source

#### pub fn object_idletime<'a, K: ToSingleRedisArg>(&mut self, key: K) -> &mut Self

Returns the time in seconds since the last access of a key. Redis Docs

Source

#### pub fn object_freq<'a, K: ToSingleRedisArg>(&mut self, key: K) -> &mut Self

Returns the logarithmic access frequency counter of a key. Redis Docs

Source

#### pub fn object_refcount<'a, K: ToSingleRedisArg>(&mut self, key: K) -> &mut Self

Returns the reference count of a key. Redis Docs

Source

#### pub fn client_getname<'a>(&mut self) -> &mut Self

Returns the name of the current connection as set by CLIENT SETNAME. Redis Docs

Source

#### pub fn client_id<'a>(&mut self) -> &mut Self

Returns the ID of the current connection. Redis Docs

Source

#### pub fn client_setname<'a, K: ToSingleRedisArg>( &mut self, connection_name: K, ) -> &mut Self

Command assigns a name to the current connection. Redis Docs

Source

#### pub fn acl_load<'a>(&mut self) -> &mut Self

Available on crate feature `acl` only.

When Redis is configured to use an ACL file (with the aclfile configuration option), this command will reload the ACLs from the file, replacing all the current ACL rules with the ones defined in the file. Redis Docs

Source

#### pub fn acl_save<'a>(&mut self) -> &mut Self

Available on crate feature `acl` only.

When Redis is configured to use an ACL file (with the aclfile configuration option), this command will save the currently defined ACLs from the server memory to the ACL file. Redis Docs

Source

#### pub fn acl_list<'a>(&mut self) -> &mut Self

Available on crate feature `acl` only.

Shows the currently active ACL rules in the Redis server. Redis Docs

Source

#### pub fn acl_users<'a>(&mut self) -> &mut Self

Available on crate feature `acl` only.

Shows a list of all the usernames of the currently configured users in the Redis ACL system. Redis Docs

Source

#### pub fn acl_getuser<'a, K: ToSingleRedisArg>(&mut self, username: K) -> &mut Self

Available on crate feature `acl` only.

Returns all the rules defined for an existing ACL user. Redis Docs

Source

#### pub fn acl_setuser<'a, K: ToSingleRedisArg>(&mut self, username: K) -> &mut Self

Available on crate feature `acl` only.

Creates an ACL user without any privilege. Redis Docs

Source

#### pub fn acl_setuser_rules<'a, K: ToSingleRedisArg>( &mut self, username: K, rules: &'a [Rule], ) -> &mut Self

Available on crate feature `acl` only.

Creates an ACL user with the specified rules or modify the rules of an existing user. Redis Docs

Source

#### pub fn acl_deluser<'a, K: ToRedisArgs>( &mut self, usernames: &'a [K], ) -> &mut Self

Available on crate feature `acl` only.

Delete all the specified ACL users and terminate all the connections that are authenticated with such users. Redis Docs

Source

#### pub fn acl_dryrun<'a, K: ToSingleRedisArg, C: ToSingleRedisArg, A: ToRedisArgs>( &mut self, username: K, command: C, args: A, ) -> &mut Self

Available on crate feature `acl` only.

Simulate the execution of a given command by a given user. Redis Docs

Source

#### pub fn acl_cat<'a>(&mut self) -> &mut Self

Available on crate feature `acl` only.

Shows the available ACL categories. Redis Docs

Source

#### pub fn acl_cat_categoryname<'a, K: ToSingleRedisArg>( &mut self, categoryname: K, ) -> &mut Self

Available on crate feature `acl` only.

Shows all the Redis commands in the specified category. Redis Docs

Source

#### pub fn acl_genpass<'a>(&mut self) -> &mut Self

Available on crate feature `acl` only.

Generates a 256-bits password starting from /dev/urandom if available. Redis Docs

Source

#### pub fn acl_genpass_bits<'a>(&mut self, bits: isize) -> &mut Self

Available on crate feature `acl` only.

Generates a 1-to-1024-bits password starting from /dev/urandom if available. Redis Docs

Source

#### pub fn acl_whoami<'a>(&mut self) -> &mut Self

Available on crate feature `acl` only.

Returns the username the current connection is authenticated with. Redis Docs

Source

#### pub fn acl_log<'a>(&mut self, count: isize) -> &mut Self

Available on crate feature `acl` only.

Shows a list of recent ACL security events Redis Docs

Source

#### pub fn acl_log_reset<'a>(&mut self) -> &mut Self

Available on crate feature `acl` only.

Clears the ACL log. Redis Docs

Source

#### pub fn acl_help<'a>(&mut self) -> &mut Self

Available on crate feature `acl` only.

Returns a helpful text describing the different subcommands. Redis Docs

Source

#### pub fn geo_add<'a, K: ToSingleRedisArg, M: ToRedisArgs>( &mut self, key: K, members: M, ) -> &mut Self

Available on crate feature `geospatial` only.

Adds the specified geospatial items to the specified key.

Every member has to be written as a tuple of `(longitude, latitude, member_name)`. It can be a single tuple, or a vector of tuples.

`longitude, latitude` can be set using `redis::geo::Coord`.

Returns the number of elements added to the sorted set, not including elements already existing for which the score was updated.

##### §Example

    use redis::{Commands, Connection, RedisResult};
    use redis::geo::Coord;

    fn add_point(con: &mut Connection) -> (RedisResult<isize>) {
        con.geo_add("my_gis", (Coord::lon_lat(13.361389, 38.115556), "Palermo"))
    }

    fn add_point_with_tuples(con: &mut Connection) -> (RedisResult<isize>) {
        con.geo_add("my_gis", ("13.361389", "38.115556", "Palermo"))
    }

    fn add_many_points(con: &mut Connection) -> (RedisResult<isize>) {
        con.geo_add("my_gis", &[
            ("13.361389", "38.115556", "Palermo"),
            ("15.087269", "37.502669", "Catania")
        ])
    }

Redis Docs

Source

#### pub fn geo_dist<'a, K: ToSingleRedisArg, M1: ToSingleRedisArg, M2: ToSingleRedisArg>( &mut self, key: K, member1: M1, member2: M2, unit: Unit, ) -> &mut Self

Available on crate feature `geospatial` only.

Return the distance between two members in the geospatial index represented by the sorted set.

If one or both the members are missing, the command returns NULL, so it may be convenient to parse its response as either `Option<f64>` or `Option<String>`.

##### §Example

    use redis::{Commands, RedisResult};
    use redis::geo::Unit;

    fn get_dists(con: &mut redis::Connection) {
        let x: RedisResult<f64> = con.geo_dist(
            "my_gis",
            "Palermo",
            "Catania",
            Unit::Kilometers
        );
        // x is Ok(166.2742)

        let x: RedisResult<Option<f64>> = con.geo_dist(
            "my_gis",
            "Palermo",
            "Atlantis",
            Unit::Meters
        );
        // x is Ok(None)
    }

Redis Docs

Source

#### pub fn geo_hash<'a, K: ToSingleRedisArg, M: ToRedisArgs>( &mut self, key: K, members: M, ) -> &mut Self

Available on crate feature `geospatial` only.

Return valid Geohash strings representing the position of one or more members of the geospatial index represented by the sorted set at key.

##### §Example

    use redis::{Commands, RedisResult};

    fn get_hash(con: &mut redis::Connection) {
        let x: RedisResult<Vec<String>> = con.geo_hash("my_gis", "Palermo");
        // x is vec!["sqc8b49rny0"]

        let x: RedisResult<Vec<String>> = con.geo_hash("my_gis", &["Palermo", "Catania"]);
        // x is vec!["sqc8b49rny0", "sqdtr74hyu0"]
    }

Redis Docs

Source

#### pub fn geo_pos<'a, K: ToSingleRedisArg, M: ToRedisArgs>( &mut self, key: K, members: M, ) -> &mut Self

Available on crate feature `geospatial` only.

Return the positions of all the specified members of the geospatial index represented by the sorted set at key.

Every position is a pair of `(longitude, latitude)`. `redis::geo::Coord` can be used to convert these value in a struct.

##### §Example

    use redis::{Commands, RedisResult};
    use redis::geo::Coord;

    fn get_position(con: &mut redis::Connection) {
        let x: RedisResult<Vec<Vec<f64>>> = con.geo_pos("my_gis", &["Palermo", "Catania"]);
        // x is [ [ 13.361389, 38.115556 ], [ 15.087269, 37.502669 ] ];

        let x: Vec<Coord<f64>> = con.geo_pos("my_gis", "Palermo").unwrap();
        // x[0].longitude is 13.361389
        // x[0].latitude is 38.115556
    }

Redis Docs

Source

#### pub fn geo_radius<'a, K: ToSingleRedisArg>( &mut self, key: K, longitude: f64, latitude: f64, radius: f64, unit: Unit, options: RadiusOptions, ) -> &mut Self

Available on crate feature `geospatial` only.

Return the members of a sorted set populated with geospatial information using `geo_add`, which are within the borders of the area specified with the center location and the maximum distance from the center (the radius).

Every item in the result can be read with `redis::geo::RadiusSearchResult`, which support the multiple formats returned by `GEORADIUS`.

    use redis::{Commands, RedisResult};
    use redis::geo::{RadiusOptions, RadiusSearchResult, RadiusOrder, Unit};

    fn radius(con: &mut redis::Connection) -> (Vec<RadiusSearchResult>) {
        let opts = RadiusOptions::default().with_dist().order(RadiusOrder::Asc);
        con.geo_radius("my_gis", 15.90, 37.21, 51.39, Unit::Kilometers, opts).unwrap()
    }

Redis Docs

Source

#### pub fn geo_radius_by_member<'a, K: ToSingleRedisArg, M: ToSingleRedisArg>( &mut self, key: K, member: M, radius: f64, unit: Unit, options: RadiusOptions, ) -> &mut Self

Available on crate feature `geospatial` only.

Retrieve members selected by distance with the center of `member`. The member itself is always contained in the results. Redis Docs

Source

#### pub fn xack<'a, K: ToRedisArgs, G: ToRedisArgs, I: ToRedisArgs>( &mut self, key: K, group: G, ids: &'a [I], ) -> &mut Self

Available on crate feature `streams` only.

Ack pending stream messages checked out by a consumer.

    XACK <key> <group> <id> <id> ... <id>

Redis Docs

Source

#### pub fn xadd<'a, K: ToRedisArgs, ID: ToRedisArgs, F: ToRedisArgs, V: ToRedisArgs>( &mut self, key: K, id: ID, items: &'a [(F, V)], ) -> &mut Self

Available on crate feature `streams` only.

Add a stream message by `key`. Use `*` as the `id` for the current timestamp.

    XADD key <ID or *> [field value] [field value] ...

Redis Docs

Source

#### pub fn xadd_map<'a, K: ToRedisArgs, ID: ToRedisArgs, BTM: ToRedisArgs>( &mut self, key: K, id: ID, map: BTM, ) -> &mut Self

Available on crate feature `streams` only.

BTreeMap variant for adding a stream message by `key`. Use `*` as the `id` for the current timestamp.

    XADD key <ID or *> [rust BTreeMap] ...

Redis Docs

Source

#### pub fn xadd_options<'a, K: ToRedisArgs, ID: ToRedisArgs, I: ToRedisArgs>( &mut self, key: K, id: ID, items: I, options: &'a StreamAddOptions, ) -> &mut Self

Available on crate feature `streams` only.

Add a stream message with options.

Items can be any list type, e.g.

    // static items
    let items = &[("key", "val"), ("key2", "val2")];
    // A map (Can be BTreeMap, HashMap, etc)
    let mut map: BTreeMap<&str, &str> = BTreeMap::new();
    map.insert("ab", "cd");
    map.insert("ef", "gh");
    map.insert("ij", "kl");

    XADD key [NOMKSTREAM] [<MAXLEN|MINID> [~|=] threshold [LIMIT count]] <* | ID> field value [field value] [KEEPREF | DELREF | ACKED] ...

Redis Docs

Source

#### pub fn xadd_maxlen<'a, K: ToSingleRedisArg, ID: ToRedisArgs, F: ToRedisArgs, V: ToRedisArgs>( &mut self, key: K, maxlen: StreamMaxlen, id: ID, items: &'a [(F, V)], ) -> &mut Self

Available on crate feature `streams` only.

Add a stream message while capping the stream at a maxlength.

    XADD key [MAXLEN [~|=] <count>] <ID or *> [field value] [field value] ...

Redis Docs

Source

#### pub fn xadd_maxlen_map<'a, K: ToSingleRedisArg, ID: ToRedisArgs, BTM: ToRedisArgs>( &mut self, key: K, maxlen: StreamMaxlen, id: ID, map: BTM, ) -> &mut Self

Available on crate feature `streams` only.

BTreeMap variant for adding a stream message while capping the stream at a maxlength.

    XADD key [MAXLEN [~|=] <count>] <ID or *> [rust BTreeMap] ...

Redis Docs

Source

#### pub fn xautoclaim_options<'a, K: ToSingleRedisArg, G: ToRedisArgs, C: ToRedisArgs, MIT: ToRedisArgs, S: ToRedisArgs>( &mut self, key: K, group: G, consumer: C, min_idle_time: MIT, start: S, options: StreamAutoClaimOptions, ) -> &mut Self

Available on crate feature `streams` only.

Perform a combined xpending and xclaim flow.

    use redis::{Connection,Commands,RedisResult};
    use redis::streams::{StreamAutoClaimOptions, StreamAutoClaimReply};
    let client = redis::Client::open("redis://127.0.0.1/0").unwrap();
    let mut con = client.get_connection().unwrap();

    let opts = StreamAutoClaimOptions::default();
    let results : RedisResult<StreamAutoClaimReply> = con.xautoclaim_options("k1", "g1", "c1", 10, "0-0", opts);

    XAUTOCLAIM <key> <group> <consumer> <min-idle-time> <start> [COUNT <count>] [JUSTID]

Redis Docs

Source

#### pub fn xclaim<'a, K: ToSingleRedisArg, G: ToRedisArgs, C: ToRedisArgs, MIT: ToRedisArgs, ID: ToRedisArgs>( &mut self, key: K, group: G, consumer: C, min_idle_time: MIT, ids: &'a [ID], ) -> &mut Self

Available on crate feature `streams` only.

Claim pending, unacked messages, after some period of time, currently checked out by another consumer.

This method only accepts the must-have arguments for claiming messages. If optional arguments are required, see `xclaim_options` below.

    XCLAIM <key> <group> <consumer> <min-idle-time> [<ID-1> <ID-2>]

Redis Docs

Source

#### pub fn xclaim_options<'a, K: ToSingleRedisArg, G: ToRedisArgs, C: ToRedisArgs, MIT: ToRedisArgs, ID: ToRedisArgs>( &mut self, key: K, group: G, consumer: C, min_idle_time: MIT, ids: &'a [ID], options: StreamClaimOptions, ) -> &mut Self

Available on crate feature `streams` only.

This is the optional arguments version for claiming unacked, pending messages currently checked out by another consumer.

    use redis::{Connection,Commands,RedisResult};
    use redis::streams::{StreamClaimOptions,StreamClaimReply};
    let client = redis::Client::open("redis://127.0.0.1/0").unwrap();
    let mut con = client.get_connection().unwrap();

    // Claim all pending messages for key "k1",
    // from group "g1", checked out by consumer "c1"
    // for 10ms with RETRYCOUNT 2 and FORCE

    let opts = StreamClaimOptions::default()
        .with_force()
        .retry(2);
    let results: RedisResult<StreamClaimReply> =
        con.xclaim_options("k1", "g1", "c1", 10, &["0"], opts);

    // All optional arguments return a `Result<StreamClaimReply>` with one exception:
    // Passing JUSTID returns only the message `id` and omits the HashMap for each message.

    let opts = StreamClaimOptions::default()
        .with_justid();
    let results: RedisResult<Vec<String>> =
        con.xclaim_options("k1", "g1", "c1", 10, &["0"], opts);

    XCLAIM <key> <group> <consumer> <min-idle-time> <ID-1> <ID-2>
        [IDLE <milliseconds>] [TIME <mstime>] [RETRYCOUNT <count>]
        [FORCE] [JUSTID] [LASTID <lastid>]

Redis Docs

Source

#### pub fn xdel<'a, K: ToSingleRedisArg, ID: ToRedisArgs>( &mut self, key: K, ids: &'a [ID], ) -> &mut Self

Available on crate feature `streams` only.

Deletes a list of `id`s for a given stream `key`.

    XDEL <key> [<ID1> <ID2> ... <IDN>]

Redis Docs

Source

#### pub fn xdel_ex<'a, K: ToRedisArgs, ID: ToRedisArgs>( &mut self, key: K, ids: &'a [ID], options: StreamDeletionPolicy, ) -> &mut Self

Available on crate feature `streams` only.

An extension of the Streams `XDEL` command that provides finer control over how message entries are deleted with respect to consumer groups.

Source

#### pub fn xack_del<'a, K: ToRedisArgs, G: ToRedisArgs, ID: ToRedisArgs>( &mut self, key: K, group: G, ids: &'a [ID], options: StreamDeletionPolicy, ) -> &mut Self

Available on crate feature `streams` only.

A combination of `XACK` and `XDEL` that acknowledges and attempts to delete a list of `ids` for a given stream `key` and consumer `group`.

Source

#### pub fn xgroup_create<'a, K: ToRedisArgs, G: ToRedisArgs, ID: ToRedisArgs>( &mut self, key: K, group: G, id: ID, ) -> &mut Self

Available on crate feature `streams` only.

This command is used for creating a consumer `group`. It expects the stream key to already exist. Otherwise, use `xgroup_create_mkstream` if it doesn’t. The `id` is the starting message id all consumers should read from. Use `$` If you want all consumers to read from the last message added to stream.

    XGROUP CREATE <key> <groupname> <id or $>

Redis Docs

Source

#### pub fn xgroup_createconsumer<'a, K: ToRedisArgs, G: ToRedisArgs, C: ToRedisArgs>( &mut self, key: K, group: G, consumer: C, ) -> &mut Self

Available on crate feature `streams` only.

This creates a `consumer` explicitly (vs implicit via XREADGROUP) for given stream `key.

The return value is either a 0 or a 1 for the number of consumers created 0 means the consumer already exists

    XGROUP CREATECONSUMER <key> <groupname> <consumername>

Redis Docs

Source

#### pub fn xgroup_create_mkstream<'a, K: ToRedisArgs, G: ToRedisArgs, ID: ToRedisArgs>( &mut self, key: K, group: G, id: ID, ) -> &mut Self

Available on crate feature `streams` only.

This is the alternate version for creating a consumer `group` which makes the stream if it doesn’t exist.

    XGROUP CREATE <key> <groupname> <id or $> [MKSTREAM]

Redis Docs

Source

#### pub fn xgroup_setid<'a, K: ToRedisArgs, G: ToRedisArgs, ID: ToRedisArgs>( &mut self, key: K, group: G, id: ID, ) -> &mut Self

Available on crate feature `streams` only.

Alter which `id` you want consumers to begin reading from an existing consumer `group`.

    XGROUP SETID <key> <groupname> <id or $>

Redis Docs

Source

#### pub fn xgroup_destroy<'a, K: ToRedisArgs, G: ToRedisArgs>( &mut self, key: K, group: G, ) -> &mut Self

Available on crate feature `streams` only.

Destroy an existing consumer `group` for a given stream `key`

    XGROUP SETID <key> <groupname> <id or $>

Redis Docs

Source

#### pub fn xgroup_delconsumer<'a, K: ToRedisArgs, G: ToRedisArgs, C: ToRedisArgs>( &mut self, key: K, group: G, consumer: C, ) -> &mut Self

Available on crate feature `streams` only.

This deletes a `consumer` from an existing consumer `group` for given stream `key.

    XGROUP DELCONSUMER <key> <groupname> <consumername>

Redis Docs

Source

#### pub fn xinfo_consumers<'a, K: ToRedisArgs, G: ToRedisArgs>( &mut self, key: K, group: G, ) -> &mut Self

Available on crate feature `streams` only.

This returns all info details about which consumers have read messages for given consumer `group`. Take note of the StreamInfoConsumersReply return type.

It’s possible this return value might not contain new fields added by Redis in future versions.

    XINFO CONSUMERS <key> <group>

Redis Docs

Source

#### pub fn xinfo_groups<'a, K: ToRedisArgs>(&mut self, key: K) -> &mut Self

Available on crate feature `streams` only.

Returns all consumer `group`s created for a given stream `key`. Take note of the StreamInfoGroupsReply return type.

It’s possible this return value might not contain new fields added by Redis in future versions.

    XINFO GROUPS <key>

Redis Docs

Source

#### pub fn xinfo_stream<'a, K: ToRedisArgs>(&mut self, key: K) -> &mut Self

Available on crate feature `streams` only.

Returns info about high-level stream details (first & last message `id`, length, number of groups, etc.) Take note of the StreamInfoStreamReply return type.

It’s possible this return value might not contain new fields added by Redis in future versions.

    XINFO STREAM <key>

Redis Docs

Source

#### pub fn xlen<'a, K: ToRedisArgs>(&mut self, key: K) -> &mut Self

Available on crate feature `streams` only.

Returns the number of messages for a given stream `key`.

    XLEN <key>

Redis Docs

Source

#### pub fn xpending<'a, K: ToRedisArgs, G: ToRedisArgs>( &mut self, key: K, group: G, ) -> &mut Self

Available on crate feature `streams` only.

This is a basic version of making XPENDING command calls which only passes a stream `key` and consumer `group` and it returns details about which consumers have pending messages that haven’t been acked.

You can use this method along with `xclaim` or `xclaim_options` for determining which messages need to be retried.

Take note of the StreamPendingReply return type.

    XPENDING <key> <group> [<start> <stop> <count> [<consumer>]]

Redis Docs

Source

#### pub fn xpending_count<'a, K: ToRedisArgs, G: ToRedisArgs, S: ToRedisArgs, E: ToRedisArgs, C: ToRedisArgs>( &mut self, key: K, group: G, start: S, end: E, count: C, ) -> &mut Self

Available on crate feature `streams` only.

This XPENDING version returns a list of all messages over the range. You can use this for paginating pending messages (but without the message HashMap).

Start and end follow the same rules `xrange` args. Set start to `-` and end to `+` for the entire stream.

Take note of the StreamPendingCountReply return type.

    XPENDING <key> <group> <start> <stop> <count>

Redis Docs

Source

#### pub fn xpending_consumer_count<'a, K: ToRedisArgs, G: ToRedisArgs, S: ToRedisArgs, E: ToRedisArgs, C: ToRedisArgs, CN: ToRedisArgs>( &mut self, key: K, group: G, start: S, end: E, count: C, consumer: CN, ) -> &mut Self

Available on crate feature `streams` only.

An alternate version of `xpending_count` which filters by `consumer` name.

Start and end follow the same rules `xrange` args. Set start to `-` and end to `+` for the entire stream.

Take note of the StreamPendingCountReply return type.

    XPENDING <key> <group> <start> <stop> <count> <consumer>

Redis Docs

Source

#### pub fn xrange<'a, K: ToRedisArgs, S: ToRedisArgs, E: ToRedisArgs>( &mut self, key: K, start: S, end: E, ) -> &mut Self

Available on crate feature `streams` only.

Returns a range of messages in a given stream `key`.

Set `start` to `-` to begin at the first message. Set `end` to `+` to end the most recent message. You can pass message `id` to both `start` and `end`.

Take note of the StreamRangeReply return type.

    XRANGE key start end

Redis Docs

Source

#### pub fn xrange_all<'a, K: ToRedisArgs>(&mut self, key: K) -> &mut Self

Available on crate feature `streams` only.

A helper method for automatically returning all messages in a stream by `key`. Use with caution!

    XRANGE key - +

Redis Docs

Source

#### pub fn xrange_count<'a, K: ToRedisArgs, S: ToRedisArgs, E: ToRedisArgs, C: ToRedisArgs>( &mut self, key: K, start: S, end: E, count: C, ) -> &mut Self

Available on crate feature `streams` only.

A method for paginating a stream by `key`.

    XRANGE key start end [COUNT <n>]

Redis Docs

Source

#### pub fn xread<'a, K: ToRedisArgs, ID: ToRedisArgs>( &mut self, keys: &'a [K], ids: &'a [ID], ) -> &mut Self

Available on crate feature `streams` only.

Read a list of `id`s for each stream `key`. This is the basic form of reading streams. For more advanced control, like blocking, limiting, or reading by consumer `group`, see `xread_options`.

    XREAD STREAMS key_1 key_2 ... key_N ID_1 ID_2 ... ID_N

Redis Docs

Source

#### pub fn xread_options<'a, K: ToRedisArgs, ID: ToRedisArgs>( &mut self, keys: &'a [K], ids: &'a [ID], options: &'a StreamReadOptions, ) -> &mut Self

Available on crate feature `streams` only.

This method handles setting optional arguments for `XREAD` or `XREADGROUP` Redis commands.

    use redis::{Connection,RedisResult,Commands};
    use redis::streams::{StreamReadOptions,StreamReadReply};
    let client = redis::Client::open("redis://127.0.0.1/0").unwrap();
    let mut con = client.get_connection().unwrap();

    // Read 10 messages from the start of the stream,
    // without registering as a consumer group.

    let opts = StreamReadOptions::default()
        .count(10);
    let results: RedisResult<StreamReadReply> =
        con.xread_options(&["k1"], &["0"], &opts);

    // Read all undelivered messages for a given
    // consumer group. Be advised: the consumer group must already
    // exist before making this call. Also note: we're passing
    // '>' as the id here, which means all undelivered messages.

    let opts = StreamReadOptions::default()
        .group("group-1", "consumer-1");
    let results: RedisResult<StreamReadReply> =
        con.xread_options(&["k1"], &[">"], &opts);

    XREAD [BLOCK <milliseconds>] [COUNT <count>]
        STREAMS key_1 key_2 ... key_N
        ID_1 ID_2 ... ID_N

    XREADGROUP [GROUP group-name consumer-name] [BLOCK <milliseconds>] [COUNT <count>] [NOACK]
        STREAMS key_1 key_2 ... key_N
        ID_1 ID_2 ... ID_N

Redis Docs

Source

#### pub fn xrevrange<'a, K: ToRedisArgs, E: ToRedisArgs, S: ToRedisArgs>( &mut self, key: K, end: E, start: S, ) -> &mut Self

Available on crate feature `streams` only.

This is the reverse version of `xrange`. The same rules apply for `start` and `end` here.

    XREVRANGE key end start

Redis Docs

Source

#### pub fn xrevrange_all<'a, K: ToRedisArgs>(&mut self, key: K) -> &mut Self

Available on crate feature `streams` only.

This is the reverse version of `xrange_all`. The same rules apply for `start` and `end` here.

    XREVRANGE key + -

Redis Docs

Source

#### pub fn xrevrange_count<'a, K: ToRedisArgs, E: ToRedisArgs, S: ToRedisArgs, C: ToRedisArgs>( &mut self, key: K, end: E, start: S, count: C, ) -> &mut Self

Available on crate feature `streams` only.

This is the reverse version of `xrange_count`. The same rules apply for `start` and `end` here.

    XREVRANGE key end start [COUNT <n>]

Redis Docs

Source

#### pub fn xtrim<'a, K: ToRedisArgs>( &mut self, key: K, maxlen: StreamMaxlen, ) -> &mut Self

Available on crate feature `streams` only.

Trim a stream `key` to a MAXLEN count.

    XTRIM <key> MAXLEN [~|=] <count>  (Same as XADD MAXLEN option)

Redis Docs

Source

#### pub fn xtrim_options<'a, K: ToRedisArgs>( &mut self, key: K, options: &'a StreamTrimOptions, ) -> &mut Self

Available on crate feature `streams` only.

Trim a stream `key` with full options

    XTRIM <key> <MAXLEN|MINID> [~|=] <threshold> [LIMIT <count>]  (Same as XADD MAXID|MINID options) [KEEPREF | DELREF | ACKED]

Redis Docs

Source

#### pub fn load_script<'a>(&mut self, script: &'a Script) -> &mut Self

Available on crate feature `script` only.

Load a script.

See `invoke_script` to actually run the scripts.

##### §Examples:

    let script = redis::Script::new(r"
        return tonumber(ARGV[1]) + tonumber(ARGV[2]);
    ");
    let (load_res, invok_res): (String, isize) = redis::pipe()
        .load_script(&script)
        .invoke_script(script.arg(1).arg(2))
        .query(&mut con)?;

    assert_eq!(load_res, "1ca80f2366c125a7c43519ce241d5c24c2b64023");
    assert_eq!(invok_res, 3);

Source

#### pub fn invoke_script<'a>( &mut self, invocation: &'a ScriptInvocation<'a>, ) -> &mut Self

Available on crate feature `script` only.

Invoke a prepared script.

Note: Unlike`ScriptInvocation::invoke`, this function does not automatically load the script. If the invoked script did not get loaded beforehand, you need to manually load it (e.g.: using `load_script` or `ScriptInvocation::load`). Otherwise this command will fail.

##### §Examples:

    let script = redis::Script::new(r"
        return tonumber(ARGV[1]) + tonumber(ARGV[2]);
    ");
    let (load_res, invok_1_res, invok_2_res): (String, isize, isize) = redis::pipe()
        .load_script(&script)
        .invoke_script(script.arg(1).arg(2))
        .invoke_script(script.arg(2).arg(3))
        .query(&mut con)?;

    assert_eq!(load_res, "1ca80f2366c125a7c43519ce241d5c24c2b64023");
    assert_eq!(invok_1_res, 3);
    assert_eq!(invok_2_res, 5);

Source

#### pub fn flushall<'a>(&mut self) -> &mut Self

Deletes all the keys of all databases

Whether the flushing happens asynchronously or synchronously depends on the configuration of your Redis server.

To enforce a flush mode, use `Commands::flushall_options`.

    FLUSHALL

Redis Docs

Source

#### pub fn flushall_options<'a>( &mut self, options: &'a FlushAllOptions, ) -> &mut Self

Deletes all the keys of all databases with options

    FLUSHALL [ASYNC|SYNC]

Redis Docs

Source

#### pub fn flushdb<'a>(&mut self) -> &mut Self

Deletes all the keys of the current database

Whether the flushing happens asynchronously or synchronously depends on the configuration of your Redis server.

To enforce a flush mode, use `Commands::flushdb_options`.

    FLUSHDB

Redis Docs

Source

#### pub fn flushdb_options<'a>(&mut self, options: &'a FlushDbOptions) -> &mut Self

Deletes all the keys of the current database with options

    FLUSHDB [ASYNC|SYNC]

Redis Docs

## Trait Implementations§

Source§

### impl Clone for ClusterPipeline

Source§

#### fn clone(&self) -> ClusterPipeline

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from `source`. Read more
Source§

### impl Default for ClusterPipeline

Source§

#### fn default() -> Self

Returns the “default value” for a type. Read more

## Auto Trait Implementations§

§

### impl Freeze for ClusterPipeline

§

### impl RefUnwindSafe for ClusterPipeline

§

### impl Send for ClusterPipeline

§

### impl Sync for ClusterPipeline

§

### impl Unpin for ClusterPipeline

§

### impl UnwindSafe for ClusterPipeline

## Blanket Implementations§

Source§

### impl<T> Any for T
where T: 'static + ?Sized,

Source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
Source§

### impl<T> Borrow<T> for T
where T: ?Sized,

Source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

### impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

### impl<T> CloneToUninit for T
where T: Clone,

Source§

#### unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (`clone_to_uninit`)
Performs copy-assignment from `self` to `dest`. Read more
Source§

### impl<T> DynClone for T
where T: Clone,

Source§

#### fn __clone_box(&self, _: Private) -> *mut ()

Source§

### impl<T> From<T> for T

Source§

#### fn from(t: T) -> T

Returns the argument unchanged.

§

### impl<T> Instrument for T

§

#### fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [`Span`], returning an `Instrumented` wrapper. Read more
§

#### fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current `Span`, returning an `Instrumented` wrapper. Read more
Source§

### impl<T, U> Into<U> for T
where U: From<T>,

Source§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

§

### impl<T> PolicyExt for T
where T: ?Sized,

§

#### fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new `Policy` that returns [`Action::Follow`] only if `self` and `other` return `Action::Follow`. Read more
§

#### fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new `Policy` that returns [`Action::Follow`] if either `self` or `other` returns `Action::Follow`. Read more
Source§

### impl<T> ToOwned for T
where T: Clone,

Source§

#### type Owned = T

The resulting type after obtaining ownership.
Source§

#### fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

#### fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

### impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

#### type Error = Infallible

The type returned in the event of a conversion error.
Source§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

### impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

### impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

#### fn vzip(self) -> V

§

### impl<T> WithSubscriber for T

§

#### fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided `Subscriber` to this type, returning a [`WithDispatch`] wrapper. Read more
§

#### fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default `Subscriber` to this type, returning a [`WithDispatch`] wrapper. Read more
§

### impl<T> ErasedDestructor for T
where T: 'static,

§

### impl<T> MaybeSendSync for T