Struct Cmd

pub struct Cmd { /* private fields */ }

Represents redis commands.

Implementations

impl Cmd

A command acts as a builder interface to creating encoded redis requests. This allows you to easily assemble a packed command by chaining arguments together.

Basic example:

redis::Cmd::new().arg("SET").arg("my_key").arg(42);

There is also a helper function called cmd which makes it a tiny bit shorter:

redis::cmd("SET").arg("my_key").arg(42);

Because Rust currently does not have an ideal system for lifetimes of temporaries, sometimes you need to hold on to the initially generated command:

let mut cmd = redis::cmd("SMEMBERS");
let mut iter : redis::Iter<i32> = cmd.arg("my_set").clone().iter(&mut con).unwrap();

pub fn new() -> Cmd

Creates a new empty command.

pub fn with_capacity(arg_count: usize, size_of_data: usize) -> Cmd

Creates a new empty command, with at least the requested capacity.

pub fn clear(&mut self)

Clears the command, resetting it completely.

This is equivalent to Cmd::new, except the buffer capacity is kept.

Examples

let mut cmd = Cmd::new();
cmd.arg("SET").arg("foo").arg("42");
cmd.query::<()>(&mut con).expect("Query failed");
cmd.clear();
// This reuses the allocations of the previous command
cmd.arg("SET").arg("bar").arg("42");
cmd.query::<()>(&mut con).expect("Query failed");

pub fn arg<T>(&mut self, arg: T) -> &mut Cmd

where T: ToRedisArgs,

Appends an argument to the command. The argument passed must be a type that implements ToRedisArgs. Most primitive types as well as vectors of primitive types implement it.

For instance all of the following are valid:

redis::cmd("SET").arg(&["my_key", "my_value"]);
redis::cmd("SET").arg("my_key").arg(42);
redis::cmd("SET").arg("my_key").arg(b"my_value");

pub fn cursor_arg(&mut self, cursor: u64) -> &mut Cmd

Works similar to arg but adds a cursor argument.

This is always an integer and also flips the command implementation to support a different mode for the iterators where the iterator will ask for another batch of items when the local data is exhausted. Calling this function more than once will overwrite the previous cursor with the latest set value.

let mut cmd = redis::cmd("SSCAN");
let mut iter : redis::Iter<isize> =
    cmd.arg("my_set").cursor_arg(0).clone().iter(&mut con).unwrap();
for x in iter {
    // do something with the item
}

pub fn get_packed_command(&self) -> Vec<u8>

Returns the packed command as a byte vector.

This is a wrapper around write_packed_command that creates a Vec to write to.

pub fn write_packed_command(&self, dst: &mut Vec<u8>)

Writes the packed command to dst.

This will append the packed command.

See also get_packed_command.

pub fn in_scan_mode(&self) -> bool

Returns true if the command is in scan mode.

pub fn query<T>(&self, con: &mut dyn ConnectionLike) -> Result<T, RedisError>

where T: FromRedisValue,

Sends the command as query to the connection and converts the result to the target redis value. This is the general way how you can retrieve data.

pub async fn query_async<T>( &self, con: &mut impl ConnectionLike, ) -> Result<T, RedisError>

where T: FromRedisValue,

Async version of query.

pub fn iter<T>( self, con: &mut dyn ConnectionLike, ) -> Result<Iter<'_, T>, RedisError>

where T: FromRedisValue,

Similar to query() but returns an iterator over the items of the bulk result or iterator. In normal mode this is not in any way more efficient than just querying into a Vec<T> as it’s internally implemented as buffering into a vector. This however is useful when cursor_arg was used in which case the iterator will query for more items until the server side cursor is exhausted.

This is useful for commands such as SSCAN, SCAN and others.

One speciality of this function is that it will check if the response looks like a cursor or not and always just looks at the payload. This way you can use the function the same for responses in the format of KEYS (just a list) as well as SSCAN (which returns a tuple of cursor and list).

pub async fn iter_async<'a, T>( self, con: &'a mut (dyn ConnectionLike + Send), ) -> Result<AsyncIter<'a, T>, RedisError>

where T: FromRedisValue + 'a,

Similar to iter() but returns an AsyncIter over the items of the bulk result or iterator. A futures::Stream is implemented on AsyncIter. In normal mode this is not in any way more efficient than just querying into a Vec<T> as it’s internally implemented as buffering into a vector. This however is useful when cursor_arg was used in which case the stream will query for more items until the server side cursor is exhausted.

This is useful for commands such as SSCAN, SCAN and others in async contexts.

One speciality of this function is that it will check if the response looks like a cursor or not and always just looks at the payload. This way you can use the function the same for responses in the format of KEYS (just a list) as well as SSCAN (which returns a tuple of cursor and list).

pub fn execute(&self, con: &mut dyn ConnectionLike)

👎Deprecated: Use Cmd::exec + unwrap, instead

This is a shortcut to query() that does not return a value and will fail the task if the query fails because of an error. This is mainly useful in examples and for simple commands like setting keys.

This is equivalent to a call of query like this:

redis::cmd("PING").query::<()>(&mut con).unwrap();

pub fn exec(&self, con: &mut dyn ConnectionLike) -> Result<(), RedisError>

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 ().

pub async fn exec_async( &self, con: &mut impl ConnectionLike, ) -> Result<(), RedisError>

This is an alternative to query_async 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 ().

pub fn args_iter(&self) -> impl Clone + ExactSizeIterator

Returns an iterator over the arguments in this command (including the command name itself)

pub fn set_no_response(&mut self, nr: bool) -> &mut Cmd

Client won’t read and wait for results. Currently only used for Pub/Sub commands in RESP3.

pub fn is_no_response(&self) -> bool

Check whether command’s result will be waited for.

impl Cmd

pub fn get<'a, K>(key: K) -> Cmd

where K: ToRedisArgs,

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

pub fn mget<'a, K>(key: K) -> Cmd

where K: ToRedisArgs,

Get values of keys Redis Docs

pub fn keys<'a, K>(key: K) -> Cmd

where K: ToRedisArgs,

Gets all keys matching pattern Redis Docs

pub fn set<'a, K, V>(key: K, value: V) -> Cmd

where K: ToRedisArgs, V: ToRedisArgs,

Set the string value of a key. Redis Docs

pub fn set_options<'a, K, V>(key: K, value: V, options: SetOptions) -> Cmd

where K: ToRedisArgs, V: ToRedisArgs,

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

pub fn set_multiple<'a, K, V>(items: &'a [(K, V)]) -> Cmd

where K: ToRedisArgs, V: ToRedisArgs,

👎Deprecated since 0.22.4: Renamed to mset() to reflect Redis name

Sets multiple keys to their values. Redis Docs

pub fn mset<'a, K, V>(items: &'a [(K, V)]) -> Cmd

where K: ToRedisArgs, V: ToRedisArgs,

Sets multiple keys to their values. Redis Docs

pub fn set_ex<'a, K, V>(key: K, value: V, seconds: u64) -> Cmd

where K: ToRedisArgs, V: ToRedisArgs,

Set the value and expiration of a key. Redis Docs

pub fn pset_ex<'a, K, V>(key: K, value: V, milliseconds: u64) -> Cmd

where K: ToRedisArgs, V: ToRedisArgs,

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

pub fn set_nx<'a, K, V>(key: K, value: V) -> Cmd

where K: ToRedisArgs, V: ToRedisArgs,

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

pub fn mset_nx<'a, K, V>(items: &'a [(K, V)]) -> Cmd

where K: ToRedisArgs, V: ToRedisArgs,

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

pub fn getset<'a, K, V>(key: K, value: V) -> Cmd

where K: ToRedisArgs, V: ToRedisArgs,

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

pub fn getrange<'a, K>(key: K, from: isize, to: isize) -> Cmd

where K: ToRedisArgs,

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

pub fn setrange<'a, K, V>(key: K, offset: isize, value: V) -> Cmd

where K: ToRedisArgs, V: ToRedisArgs,

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

pub fn del<'a, K>(key: K) -> Cmd

where K: ToRedisArgs,

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

pub fn exists<'a, K>(key: K) -> Cmd

where K: ToRedisArgs,

Determine if a key exists. Redis Docs

pub fn key_type<'a, K>(key: K) -> Cmd

where K: ToRedisArgs,

Determine the type of key. Redis Docs

pub fn expire<'a, K>(key: K, seconds: i64) -> Cmd

where K: ToRedisArgs,

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

pub fn expire_at<'a, K>(key: K, ts: i64) -> Cmd

where K: ToRedisArgs,

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

pub fn pexpire<'a, K>(key: K, ms: i64) -> Cmd

where K: ToRedisArgs,

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

pub fn pexpire_at<'a, K>(key: K, ts: i64) -> Cmd

where K: ToRedisArgs,

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

pub fn expire_time<'a, K>(key: K) -> Cmd

where K: ToRedisArgs,

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

pub fn pexpire_time<'a, K>(key: K) -> Cmd

where K: ToRedisArgs,

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

pub fn persist<'a, K>(key: K) -> Cmd

where K: ToRedisArgs,

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

pub fn ttl<'a, K>(key: K) -> Cmd

where K: ToRedisArgs,

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

pub fn pttl<'a, K>(key: K) -> Cmd

where K: ToRedisArgs,

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

pub fn get_ex<'a, K>(key: K, expire_at: Expiry) -> Cmd

where K: ToRedisArgs,

Get the value of a key and set expiration Redis Docs

pub fn get_del<'a, K>(key: K) -> Cmd

where K: ToRedisArgs,

Get the value of a key and delete it Redis Docs

pub fn copy<'a, KSrc, KDst, Db>( source: KSrc, destination: KDst, options: CopyOptions<Db>, ) -> Cmd

where KSrc: ToRedisArgs, KDst: ToRedisArgs, Db: ToString,

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

pub fn rename<'a, K, N>(key: K, new_key: N) -> Cmd

where K: ToRedisArgs, N: ToRedisArgs,

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

pub fn rename_nx<'a, K, N>(key: K, new_key: N) -> Cmd

where K: ToRedisArgs, N: ToRedisArgs,

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

pub fn unlink<'a, K>(key: K) -> Cmd

where K: ToRedisArgs,

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

pub fn append<'a, K, V>(key: K, value: V) -> Cmd

where K: ToRedisArgs, V: ToRedisArgs,

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

pub fn incr<'a, K, V>(key: K, delta: V) -> Cmd

where K: ToRedisArgs, V: ToRedisArgs,

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.

pub fn decr<'a, K, V>(key: K, delta: V) -> Cmd

where K: ToRedisArgs, V: ToRedisArgs,

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

pub fn setbit<'a, K>(key: K, offset: usize, value: bool) -> Cmd

where K: ToRedisArgs,

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

pub fn getbit<'a, K>(key: K, offset: usize) -> Cmd

where K: ToRedisArgs,

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

pub fn bitcount<'a, K>(key: K) -> Cmd

where K: ToRedisArgs,

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

pub fn bitcount_range<'a, K>(key: K, start: usize, end: usize) -> Cmd

where K: ToRedisArgs,

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

pub fn bit_and<'a, D, S>(dstkey: D, srckeys: S) -> Cmd

where D: ToRedisArgs, S: ToRedisArgs,

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

pub fn bit_or<'a, D, S>(dstkey: D, srckeys: S) -> Cmd

where D: ToRedisArgs, S: ToRedisArgs,

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

pub fn bit_xor<'a, D, S>(dstkey: D, srckeys: S) -> Cmd

where D: ToRedisArgs, S: ToRedisArgs,

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

pub fn bit_not<'a, D, S>(dstkey: D, srckey: S) -> Cmd

where D: ToRedisArgs, S: ToRedisArgs,

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

pub fn bit_diff<'a, D, S>(dstkey: D, srckeys: S) -> Cmd

where D: ToRedisArgs, S: ToRedisArgs,

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

pub fn bit_diff1<'a, D, S>(dstkey: D, srckeys: S) -> Cmd

where D: ToRedisArgs, S: ToRedisArgs,

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

pub fn bit_and_or<'a, D, S>(dstkey: D, srckeys: S) -> Cmd

where D: ToRedisArgs, S: ToRedisArgs,

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

pub fn bit_one<'a, D, S>(dstkey: D, srckeys: S) -> Cmd

where D: ToRedisArgs, S: ToRedisArgs,

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

pub fn strlen<'a, K>(key: K) -> Cmd

where K: ToRedisArgs,

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

pub fn hget<'a, K, F>(key: K, field: F) -> Cmd

where K: ToRedisArgs, F: ToRedisArgs,

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

pub fn hmget<'a, K, F>(key: K, fields: F) -> Cmd

where K: ToRedisArgs, F: ToRedisArgs,

Gets multiple fields from a hash. Redis Docs

pub fn hget_ex<'a, K, F>(key: K, fields: F, expire_at: Expiry) -> Cmd

where K: ToRedisArgs, F: ToRedisArgs,

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

pub fn hdel<'a, K, F>(key: K, field: F) -> Cmd

where K: ToRedisArgs, F: ToRedisArgs,

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

pub fn hget_del<'a, K, F>(key: K, fields: F) -> Cmd

where K: ToRedisArgs, F: ToRedisArgs,

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

pub fn hset<'a, K, F, V>(key: K, field: F, value: V) -> Cmd

where K: ToRedisArgs, F: ToRedisArgs, V: ToRedisArgs,

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

pub fn hset_ex<'a, K, F, V>( key: K, hash_field_expiration_options: &'a HashFieldExpirationOptions, fields_values: &'a [(F, V)], ) -> Cmd

where K: ToRedisArgs, F: ToRedisArgs, V: ToRedisArgs,

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

pub fn hset_nx<'a, K, F, V>(key: K, field: F, value: V) -> Cmd

where K: ToRedisArgs, F: ToRedisArgs, V: ToRedisArgs,

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

pub fn hset_multiple<'a, K, F, V>(key: K, items: &'a [(F, V)]) -> Cmd

where K: ToRedisArgs, F: ToRedisArgs, V: ToRedisArgs,

Sets multiple fields in a hash. Redis Docs

pub fn hincr<'a, K, F, D>(key: K, field: F, delta: D) -> Cmd

where K: ToRedisArgs, F: ToRedisArgs, D: ToRedisArgs,

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

pub fn hexists<'a, K, F>(key: K, field: F) -> Cmd

where K: ToRedisArgs, F: ToRedisArgs,

Checks if a field in a hash exists. Redis Docs

pub fn httl<'a, K, F>(key: K, fields: F) -> Cmd

where K: ToRedisArgs, F: ToRedisArgs,

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

pub fn hpttl<'a, K, F>(key: K, fields: F) -> Cmd

where K: ToRedisArgs, F: ToRedisArgs,

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

pub fn hexpire<'a, K, F>( key: K, seconds: i64, opt: ExpireOption, fields: F, ) -> Cmd

where K: ToRedisArgs, F: ToRedisArgs,

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

pub fn hexpire_at<'a, K, F>( key: K, ts: i64, opt: ExpireOption, fields: F, ) -> Cmd

where K: ToRedisArgs, F: ToRedisArgs,

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

pub fn hexpire_time<'a, K, F>(key: K, fields: F) -> Cmd

where K: ToRedisArgs, F: ToRedisArgs,

Returns the absolute Unix expiration timestamp in seconds. Redis Docs

pub fn hpersist<'a, K, F>(key: K, fields: F) -> Cmd

where K: ToRedisArgs, F: ToRedisArgs,

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

pub fn hpexpire<'a, K, F>( key: K, milliseconds: i64, opt: ExpireOption, fields: F, ) -> Cmd

where K: ToRedisArgs, F: ToRedisArgs,

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

pub fn hpexpire_at<'a, K, F>( key: K, ts: i64, opt: ExpireOption, fields: F, ) -> Cmd

where K: ToRedisArgs, F: ToRedisArgs,

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

pub fn hpexpire_time<'a, K, F>(key: K, fields: F) -> Cmd

where K: ToRedisArgs, F: ToRedisArgs,

Returns the absolute Unix expiration timestamp in seconds. Redis Docs

pub fn hkeys<'a, K>(key: K) -> Cmd

where K: ToRedisArgs,

Gets all the keys in a hash. Redis Docs

pub fn hvals<'a, K>(key: K) -> Cmd

where K: ToRedisArgs,

Gets all the values in a hash. Redis Docs

pub fn hgetall<'a, K>(key: K) -> Cmd

where K: ToRedisArgs,

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

pub fn hlen<'a, K>(key: K) -> Cmd

where K: ToRedisArgs,

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

pub fn blmove<'a, S, D>( srckey: S, dstkey: D, src_dir: Direction, dst_dir: Direction, timeout: f64, ) -> Cmd

where S: ToRedisArgs, D: ToRedisArgs,

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

pub fn blmpop<'a, K>( timeout: f64, numkeys: usize, key: K, dir: Direction, count: usize, ) -> Cmd

where K: ToRedisArgs,

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

pub fn blpop<'a, K>(key: K, timeout: f64) -> Cmd

where K: ToRedisArgs,

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

pub fn brpop<'a, K>(key: K, timeout: f64) -> Cmd

where K: ToRedisArgs,

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

pub fn brpoplpush<'a, S, D>(srckey: S, dstkey: D, timeout: f64) -> Cmd

where S: ToRedisArgs, D: ToRedisArgs,

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

pub fn lindex<'a, K>(key: K, index: isize) -> Cmd

where K: ToRedisArgs,

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

pub fn linsert_before<'a, K, P, V>(key: K, pivot: P, value: V) -> Cmd

where K: ToRedisArgs, P: ToRedisArgs, V: ToRedisArgs,

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

pub fn linsert_after<'a, K, P, V>(key: K, pivot: P, value: V) -> Cmd

where K: ToRedisArgs, P: ToRedisArgs, V: ToRedisArgs,

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

pub fn llen<'a, K>(key: K) -> Cmd

where K: ToRedisArgs,

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

pub fn lmove<'a, S, D>( srckey: S, dstkey: D, src_dir: Direction, dst_dir: Direction, ) -> Cmd

where S: ToRedisArgs, D: ToRedisArgs,

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

pub fn lmpop<'a, K>(numkeys: usize, key: K, dir: Direction, count: usize) -> Cmd

where K: ToRedisArgs,

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

pub fn lpop<'a, K>(key: K, count: Option<NonZero<usize>>) -> Cmd

where K: ToRedisArgs,

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

pub fn lpos<'a, K, V>(key: K, value: V, options: LposOptions) -> Cmd

where K: ToRedisArgs, V: ToRedisArgs,

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

pub fn lpush<'a, K, V>(key: K, value: V) -> Cmd

where K: ToRedisArgs, V: ToRedisArgs,

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

pub fn lpush_exists<'a, K, V>(key: K, value: V) -> Cmd

where K: ToRedisArgs, V: ToRedisArgs,

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

pub fn lrange<'a, K>(key: K, start: isize, stop: isize) -> Cmd

where K: ToRedisArgs,

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

pub fn lrem<'a, K, V>(key: K, count: isize, value: V) -> Cmd

where K: ToRedisArgs, V: ToRedisArgs,

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

pub fn ltrim<'a, K>(key: K, start: isize, stop: isize) -> Cmd

where K: ToRedisArgs,

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

pub fn lset<'a, K, V>(key: K, index: isize, value: V) -> Cmd

where K: ToRedisArgs, V: ToRedisArgs,

Sets the list element at index to value Redis Docs

pub fn ping<'a>() -> Cmd

Sends a ping to the server Redis Docs

pub fn ping_message<'a, K>(message: K) -> Cmd

where K: ToRedisArgs,

Sends a ping with a message to the server Redis Docs

pub fn rpop<'a, K>(key: K, count: Option<NonZero<usize>>) -> Cmd

where K: ToRedisArgs,

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

pub fn rpoplpush<'a, K, D>(key: K, dstkey: D) -> Cmd

where K: ToRedisArgs, D: ToRedisArgs,

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

pub fn rpush<'a, K, V>(key: K, value: V) -> Cmd

where K: ToRedisArgs, V: ToRedisArgs,

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

pub fn rpush_exists<'a, K, V>(key: K, value: V) -> Cmd

where K: ToRedisArgs, V: ToRedisArgs,

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

pub fn sadd<'a, K, M>(key: K, member: M) -> Cmd

where K: ToRedisArgs, M: ToRedisArgs,

Add one or more members to a set. Redis Docs

pub fn scard<'a, K>(key: K) -> Cmd

where K: ToRedisArgs,

Get the number of members in a set. Redis Docs

pub fn sdiff<'a, K>(keys: K) -> Cmd

where K: ToRedisArgs,

Subtract multiple sets. Redis Docs

pub fn sdiffstore<'a, D, K>(dstkey: D, keys: K) -> Cmd

where D: ToRedisArgs, K: ToRedisArgs,

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

pub fn sinter<'a, K>(keys: K) -> Cmd

where K: ToRedisArgs,

Intersect multiple sets. Redis Docs

pub fn sinterstore<'a, D, K>(dstkey: D, keys: K) -> Cmd

where D: ToRedisArgs, K: ToRedisArgs,

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

pub fn sismember<'a, K, M>(key: K, member: M) -> Cmd

where K: ToRedisArgs, M: ToRedisArgs,

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

pub fn smismember<'a, K, M>(key: K, members: M) -> Cmd

where K: ToRedisArgs, M: ToRedisArgs,

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

pub fn smembers<'a, K>(key: K) -> Cmd

where K: ToRedisArgs,

Get all the members in a set. Redis Docs

pub fn smove<'a, S, D, M>(srckey: S, dstkey: D, member: M) -> Cmd

where S: ToRedisArgs, D: ToRedisArgs, M: ToRedisArgs,

Move a member from one set to another. Redis Docs

pub fn spop<'a, K>(key: K) -> Cmd

where K: ToRedisArgs,

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

pub fn srandmember<'a, K>(key: K) -> Cmd

where K: ToRedisArgs,

Get one random member from a set. Redis Docs

pub fn srandmember_multiple<'a, K>(key: K, count: usize) -> Cmd

where K: ToRedisArgs,

Get multiple random members from a set. Redis Docs

pub fn srem<'a, K, M>(key: K, member: M) -> Cmd

where K: ToRedisArgs, M: ToRedisArgs,

Remove one or more members from a set. Redis Docs

pub fn sunion<'a, K>(keys: K) -> Cmd

where K: ToRedisArgs,

Add multiple sets. Redis Docs

pub fn sunionstore<'a, D, K>(dstkey: D, keys: K) -> Cmd

where D: ToRedisArgs, K: ToRedisArgs,

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

pub fn zadd<'a, K, S, M>(key: K, member: M, score: S) -> Cmd

where K: ToRedisArgs, S: ToRedisArgs, M: ToRedisArgs,

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

pub fn zadd_multiple<'a, K, S, M>(key: K, items: &'a [(S, M)]) -> Cmd

where K: ToRedisArgs, S: ToRedisArgs, M: ToRedisArgs,

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

pub fn zadd_options<'a, K, S, M>( key: K, member: M, score: S, options: &'a SortedSetAddOptions, ) -> Cmd

where K: ToRedisArgs, S: ToRedisArgs, M: ToRedisArgs,

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

pub fn zadd_multiple_options<'a, K, S, M>( key: K, items: &'a [(S, M)], options: &'a SortedSetAddOptions, ) -> Cmd

where K: ToRedisArgs, S: ToRedisArgs, M: ToRedisArgs,

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

pub fn zcard<'a, K>(key: K) -> Cmd

where K: ToRedisArgs,

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

pub fn zcount<'a, K, M, MM>(key: K, min: M, max: MM) -> Cmd

where K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs,

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

pub fn zincr<'a, K, M, D>(key: K, member: M, delta: D) -> Cmd

where K: ToRedisArgs, M: ToRedisArgs, D: ToRedisArgs,

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

pub fn zinterstore<'a, D, K>(dstkey: D, keys: K) -> Cmd

where D: ToRedisArgs, K: ToRedisArgs,

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

pub fn zinterstore_min<'a, D, K>(dstkey: D, keys: K) -> Cmd

where D: ToRedisArgs, K: ToRedisArgs,

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

pub fn zinterstore_max<'a, D, K>(dstkey: D, keys: K) -> Cmd

where D: ToRedisArgs, K: ToRedisArgs,

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

pub fn zinterstore_weights<'a, D, K, W>(dstkey: D, keys: &'a [(K, W)]) -> Cmd

where D: ToRedisArgs, K: ToRedisArgs, W: ToRedisArgs,

[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

pub fn zinterstore_min_weights<'a, D, K, W>( dstkey: D, keys: &'a [(K, W)], ) -> Cmd

where D: ToRedisArgs, K: ToRedisArgs, W: ToRedisArgs,

[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

pub fn zinterstore_max_weights<'a, D, K, W>( dstkey: D, keys: &'a [(K, W)], ) -> Cmd

where D: ToRedisArgs, K: ToRedisArgs, W: ToRedisArgs,

[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

pub fn zlexcount<'a, K, M, MM>(key: K, min: M, max: MM) -> Cmd

where K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs,

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

pub fn bzpopmax<'a, K>(key: K, timeout: f64) -> Cmd

where K: ToRedisArgs,

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

pub fn zpopmax<'a, K>(key: K, count: isize) -> Cmd

where K: ToRedisArgs,

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

pub fn bzpopmin<'a, K>(key: K, timeout: f64) -> Cmd

where K: ToRedisArgs,

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

pub fn zpopmin<'a, K>(key: K, count: isize) -> Cmd

where K: ToRedisArgs,

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

pub fn bzmpop_max<'a, K>(timeout: f64, keys: K, count: isize) -> Cmd

where K: ToRedisArgs,

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

pub fn zmpop_max<'a, K>(keys: K, count: isize) -> Cmd

where K: ToRedisArgs,

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

pub fn bzmpop_min<'a, K>(timeout: f64, keys: K, count: isize) -> Cmd

where K: ToRedisArgs,

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

pub fn zmpop_min<'a, K>(keys: K, count: isize) -> Cmd

where K: ToRedisArgs,

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

pub fn zrandmember<'a, K>(key: K, count: Option<isize>) -> Cmd

where K: ToRedisArgs,

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

pub fn zrandmember_withscores<'a, K>(key: K, count: isize) -> Cmd

where K: ToRedisArgs,

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

pub fn zrange<'a, K>(key: K, start: isize, stop: isize) -> Cmd

where K: ToRedisArgs,

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

pub fn zrange_withscores<'a, K>(key: K, start: isize, stop: isize) -> Cmd

where K: ToRedisArgs,

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

pub fn zrangebylex<'a, K, M, MM>(key: K, min: M, max: MM) -> Cmd

where K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs,

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

pub fn zrangebylex_limit<'a, K, M, MM>( key: K, min: M, max: MM, offset: isize, count: isize, ) -> Cmd

where K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs,

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

pub fn zrevrangebylex<'a, K, MM, M>(key: K, max: MM, min: M) -> Cmd

where K: ToRedisArgs, MM: ToRedisArgs, M: ToRedisArgs,

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

pub fn zrevrangebylex_limit<'a, K, MM, M>( key: K, max: MM, min: M, offset: isize, count: isize, ) -> Cmd

where K: ToRedisArgs, MM: ToRedisArgs, M: ToRedisArgs,

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

pub fn zrangebyscore<'a, K, M, MM>(key: K, min: M, max: MM) -> Cmd

where K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs,

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

pub fn zrangebyscore_withscores<'a, K, M, MM>(key: K, min: M, max: MM) -> Cmd

where K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs,

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

pub fn zrangebyscore_limit<'a, K, M, MM>( key: K, min: M, max: MM, offset: isize, count: isize, ) -> Cmd

where K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs,

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

pub fn zrangebyscore_limit_withscores<'a, K, M, MM>( key: K, min: M, max: MM, offset: isize, count: isize, ) -> Cmd

where K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs,

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

pub fn zrank<'a, K, M>(key: K, member: M) -> Cmd

where K: ToRedisArgs, M: ToRedisArgs,

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

pub fn zrem<'a, K, M>(key: K, members: M) -> Cmd

where K: ToRedisArgs, M: ToRedisArgs,

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

pub fn zrembylex<'a, K, M, MM>(key: K, min: M, max: MM) -> Cmd

where K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs,

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

pub fn zremrangebyrank<'a, K>(key: K, start: isize, stop: isize) -> Cmd

where K: ToRedisArgs,

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

pub fn zrembyscore<'a, K, M, MM>(key: K, min: M, max: MM) -> Cmd

where K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs,

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

pub fn zrevrange<'a, K>(key: K, start: isize, stop: isize) -> Cmd

where K: ToRedisArgs,

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

pub fn zrevrange_withscores<'a, K>(key: K, start: isize, stop: isize) -> Cmd

where K: ToRedisArgs,

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

pub fn zrevrangebyscore<'a, K, MM, M>(key: K, max: MM, min: M) -> Cmd

where K: ToRedisArgs, MM: ToRedisArgs, M: ToRedisArgs,

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

pub fn zrevrangebyscore_withscores<'a, K, MM, M>(key: K, max: MM, min: M) -> Cmd

where K: ToRedisArgs, MM: ToRedisArgs, M: ToRedisArgs,

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

pub fn zrevrangebyscore_limit<'a, K, MM, M>( key: K, max: MM, min: M, offset: isize, count: isize, ) -> Cmd

where K: ToRedisArgs, MM: ToRedisArgs, M: ToRedisArgs,

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

pub fn zrevrangebyscore_limit_withscores<'a, K, MM, M>( key: K, max: MM, min: M, offset: isize, count: isize, ) -> Cmd

where K: ToRedisArgs, MM: ToRedisArgs, M: ToRedisArgs,

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

pub fn zrevrank<'a, K, M>(key: K, member: M) -> Cmd

where K: ToRedisArgs, M: ToRedisArgs,

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

pub fn zscore<'a, K, M>(key: K, member: M) -> Cmd

where K: ToRedisArgs, M: ToRedisArgs,

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

pub fn zscore_multiple<'a, K, M>(key: K, members: &'a [M]) -> Cmd

where K: ToRedisArgs, M: ToRedisArgs,

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

pub fn zunionstore<'a, D, K>(dstkey: D, keys: K) -> Cmd

where D: ToRedisArgs, K: ToRedisArgs,

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

pub fn zunionstore_min<'a, D, K>(dstkey: D, keys: K) -> Cmd

where D: ToRedisArgs, K: ToRedisArgs,

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

pub fn zunionstore_max<'a, D, K>(dstkey: D, keys: K) -> Cmd

where D: ToRedisArgs, K: ToRedisArgs,

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

pub fn zunionstore_weights<'a, D, K, W>(dstkey: D, keys: &'a [(K, W)]) -> Cmd

where D: ToRedisArgs, K: ToRedisArgs, W: ToRedisArgs,

[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

pub fn zunionstore_min_weights<'a, D, K, W>( dstkey: D, keys: &'a [(K, W)], ) -> Cmd

where D: ToRedisArgs, K: ToRedisArgs, W: ToRedisArgs,

[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

pub fn zunionstore_max_weights<'a, D, K, W>( dstkey: D, keys: &'a [(K, W)], ) -> Cmd

where D: ToRedisArgs, K: ToRedisArgs, W: ToRedisArgs,

[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

pub fn pfadd<'a, K, E>(key: K, element: E) -> Cmd

where K: ToRedisArgs, E: ToRedisArgs,

Adds the specified elements to the specified HyperLogLog. Redis Docs

pub fn pfcount<'a, K>(key: K) -> Cmd

where K: ToRedisArgs,

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

pub fn pfmerge<'a, D, S>(dstkey: D, srckeys: S) -> Cmd

where D: ToRedisArgs, S: ToRedisArgs,

Merge N different HyperLogLogs into a single one. Redis Docs

pub fn publish<'a, K, E>(channel: K, message: E) -> Cmd

where K: ToRedisArgs, E: ToRedisArgs,

Posts a message to the given channel. Redis Docs

pub fn spublish<'a, K, E>(channel: K, message: E) -> Cmd

where K: ToRedisArgs, E: ToRedisArgs,

Posts a message to the given sharded channel. Redis Docs

pub fn object_encoding<'a, K>(key: K) -> Cmd

where K: ToRedisArgs,

Returns the encoding of a key. Redis Docs

pub fn object_idletime<'a, K>(key: K) -> Cmd

where K: ToRedisArgs,

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

pub fn object_freq<'a, K>(key: K) -> Cmd

where K: ToRedisArgs,

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

pub fn object_refcount<'a, K>(key: K) -> Cmd

where K: ToRedisArgs,

Returns the reference count of a key. Redis Docs

pub fn client_getname<'a>() -> Cmd

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

pub fn client_id<'a>() -> Cmd

Returns the ID of the current connection. Redis Docs

pub fn client_setname<'a, K>(connection_name: K) -> Cmd

where K: ToRedisArgs,

Command assigns a name to the current connection. Redis Docs

pub fn acl_load<'a>() -> Cmd

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

pub fn acl_save<'a>() -> Cmd

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

pub fn acl_list<'a>() -> Cmd

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

pub fn acl_users<'a>() -> Cmd

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

pub fn acl_getuser<'a, K>(username: K) -> Cmd

where K: ToRedisArgs,

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

pub fn acl_setuser<'a, K>(username: K) -> Cmd

where K: ToRedisArgs,

Creates an ACL user without any privilege. Redis Docs

pub fn acl_setuser_rules<'a, K>(username: K, rules: &'a [Rule]) -> Cmd

where K: ToRedisArgs,

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

pub fn acl_deluser<'a, K>(usernames: &'a [K]) -> Cmd

where K: ToRedisArgs,

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

pub fn acl_dryrun<'a, K, C, A>(username: K, command: C, args: A) -> Cmd

where K: ToRedisArgs, C: ToRedisArgs, A: ToRedisArgs,

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

pub fn acl_cat<'a>() -> Cmd

Shows the available ACL categories. Redis Docs

pub fn acl_cat_categoryname<'a, K>(categoryname: K) -> Cmd

where K: ToRedisArgs,

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

pub fn acl_genpass<'a>() -> Cmd

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

pub fn acl_genpass_bits<'a>(bits: isize) -> Cmd

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

pub fn acl_whoami<'a>() -> Cmd

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

pub fn acl_log<'a>(count: isize) -> Cmd

Shows a list of recent ACL security events Redis Docs

pub fn acl_log_reset<'a>() -> Cmd

Clears the ACL log. Redis Docs

pub fn acl_help<'a>() -> Cmd

Returns a helpful text describing the different subcommands. Redis Docs

pub fn geo_add<'a, K, M>(key: K, members: M) -> Cmd

where K: ToRedisArgs, M: ToRedisArgs,

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

pub fn geo_dist<'a, K, M1, M2>( key: K, member1: M1, member2: M2, unit: Unit, ) -> Cmd

where K: ToRedisArgs, M1: ToRedisArgs, M2: ToRedisArgs,

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

pub fn geo_hash<'a, K, M>(key: K, members: M) -> Cmd

where K: ToRedisArgs, M: ToRedisArgs,

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

pub fn geo_pos<'a, K, M>(key: K, members: M) -> Cmd

where K: ToRedisArgs, M: ToRedisArgs,

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

pub fn geo_radius<'a, K>( key: K, longitude: f64, latitude: f64, radius: f64, unit: Unit, options: RadiusOptions, ) -> Cmd

where K: ToRedisArgs,

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

pub fn geo_radius_by_member<'a, K, M>( key: K, member: M, radius: f64, unit: Unit, options: RadiusOptions, ) -> Cmd

where K: ToRedisArgs, M: ToRedisArgs,

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

pub fn xack<'a, K, G, I>(key: K, group: G, ids: &'a [I]) -> Cmd

where K: ToRedisArgs, G: ToRedisArgs, I: ToRedisArgs,

Ack pending stream messages checked out by a consumer.

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

Redis Docs

pub fn xadd<'a, K, ID, F, V>(key: K, id: ID, items: &'a [(F, V)]) -> Cmd

where K: ToRedisArgs, ID: ToRedisArgs, F: ToRedisArgs, V: ToRedisArgs,

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

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

Redis Docs

pub fn xadd_map<'a, K, ID, BTM>(key: K, id: ID, map: BTM) -> Cmd

where K: ToRedisArgs, ID: ToRedisArgs, BTM: ToRedisArgs,

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

pub fn xadd_options<'a, K, ID, I>( key: K, id: ID, items: I, options: &'a StreamAddOptions, ) -> Cmd

where K: ToRedisArgs, ID: ToRedisArgs, I: ToRedisArgs,

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

pub fn xadd_maxlen<'a, K, ID, F, V>( key: K, maxlen: StreamMaxlen, id: ID, items: &'a [(F, V)], ) -> Cmd

where K: ToRedisArgs, ID: ToRedisArgs, F: ToRedisArgs, V: ToRedisArgs,

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

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

Redis Docs

pub fn xadd_maxlen_map<'a, K, ID, BTM>( key: K, maxlen: StreamMaxlen, id: ID, map: BTM, ) -> Cmd

where K: ToRedisArgs, ID: ToRedisArgs, BTM: ToRedisArgs,

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

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

Redis Docs

pub fn xautoclaim_options<'a, K, G, C, MIT, S>( key: K, group: G, consumer: C, min_idle_time: MIT, start: S, options: StreamAutoClaimOptions, ) -> Cmd

where K: ToRedisArgs, G: ToRedisArgs, C: ToRedisArgs, MIT: ToRedisArgs, S: ToRedisArgs,

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

pub fn xclaim<'a, K, G, C, MIT, ID>( key: K, group: G, consumer: C, min_idle_time: MIT, ids: &'a [ID], ) -> Cmd

where K: ToRedisArgs, G: ToRedisArgs, C: ToRedisArgs, MIT: ToRedisArgs, ID: ToRedisArgs,

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

pub fn xclaim_options<'a, K, G, C, MIT, ID>( key: K, group: G, consumer: C, min_idle_time: MIT, ids: &'a [ID], options: StreamClaimOptions, ) -> Cmd

where K: ToRedisArgs, G: ToRedisArgs, C: ToRedisArgs, MIT: ToRedisArgs, ID: ToRedisArgs,

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

pub fn xdel<'a, K, ID>(key: K, ids: &'a [ID]) -> Cmd

where K: ToRedisArgs, ID: ToRedisArgs,

Deletes a list of ids for a given stream key.

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

Redis Docs

pub fn xdel_ex<'a, K, ID>( key: K, ids: &'a [ID], options: StreamDeletionPolicy, ) -> Cmd

where K: ToRedisArgs, ID: ToRedisArgs,

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

pub fn xack_del<'a, K, G, ID>( key: K, group: G, ids: &'a [ID], options: StreamDeletionPolicy, ) -> Cmd

where K: ToRedisArgs, G: ToRedisArgs, ID: ToRedisArgs,

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

pub fn xgroup_create<'a, K, G, ID>(key: K, group: G, id: ID) -> Cmd

where K: ToRedisArgs, G: ToRedisArgs, ID: ToRedisArgs,

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

pub fn xgroup_createconsumer<'a, K, G, C>(key: K, group: G, consumer: C) -> Cmd

where K: ToRedisArgs, G: ToRedisArgs, C: ToRedisArgs,

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

pub fn xgroup_create_mkstream<'a, K, G, ID>(key: K, group: G, id: ID) -> Cmd

where K: ToRedisArgs, G: ToRedisArgs, ID: ToRedisArgs,

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

pub fn xgroup_setid<'a, K, G, ID>(key: K, group: G, id: ID) -> Cmd

where K: ToRedisArgs, G: ToRedisArgs, ID: ToRedisArgs,

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

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

Redis Docs

pub fn xgroup_destroy<'a, K, G>(key: K, group: G) -> Cmd

where K: ToRedisArgs, G: ToRedisArgs,

Destroy an existing consumer group for a given stream key

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

Redis Docs

pub fn xgroup_delconsumer<'a, K, G, C>(key: K, group: G, consumer: C) -> Cmd

where K: ToRedisArgs, G: ToRedisArgs, C: ToRedisArgs,

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

XGROUP DELCONSUMER <key> <groupname> <consumername>

Redis Docs

pub fn xinfo_consumers<'a, K, G>(key: K, group: G) -> Cmd

where K: ToRedisArgs, G: ToRedisArgs,

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

pub fn xinfo_groups<'a, K>(key: K) -> Cmd

where K: ToRedisArgs,

Returns all consumer groups 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

pub fn xinfo_stream<'a, K>(key: K) -> Cmd

where K: ToRedisArgs,

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

pub fn xlen<'a, K>(key: K) -> Cmd

where K: ToRedisArgs,

Returns the number of messages for a given stream key.

XLEN <key>

Redis Docs

pub fn xpending<'a, K, G>(key: K, group: G) -> Cmd

where K: ToRedisArgs, G: ToRedisArgs,

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

pub fn xpending_count<'a, K, G, S, E, C>( key: K, group: G, start: S, end: E, count: C, ) -> Cmd

where K: ToRedisArgs, G: ToRedisArgs, S: ToRedisArgs, E: ToRedisArgs, C: ToRedisArgs,

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

pub fn xpending_consumer_count<'a, K, G, S, E, C, CN>( key: K, group: G, start: S, end: E, count: C, consumer: CN, ) -> Cmd

where K: ToRedisArgs, G: ToRedisArgs, S: ToRedisArgs, E: ToRedisArgs, C: ToRedisArgs, CN: ToRedisArgs,

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

pub fn xrange<'a, K, S, E>(key: K, start: S, end: E) -> Cmd

where K: ToRedisArgs, S: ToRedisArgs, E: ToRedisArgs,

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

pub fn xrange_all<'a, K>(key: K) -> Cmd

where K: ToRedisArgs,

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

XRANGE key - +

Redis Docs

pub fn xrange_count<'a, K, S, E, C>(key: K, start: S, end: E, count: C) -> Cmd

where K: ToRedisArgs, S: ToRedisArgs, E: ToRedisArgs, C: ToRedisArgs,

A method for paginating a stream by key.

XRANGE key start end [COUNT <n>]

Redis Docs

pub fn xread<'a, K, ID>(keys: &'a [K], ids: &'a [ID]) -> Cmd

where K: ToRedisArgs, ID: ToRedisArgs,

Read a list of ids 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

pub fn xread_options<'a, K, ID>( keys: &'a [K], ids: &'a [ID], options: &'a StreamReadOptions, ) -> Cmd

where K: ToRedisArgs, ID: ToRedisArgs,

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

pub fn xrevrange<'a, K, E, S>(key: K, end: E, start: S) -> Cmd

where K: ToRedisArgs, E: ToRedisArgs, S: ToRedisArgs,

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

XREVRANGE key end start

Redis Docs

pub fn xrevrange_all<'a, K>(key: K) -> Cmd

where K: ToRedisArgs,

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

XREVRANGE key + -

Redis Docs

pub fn xrevrange_count<'a, K, E, S, C>( key: K, end: E, start: S, count: C, ) -> Cmd

where K: ToRedisArgs, E: ToRedisArgs, S: ToRedisArgs, C: ToRedisArgs,

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

pub fn xtrim<'a, K>(key: K, maxlen: StreamMaxlen) -> Cmd

where K: ToRedisArgs,

Trim a stream key to a MAXLEN count.

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

Redis Docs

pub fn xtrim_options<'a, K>(key: K, options: &'a StreamTrimOptions) -> Cmd

where K: ToRedisArgs,

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

pub fn load_script<'a>(script: &'a Script) -> Cmd

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);

pub fn invoke_script<'a>(invocation: &'a ScriptInvocation<'a>) -> Cmd

Invoke a prepared script.

Note: UnlikeScriptInvocation::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);

pub fn flushall<'a>() -> Cmd

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

pub fn flushall_options<'a>(options: &'a FlushAllOptions) -> Cmd

Deletes all the keys of all databases with options

FLUSHALL [ASYNC|SYNC]

Redis Docs

pub fn flushdb<'a>() -> Cmd

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

pub fn flushdb_options<'a>(options: &'a FlushAllOptions) -> Cmd

Deletes all the keys of the current database with options

FLUSHDB [ASYNC|SYNC]

Redis Docs

Trait Implementations

impl Clone for Cmd

fn clone(&self) -> Cmd

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Cmd

fn default() -> Cmd

Returns the “default value” for a type.

impl RedisWrite for Cmd

fn write_arg(&mut self, arg: &[u8])

Accepts a serialized redis command.

fn write_arg_fmt(&mut self, arg: impl Display)

Accepts a serialized redis command.

fn writer_for_next_arg(&mut self) -> impl Write

Appends an empty argument to the command, and returns a std::io::Write instance that can write to it.

fn reserve_space_for_args( &mut self, additional: impl IntoIterator<Item = usize>, )

Reserve space for additional arguments in the command

fn bufmut_for_next_arg(&mut self, capacity: usize) -> impl BufMut

Appends an empty argument to the command, and returns a [bytes::BufMut] instance that can write to it.