Struct Client 

pub struct Client { /* private fields */ }

Client with a unique connection to a Redis server.

Implementations

impl Client

pub async fn connect(config: impl IntoConfig) -> Result<Self>

Connects asynchronously to the Redis server.

Errors

Any Redis driver Error that occurs during the connection operation

pub async fn close(self) -> Result<()>

if this client is the last client on the shared connection, the channel to send messages to the underlying network handler will be closed explicitely.

Then, this function will await for the network handler to be ended

pub fn on_reconnect(&self) -> Receiver<()>

Used to receive notifications when the client reconnects to the Redis server.

To turn this receiver into a Stream, you can use the BroadcastStream wrapper.

pub fn get_client_state<'a>(&'a self) -> RwLockReadGuard<'a, ClientState>

Give an immutable generic access to attach any state to a client instance

pub fn get_client_state_mut<'a>(&'a self) -> RwLockWriteGuard<'a, ClientState>

Give a mutable generic access to attach any state to a client instance

pub async fn send( &self, command: Command, retry_on_error: Option<bool>, ) -> Result<RespBuf>

Send an arbitrary command to the server.

This is used primarily intended for implementing high level commands API but may also be used to provide access to new features that lack a direct API.

Arguments

• command - generic Command meant to be sent to the Redis server.
• retry_on_error - retry to send the command on network error.
  • None - default behaviour defined in Config::retry_on_error
  • Some(true) - retry sending command on network error
  • Some(false) - do not retry sending command on network error

Errors

Any Redis driver Error that occurs during the send operation

Example

use rustis::{client::Client, commands::{FlushingMode, ServerCommands}, resp::cmd, Result};

#[cfg_attr(feature = "tokio-runtime", tokio::main)]
#[cfg_attr(feature = "async-std-runtime", async_std::main)]
async fn main() -> Result<()> {
    let client = Client::connect("127.0.0.1:6379").await?;

    client.flushall(FlushingMode::Sync).await?;

    client
        .send(
            cmd("MSET")
                .arg("key1")
                .arg("value1")
                .arg("key2")
                .arg("value2")
                 .arg("key3")
                .arg("value3")
                .arg("key4")
                .arg("value4"),
            None,
        )
        .await?
        .to::<()>()?;

    let values: Vec<String> = client
        .send(
            cmd("MGET").arg("key1").arg("key2").arg("key3").arg("key4"),
            None,
        )
        .await?
        .to()?;

    assert_eq!(vec!["value1".to_owned(), "value2".to_owned(), "value3".to_owned(), "value4".to_owned()], values);

    Ok(())
}

pub fn send_and_forget( &self, command: Command, retry_on_error: Option<bool>, ) -> Result<()>

Send command to the Redis server and forget its response.

Arguments

• command - generic Command meant to be sent to the Redis server.
• retry_on_error - retry to send the command on network error.
  • None - default behaviour defined in Config::retry_on_error
  • Some(true) - retry sending command on network error
  • Some(false) - do not retry sending command on network error

Errors

Any Redis driver Error that occurs during the send operation

pub async fn send_batch( &self, commands: Vec<Command>, retry_on_error: Option<bool>, ) -> Result<Vec<RespBuf>>

Send a batch of commands to the Redis server.

Arguments

• commands - batch of generic Commands meant to be sent to the Redis server.
• retry_on_error - retry to send the command batch on network error.
  • None - default behaviour defined in Config::retry_on_error
  • Some(true) - retry sending batch on network error
  • Some(false) - do not retry sending batch on network error

Errors

Any Redis driver Error that occurs during the send operation

pub fn create_transaction(&self) -> Transaction

Create a new transaction

pub fn create_pipeline<'a>(&'a self) -> Pipeline<'a>

Create a new pipeline

pub fn create_pub_sub(&self) -> PubSubStream

Create a new pub sub stream with no upfront subscription

pub fn create_client_tracking_invalidation_stream( &self, ) -> Result<ClientTrackingInvalidationStream>

Trait Implementations

impl<'a> BitmapCommands<'a> for &'a Client

fn bitcount( self, key: impl Args, range: BitRange, ) -> PreparedCommand<'a, Self, usize>

Count the number of set bits (population counting) in a string.

fn bitfield( self, key: impl Args, sub_commands: impl Args, ) -> PreparedCommand<'a, Self, Vec<u64>>

The command treats a Redis string as an array of bits, and is capable of addressing specific integer fields of varying bit widths and arbitrary non (necessary) aligned offset.

fn bitfield_readonly( self, key: impl Args, get_commands: impl Args, ) -> PreparedCommand<'a, Self, Vec<u64>>

Read-only variant of the BITFIELD command. It is like the original BITFIELD but only accepts GET subcommand and can safely be used in read-only replicas.

fn bitop( self, operation: BitOperation, dest_key: impl Args, keys: impl Args, ) -> PreparedCommand<'a, Self, usize>

Perform a bitwise operation between multiple keys (containing string values) and store the result in the destination key.

fn bitpos( self, key: impl Args, bit: u64, range: BitRange, ) -> PreparedCommand<'a, Self, usize>

Perform a bitwise operation between multiple keys (containing string values) and store the result in the destination key.

fn getbit(self, key: impl Args, offset: u64) -> PreparedCommand<'a, Self, u64>

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

fn setbit( self, key: impl Args, offset: u64, value: u64, ) -> PreparedCommand<'a, Self, u64>

Sets or clears the bit at offset in the string value stored at key.

impl<'a> BlockingCommands<'a> for &'a Client

async fn monitor(self) -> Result<MonitorStream>

Debugging command that streams back every command processed by the Redis server.

fn blmove<R: Response>( self, source: impl Args, destination: impl Args, where_from: LMoveWhere, where_to: LMoveWhere, timeout: f64, ) -> PreparedCommand<'a, Self, R>

This command is the blocking variant of lmove.

fn blmpop<R: Response + DeserializeOwned>( self, timeout: f64, keys: impl Args, where_: LMoveWhere, count: usize, ) -> PreparedCommand<'a, Self, Option<(String, R)>>

This command is the blocking variant of lmpop.

fn blpop<R1: Response + DeserializeOwned, R2: Response + DeserializeOwned>( self, keys: impl Args, timeout: f64, ) -> PreparedCommand<'a, Self, Option<(R1, R2)>>

This command is a blocking list pop primitive.

fn brpop<R1: Response + DeserializeOwned, R2: Response + DeserializeOwned>( self, keys: impl Args, timeout: f64, ) -> PreparedCommand<'a, Self, Option<(R1, R2)>>

This command is a blocking list pop primitive.

fn bzmpop<R: Response + DeserializeOwned>( self, timeout: f64, keys: impl Args, where_: ZWhere, count: usize, ) -> PreparedCommand<'a, Self, Option<ZMPopResult<R>>>

This command is the blocking variant of zmpop.

fn bzpopmax<R1: Response + DeserializeOwned, R2: Response + DeserializeOwned>( self, keys: impl Args, timeout: f64, ) -> PreparedCommand<'a, Self, BZpopMinMaxResult<R1, R2>>

This command is the blocking variant of zpopmax.

fn bzpopmin<R1: Response + DeserializeOwned, R2: Response + DeserializeOwned>( self, keys: impl Args, timeout: f64, ) -> PreparedCommand<'a, Self, BZpopMinMaxResult<R1, R2>>

This command is the blocking variant of zpopmin.

impl<'a> BloomCommands<'a> for &'a Client

fn bf_add( self, key: impl Args, item: impl Args, ) -> PreparedCommand<'a, Self, bool>

Adds an item to a bloom filter

fn bf_exists( self, key: impl Args, item: impl Args, ) -> PreparedCommand<'a, Self, bool>

Determines whether an item may exist in the Bloom Filter or not.

fn bf_info_all(self, key: impl Args) -> PreparedCommand<'a, Self, BfInfoResult>

Return information about key filter.

fn bf_info<R: Response>( self, key: impl Args, param: BfInfoParameter, ) -> PreparedCommand<'a, Self, R>

Return information about key filter for a specific information parameter

fn bf_insert<R: Response>( self, key: impl Args, items: impl Args, options: BfInsertOptions, ) -> PreparedCommand<'a, Self, R>

bf_insert is a sugarcoated combination of bf_reserve and bf_add.

fn bf_loadchunk( self, key: impl Args, iterator: i64, data: impl Args, ) -> PreparedCommand<'a, Self, ()>

Restores a filter previously saved using bf_scandump.

fn bf_madd<R: Response>( self, key: impl Args, items: impl Args, ) -> PreparedCommand<'a, Self, R>

Adds one or more items to the Bloom Filter and creates the filter if it does not exist yet.

fn bf_mexists<R: Response>( self, key: impl Args, items: impl Args, ) -> PreparedCommand<'a, Self, R>

Determines if one or more items may exist in the filter or not.

fn bf_reserve( self, key: impl Args, error_rate: f64, capacity: usize, options: BfReserveOptions, ) -> PreparedCommand<'a, Self, ()>

Creates an empty Bloom Filter with a single sub-filter for the initial capacity requested and with an upper bound error_rate.

fn bf_scandump( self, key: impl Args, iterator: i64, ) -> PreparedCommand<'a, Self, BfScanDumpResult>

Begins an incremental save of the bloom filter. This is useful for large bloom filters which cannot fit into the normal dump and restore model.

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> ClusterCommands<'a> for &'a Client

fn asking(self) -> PreparedCommand<'a, Self, ()>

When a cluster client receives an -ASK redirect, the ASKING command is sent to the target node followed by the command which was redirected. This is normally done automatically by cluster clients.

fn cluster_addslots<S>(self, slots: impl Args) -> PreparedCommand<'a, Self, ()>

This command is useful in order to modify a node’s view of the cluster configuration.

fn cluster_addslotsrange<S>( self, slots: impl Args, ) -> PreparedCommand<'a, Self, ()>

This command is similar to the cluster_addslots command in that they both assign hash slots to nodes.

fn cluster_bumpepoch(self) -> PreparedCommand<'a, Self, ClusterBumpEpochResult>

Advances the cluster config epoch.

fn cluster_count_failure_reports<I>( self, node_id: impl Args, ) -> PreparedCommand<'a, Self, usize>

The command returns the number of failure reports for the specified node.

fn cluster_countkeysinslot( self, slot: usize, ) -> PreparedCommand<'a, Self, usize>

Returns the number of keys in the specified Redis Cluster hash slot.

fn cluster_delslots<S>(self, slots: impl Args) -> PreparedCommand<'a, Self, ()>

In Redis Cluster, each node keeps track of which master is serving a particular hash slot. This command asks a particular Redis Cluster node to forget which master is serving the hash slots specified as arguments.

fn cluster_delslotsrange<S>( self, slots: impl Args, ) -> PreparedCommand<'a, Self, ()>

This command is similar to the cluster_delslotsrange command in that they both remove hash slots from the node.

fn cluster_failover( self, option: ClusterFailoverOption, ) -> PreparedCommand<'a, Self, ()>

This command, that can only be sent to a Redis Cluster replica node, forces the replica to start a manual failover of its master instance.

fn cluster_flushslots(self) -> PreparedCommand<'a, Self, ()>

Deletes all slots from a node.

fn cluster_forget<I>(self, node_id: impl Args) -> PreparedCommand<'a, Self, ()>

The command is used in order to remove a node, specified via its node ID, from the set of known nodes of the Redis Cluster node receiving the command. In other words the specified node is removed from the nodes table of the node receiving the command.

fn cluster_getkeysinslot( self, slot: u16, count: usize, ) -> PreparedCommand<'a, Self, ()>

The command returns an array of keys names stored in the contacted node and hashing to the specified hash slot.

fn cluster_info( self, slot: u16, count: usize, ) -> PreparedCommand<'a, Self, ClusterInfo>

This command provides info style information about Redis Cluster vital parameters.

fn cluster_keyslot(self, key: impl Args) -> PreparedCommand<'a, Self, u16>

Returns an integer identifying the hash slot the specified key hashes to.

fn cluster_links<R: Response>(self) -> PreparedCommand<'a, Self, R>

Each node in a Redis Cluster maintains a pair of long-lived TCP link with each peer in the cluster:

fn cluster_meet( self, ip: impl Args, port: u16, cluster_bus_port: Option<u16>, ) -> PreparedCommand<'a, Self, ()>

This command is used in order to connect different Redis nodes with cluster support enabled, into a working cluster.

fn cluster_myid<R: Response>(self) -> PreparedCommand<'a, Self, R>

This command returns the unique, auto-generated identifier that is associated with the connected cluster node.

fn cluster_nodes<R: Response>(self) -> PreparedCommand<'a, Self, R>

Each node in a Redis Cluster has its view of the current cluster configuration, given by the set of known nodes, the state of the connection we have with such nodes, their flags, properties and assigned slots, and so forth.

fn cluster_replicas<R: Response>( self, node_id: impl Args, ) -> PreparedCommand<'a, Self, R>

The command provides a list of replica nodes replicating from the specified master node.

fn cluster_replicate(self, node_id: impl Args) -> PreparedCommand<'a, Self, ()>

The command reconfigures a node as a replica of the specified master. If the node receiving the command is an empty master, as a side effect of the command, the node role is changed from master to replica.

fn cluster_reset( self, reset_type: ClusterResetType, ) -> PreparedCommand<'a, Self, ()>

Reset a Redis Cluster node, in a more or less drastic way depending on the reset type, that can be hard or soft.

fn cluster_saveconfig(self) -> PreparedCommand<'a, Self, ()>

Forces a node to save the nodes.conf configuration on disk. Before to return the command calls fsync(2) in order to make sure the configuration is flushed on the computer disk.

fn cluster_set_config_epoch( self, config_epoch: u64, ) -> PreparedCommand<'a, Self, ()>

This command sets a specific config epoch in a fresh node.

fn cluster_setslot( self, slot: u16, subcommand: ClusterSetSlotSubCommand, ) -> PreparedCommand<'a, Self, ()>

This command is responsible of changing the state of a hash slot in the receiving node in different ways.

fn cluster_shards<R: Response>(self) -> PreparedCommand<'a, Self, R>

This command returns details about the shards of the cluster.

fn cluster_slots<R: Response>(self) -> PreparedCommand<'a, Self, R>

This command returns details details about which cluster slots map to which Redis instances.

fn readonly(self) -> PreparedCommand<'a, Self, ()>

Enables read queries for a connection to a Redis Cluster replica node.

fn readwrite(self) -> PreparedCommand<'a, Self, ()>

Disables read queries for a connection to a Redis Cluster replica node.

impl<'a> ConnectionCommands<'a> for &'a Client

fn auth( self, username: Option<impl Args>, password: impl Args, ) -> PreparedCommand<'a, Self, ()>

Authenticates the current connection.

fn client_caching( self, mode: ClientCachingMode, ) -> PreparedCommand<'a, Self, Option<()>>

This command controls the tracking of the keys in the next command executed by the connection, when tracking is enabled in OPTIN or OPTOUT mode.

fn client_getname<R: Response>(self) -> PreparedCommand<'a, Self, R>

Returns the name of the current connection as set by [CLIENT SETNAME].

fn client_getredir(self) -> PreparedCommand<'a, Self, i64>

This command returns the client ID we are redirecting our tracking notifications to.

fn client_help<R: Response>(self) -> PreparedCommand<'a, Self, R>

The command returns a helpful text describing the different CLIENT subcommands.

fn client_id(self) -> PreparedCommand<'a, Self, i64>

The command just returns the ID of the current connection.

fn client_info(self) -> PreparedCommand<'a, Self, ClientInfo>

The command returns information and statistics about the current client connection in a mostly human readable format.

fn client_kill( self, options: ClientKillOptions, ) -> PreparedCommand<'a, Self, usize>

Closes a given clients connection based on a filter list

fn client_list( self, options: ClientListOptions, ) -> PreparedCommand<'a, Self, ClientListResult>

Returns information and statistics about the client connections server in a mostly human readable format.

fn client_no_evict(self, no_evict: bool) -> PreparedCommand<'a, Self, ()>

sets the client eviction mode for the current connection.

fn client_no_touch(self, no_touch: bool) -> PreparedCommand<'a, Self, ()>

The command controls whether commands sent by the client will alter the LRU/LFU of the keys they access. If ON, the client will not change LFU/LRU stats. If OFF or send TOUCH, client will change LFU/LRU stats just as a normal client.

fn client_pause( self, timeout: u64, mode: ClientPauseMode, ) -> PreparedCommand<'a, Self, ()>

Connections control command able to suspend all the Redis clients for the specified amount of time (in milliseconds).

fn client_reply(self, mode: ClientReplyMode) -> PreparedCommand<'a, Self, ()>

Sometimes it can be useful for clients to completely disable replies from the Redis server.

fn client_setname( self, connection_name: impl Args, ) -> PreparedCommand<'a, Self, ()>

Assigns a name to the current connection.

fn client_setinfo( self, attr: ClientInfoAttribute, info: impl Args, ) -> PreparedCommand<'a, Self, ()>

Assigns various info attributes to the current connection. There is no limit to the length of these attributes. However it is not possible to use spaces, newlines, or other non-printable characters. Look changes with commands client_list or client_info.

fn client_tracking( self, status: ClientTrackingStatus, options: ClientTrackingOptions, ) -> PreparedCommand<'a, Self, ()>

This command enables the tracking feature of the Redis server, that is used for server assisted client side caching.

fn client_trackinginfo(self) -> PreparedCommand<'a, Self, ClientTrackingInfo>

This command enables the tracking feature of the Redis server, that is used for server assisted client side caching.

fn client_unblock( self, client_id: i64, mode: ClientUnblockMode, ) -> PreparedCommand<'a, Self, bool>

This command can unblock, from a different connection, a client blocked in a blocking operation, such as for instance BRPOP or XREAD or WAIT.

fn client_unpause(self) -> PreparedCommand<'a, Self, bool>

Used to resume command processing for all clients that were paused by client_pause.

fn echo<R: Response>(self, message: impl Args) -> PreparedCommand<'a, Self, R>

Returns message.

fn hello(self, options: HelloOptions) -> PreparedCommand<'a, Self, HelloResult>

Switch to a different protocol, optionally authenticating and setting the connection’s name, or provide a contextual client report.

fn ping<R: Response>(self, options: PingOptions) -> PreparedCommand<'a, Self, R>

Returns PONG if no argument is provided, otherwise return a copy of the argument as a bulk.

fn quit(self) -> PreparedCommand<'a, Self, ()>

Ask the server to close the connection.

fn reset(self) -> PreparedCommand<'a, Self, ()>

This command performs a full reset of the connection’s server-side context, mimicking the effect of disconnecting and reconnecting again.

fn select(self, index: usize) -> PreparedCommand<'a, Self, ()>

Select the Redis logical database having the specified zero-based numeric index.

impl<'a> CountMinSketchCommands<'a> for &'a Client

fn cms_incrby<R: Response>( self, key: impl Args, items: impl Args, ) -> PreparedCommand<'a, Self, R>

Increases the count of item by increment.

fn cms_info(self, key: impl Args) -> PreparedCommand<'a, Self, CmsInfoResult>

Returns width, depth and total count of the sketch.

fn cms_initbydim( self, key: impl Args, width: usize, depth: usize, ) -> PreparedCommand<'a, Self, ()>

Initializes a Count-Min Sketch to dimensions specified by user.

fn cms_initbyprob( self, key: impl Args, error: f64, probability: f64, ) -> PreparedCommand<'a, Self, ()>

Initializes a Count-Min Sketch to accommodate requested tolerances.

fn cms_merge( self, destination: impl Args, sources: impl Args, weights: Option<impl Args>, ) -> PreparedCommand<'a, Self, ()>

Returns the count for one or more items in a sketch.

fn cms_query<R: Response>( self, key: impl Args, items: impl Args, ) -> PreparedCommand<'a, Self, R>

Merges several sketches into one sketch.

impl<'a> CuckooCommands<'a> for &'a Client

fn cf_add( self, key: impl Args, item: impl Args, ) -> PreparedCommand<'a, Self, ()>

Adds an item to the cuckoo filter, creating the filter if it does not exist.

fn cf_addnx( self, key: impl Args, item: impl Args, ) -> PreparedCommand<'a, Self, bool>

Adds an item to a cuckoo filter if the item did not exist previously.

fn cf_count( self, key: impl Args, item: impl Args, ) -> PreparedCommand<'a, Self, usize>

Returns the number of times an item may be in the filter.

fn cf_del( self, key: impl Args, item: impl Args, ) -> PreparedCommand<'a, Self, bool>

Deletes an item once from the filter.

fn cf_exists( self, key: impl Args, item: impl Args, ) -> PreparedCommand<'a, Self, bool>

Check if an item exists in a Cuckoo Filter key

fn cf_info(self, key: impl Args) -> PreparedCommand<'a, Self, CfInfoResult>

Return information about key

fn cf_insert( self, key: impl Args, options: CfInsertOptions, item: impl Args, ) -> PreparedCommand<'a, Self, Vec<bool>>

Adds one or more items to a cuckoo filter, allowing the filter to be created with a custom capacity if it does not exist yet.

fn cf_insertnx<R: Response>( self, key: impl Args, options: CfInsertOptions, item: impl Args, ) -> PreparedCommand<'a, Self, R>

Adds one or more items to a cuckoo filter, allowing the filter to be created with a custom capacity if it does not exist yet.

fn cf_loadchunk( self, key: impl Args, iterator: i64, data: impl Args, ) -> PreparedCommand<'a, Self, ()>

Restores a filter previously saved using cf_scandump.

fn cf_mexists<R: Response>( self, key: impl Args, items: impl Args, ) -> PreparedCommand<'a, Self, R>

Check if one or more items exists in a Cuckoo Filter key

fn cf_reserve( self, key: impl Args, capacity: usize, options: CfReserveOptions, ) -> PreparedCommand<'a, Self, ()>

Create a Cuckoo Filter as key with a single sub-filter for the initial amount of capacity for items. Because of how Cuckoo Filters work, the filter is likely to declare itself full before capacity is reached and therefore fill rate will likely never reach 100%. The fill rate can be improved by using a larger bucketsize at the cost of a higher error rate. When the filter self-declare itself full, it will auto-expand by generating additional sub-filters at the cost of reduced performance and increased error rate. The new sub-filter is created with size of the previous sub-filter multiplied by expansion. Like bucket size, additional sub-filters grow the error rate linearly. The size of the new sub-filter is the size of the last sub-filter multiplied by expansion.

fn cf_scandump( self, key: impl Args, iterator: i64, ) -> PreparedCommand<'a, Self, CfScanDumpResult>

Begins an incremental save of the cuckoo filter. This is useful for large cuckoo filters which cannot fit into the normal dump and restore model.

impl Drop for Client

fn drop(&mut self)

if this client is the last client on the shared connection, the channel to send messages to the underlying network handler will be closed explicitely

impl<'a> GenericCommands<'a> for &'a Client

fn copy( self, source: impl Args, destination: impl Args, destination_db: Option<usize>, replace: bool, ) -> PreparedCommand<'a, Self, bool>

This command copies the value stored at the source key to the destination key.

fn del(self, keys: impl Args) -> PreparedCommand<'a, Self, usize>

Removes the specified keys. A key is ignored if it does not exist.

fn dump(self, key: impl Args) -> PreparedCommand<'a, Self, DumpResult>

Serialize the value stored at key in a Redis-specific format and return it to the user.

fn exists(self, keys: impl Args) -> PreparedCommand<'a, Self, usize>

Returns if keys exist.

fn expire( self, key: impl Args, seconds: u64, option: ExpireOption, ) -> PreparedCommand<'a, Self, bool>

Set a timeout on key in seconds

fn expireat( self, key: impl Args, unix_time_seconds: u64, option: ExpireOption, ) -> PreparedCommand<'a, Self, bool>

EXPIREAT has the same effect and semantic as EXPIRE, but instead of specifying the number of seconds representing the TTL (time to live), it takes an absolute Unix timestamp (seconds since January 1, 1970)

fn expiretime(self, key: impl Args) -> PreparedCommand<'a, Self, i64>

Returns the absolute Unix timestamp (since January 1, 1970) in seconds at which the given key will expire.

fn keys<R: Response>(self, pattern: impl Args) -> PreparedCommand<'a, Self, R>

Returns all keys matching pattern.

fn migrate( self, host: impl Args, port: u16, key: impl Args, destination_db: usize, timeout: u64, options: MigrateOptions, ) -> PreparedCommand<'a, Self, MigrateResult>

Atomically transfer a key or a collection of keys from a source Redis instance to a destination Redis instance.

fn move_(self, key: impl Args, db: usize) -> PreparedCommand<'a, Self, i64>

Move key from the currently selected database to the specified destination database.

fn object_encoding<R: Response>( self, key: impl Args, ) -> PreparedCommand<'a, Self, R>

Returns the internal encoding for the Redis object stored at key

fn object_freq(self, key: impl Args) -> PreparedCommand<'a, Self, i64>

This command returns the logarithmic access frequency counter of a Redis object stored at key.

fn object_help<R: Response>(self) -> PreparedCommand<'a, Self, R>

The command returns a helpful text describing the different OBJECT subcommands.

fn object_idle_time(self, key: impl Args) -> PreparedCommand<'a, Self, i64>

This command returns the time in seconds since the last access to the value stored at key.

fn object_refcount(self, key: impl Args) -> PreparedCommand<'a, Self, i64>

This command returns the reference count of the stored at key.

fn persist(self, key: impl Args) -> PreparedCommand<'a, Self, bool>

Remove the existing timeout on key, turning the key from volatile (a key with an expire set) to persistent (a key that will never expire as no timeout is associated).

fn pexpire( self, key: impl Args, milliseconds: u64, option: ExpireOption, ) -> PreparedCommand<'a, Self, bool>

This command works exactly like EXPIRE but the time to live of the key is specified in milliseconds instead of seconds.

fn pexpireat( self, key: impl Args, unix_time_milliseconds: u64, option: ExpireOption, ) -> PreparedCommand<'a, Self, bool>

PEXPIREAT has the same effect and semantic as EXPIREAT, but the Unix time at which the key will expire is specified in milliseconds instead of seconds.

fn pexpiretime(self, key: impl Args) -> PreparedCommand<'a, Self, i64>

PEXPIRETIME has the same semantic as EXPIRETIME, but returns the absolute Unix expiration timestamp in milliseconds instead of seconds.

fn pttl(self, key: impl Args) -> PreparedCommand<'a, Self, i64>

Returns the remaining time to live of a key that has a timeout.

fn randomkey<R: Response>(self) -> PreparedCommand<'a, Self, R>

Return a random key from the currently selected database.

fn rename( self, key: impl Args, new_key: impl Args, ) -> PreparedCommand<'a, Self, ()>

Renames key to newkey.

fn renamenx( self, key: impl Args, new_key: impl Args, ) -> PreparedCommand<'a, Self, bool>

Renames key to newkey if newkey does not yet exist. It returns an error when key does not exist.

fn restore( self, key: impl Args, ttl: u64, serialized_value: Vec<u8>, options: RestoreOptions, ) -> PreparedCommand<'a, Self, ()>

Create a key associated with a value that is obtained by deserializing the provided serialized value (obtained via DUMP).

fn scan<R: Response>( self, cursor: u64, options: ScanOptions, ) -> PreparedCommand<'a, Self, R>

Iterates the set of keys in the currently selected Redis database.

fn sort<R: Response>( self, key: impl Args, options: SortOptions, ) -> PreparedCommand<'a, Self, R>

Returns the elements contained in the list, set or sorted set at key.

fn sort_and_store( self, key: impl Args, destination: impl Args, options: SortOptions, ) -> PreparedCommand<'a, Self, usize>

Stores the elements contained in the list, set or sorted set at key.

fn sort_readonly<R: Response>( self, key: impl Args, options: SortOptions, ) -> PreparedCommand<'a, Self, R>

Read-only variant of the SORT command.

fn touch(self, keys: impl Args) -> PreparedCommand<'a, Self, usize>

Alters the last access time of a key(s). A key is ignored if it does not exist.

fn ttl(self, key: impl Args) -> PreparedCommand<'a, Self, i64>

Returns the remaining time to live of a key that has a timeout.

fn type_(self, key: impl Args) -> PreparedCommand<'a, Self, String>

Returns the string representation of the type of the value stored at key.

fn unlink(self, keys: impl Args) -> PreparedCommand<'a, Self, usize>

This command is very similar to DEL: it removes the specified keys.

fn wait( self, num_replicas: usize, timeout: u64, ) -> PreparedCommand<'a, Self, usize>

This command blocks the current client until all the previous write commands are successfully transferred and acknowledged by at least the specified number of replicas.

impl<'a> GeoCommands<'a> for &'a Client

fn geoadd( self, key: impl Args, condition: GeoAddCondition, change: bool, items: impl Args, ) -> PreparedCommand<'a, Self, usize>

Adds the specified geospatial items (longitude, latitude, name) to the specified key.

fn geodist( self, key: impl Args, member1: impl Args, member2: impl Args, unit: GeoUnit, ) -> PreparedCommand<'a, Self, Option<f64>>

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

fn geohash<R: Response>( self, key: impl Args, members: impl Args, ) -> PreparedCommand<'a, Self, R>

Return valid Geohash strings representing the position of one or more elements in a sorted set value representing a geospatial index (where elements were added using geoadd).

fn geopos( self, key: impl Args, members: impl Args, ) -> PreparedCommand<'a, Self, Vec<Option<(f64, f64)>>>

Return the positions (longitude,latitude) of all the specified members of the geospatial index represented by the sorted set at key.

fn geosearch<F: Args, R: Response>( self, key: impl Args, from: GeoSearchFrom<F>, by: GeoSearchBy, options: GeoSearchOptions, ) -> PreparedCommand<'a, Self, R>

Return the members of a sorted set populated with geospatial information using geoadd, which are within the borders of the area specified by a given shape.

fn geosearchstore<F: Args>( self, destination: impl Args, source: impl Args, from: GeoSearchFrom<F>, by: GeoSearchBy, options: GeoSearchStoreOptions, ) -> PreparedCommand<'a, Self, usize>

This command is like geosearch, but stores the result in destination key.

impl<'a> HashCommands<'a> for &'a Client

fn hdel( self, key: impl Args, fields: impl Args, ) -> PreparedCommand<'a, Self, usize>

Removes the specified fields from the hash stored at key.

fn hexists( self, key: impl Args, field: impl Args, ) -> PreparedCommand<'a, Self, bool>

Returns if field is an existing field in the hash stored at key.

fn hexpire<R: Response>( self, key: impl Args, seconds: u64, option: ExpireOption, fields: impl Args, ) -> PreparedCommand<'a, Self, R>

Set an expiration (TTL or time to live) on one or more fields of a given hash key.

fn hexpireat<R: Response>( self, key: impl Args, unix_time_seconds: u64, option: ExpireOption, fields: impl Args, ) -> PreparedCommand<'a, Self, R>

HEXPIREAT has the same effect and semantics as HEXPIRE, but instead of specifying the number of seconds for the TTL (time to live), it takes an absolute Unix timestamp in seconds since Unix epoch.

fn hexpiretime<R: Response>( self, key: impl Args, fields: impl Args, ) -> PreparedCommand<'a, Self, R>

Returns the absolute Unix timestamp in seconds since Unix epoch at which the given key’s field(s) will expire.

fn hget<R: Response>( self, key: impl Args, field: impl Args, ) -> PreparedCommand<'a, Self, R>

Returns the value associated with field in the hash stored at key.

fn hgetall<R: Response>(self, key: impl Args) -> PreparedCommand<'a, Self, R>

Returns all fields and values of the hash stored at key.

fn hgetdel<R: Response>( self, key: impl Args, fields: impl Args, ) -> PreparedCommand<'a, Self, R>

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

fn hgetex<R: Response>( self, key: impl Args, options: GetExOptions, fields: impl Args, ) -> PreparedCommand<'a, Self, R>

Get the value of one or more fields of a given hash key and optionally set their expiration time or time-to-live (TTL).

fn hincrby( self, key: impl Args, field: impl Args, increment: i64, ) -> PreparedCommand<'a, Self, i64>

Increments the number stored at field in the hash stored at key by increment.

fn hincrbyfloat( self, key: impl Args, field: impl Args, increment: f64, ) -> PreparedCommand<'a, Self, f64>

Increment the specified field of a hash stored at key, and representing a floating point number, by the specified increment.

fn hkeys<R: Response>(self, key: impl Args) -> PreparedCommand<'a, Self, R>

Returns all field names in the hash stored at key.

fn hlen(self, key: impl Args) -> PreparedCommand<'a, Self, usize>

Returns the number of fields contained in the hash stored at key.

fn hmget<R: Response>( self, key: impl Args, fields: impl Args, ) -> PreparedCommand<'a, Self, R>

Returns the values associated with the specified fields in the hash stored at key.

fn hpersist<R: Response>( self, key: impl Args, fields: impl Args, ) -> PreparedCommand<'a, Self, R>

Remove the existing expiration on a hash key’s field(s), turning the field(s) from volatile (a field with expiration set) to persistent (a field that will never expire as no TTL (time to live) is associated).

fn hpexpire<R: Response>( self, key: impl Args, milliseconds: u64, option: ExpireOption, fields: impl Args, ) -> PreparedCommand<'a, Self, R>

This command works like hexpire, but the expiration of a field is specified in milliseconds instead of seconds.

fn hpexpireat<R: Response>( self, key: impl Args, unix_time_milliseconds: u64, option: ExpireOption, fields: impl Args, ) -> PreparedCommand<'a, Self, R>

This command has the same effect and semantics as hexpireat, but the Unix time at which the field will expire is specified in milliseconds since Unix epoch instead of seconds.

fn hpexpiretime<R: Response>( self, key: impl Args, fields: impl Args, ) -> PreparedCommand<'a, Self, R>

This command has the same semantics as hexpiretime, but returns the absolute Unix expiration timestamp in milliseconds since Unix epoch instead of seconds.

fn hpttl<R: Response>( self, key: impl Args, fields: impl Args, ) -> PreparedCommand<'a, Self, R>

Like httl, this command returns the remaining TTL (time to live) of a field that has an expiration set, but in milliseconds instead of seconds.

fn hrandfield<R: Response>(self, key: impl Args) -> PreparedCommand<'a, Self, R>

return random fields from the hash value stored at key.

fn hrandfields<R: Response>( self, key: impl Args, count: isize, ) -> PreparedCommand<'a, Self, R>

return random fields from the hash value stored at key.

fn hrandfields_with_values<R: Response>( self, key: impl Args, count: isize, ) -> PreparedCommand<'a, Self, R>

return random fields from the hash value stored at key.

fn hscan<F: Response + DeserializeOwned, V: Response + DeserializeOwned>( self, key: impl Args, cursor: u64, options: HScanOptions, ) -> PreparedCommand<'a, Self, HScanResult<F, V>>

Iterates fields of Hash types and their associated values.

fn hset( self, key: impl Args, items: impl Args, ) -> PreparedCommand<'a, Self, usize>

Sets field in the hash stored at key to value.

fn hsetex( self, key: impl Args, condition: HSetExCondition, expiration: SetExpiration, keep_ttl: bool, items: impl Args, ) -> PreparedCommand<'a, Self, bool>

Set the value of one or more fields of a given hash key, and optionally set their expiration time or time-to-live (TTL).

fn hsetnx( self, key: impl Args, field: impl Args, value: impl Args, ) -> PreparedCommand<'a, Self, bool>

Sets field in the hash stored at key to value, only if field does not yet exist.

fn hstrlen( self, key: impl Args, field: impl Args, ) -> PreparedCommand<'a, Self, usize>

Returns the string length of the value associated with field in the hash stored at key.

fn httl<R: Response>( self, key: impl Args, fields: impl Args, ) -> PreparedCommand<'a, Self, R>

Returns the remaining TTL (time to live) of a hash key’s field(s) that have a set expiration. This introspection capability allows you to check how many seconds a given hash field will continue to be part of the hash key.

fn hvals<R: Response>(self, key: impl Args) -> PreparedCommand<'a, Self, R>

list of values in the hash, or an empty list when key does not exist.

impl<'a> HyperLogLogCommands<'a> for &'a Client

fn pfadd( self, key: impl Args, elements: impl Args, ) -> PreparedCommand<'a, Self, bool>

Adds the specified elements to the specified HyperLogLog.

fn pfcount(self, keys: impl Args) -> PreparedCommand<'a, Self, usize>

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

fn pfmerge( self, dest_key: impl Args, source_keys: impl Args, ) -> PreparedCommand<'a, Self, ()>

Merge N different HyperLogLogs into a single one.

impl<'a> JsonCommands<'a> for &'a Client

fn json_arrappend<R: Response>( self, key: impl Args, path: impl Args, values: impl Args, ) -> PreparedCommand<'a, Self, R>

Append the json values into the array at path after the last element in it

fn json_arrindex<R: Response>( self, key: impl Args, path: impl Args, value: impl Args, options: JsonArrIndexOptions, ) -> PreparedCommand<'a, Self, R>

Search for the first occurrence of a scalar JSON value in an array

fn json_arrinsert<R: Response>( self, key: impl Args, path: impl Args, index: isize, values: impl Args, ) -> PreparedCommand<'a, Self, R>

Insert the json values into the array at path before the index (shifts to the right)

fn json_arrlen<R: Response>( self, key: impl Args, path: impl Args, ) -> PreparedCommand<'a, Self, R>

Report the length of the JSON array at path in key

fn json_arrpop<R: Response>( self, key: impl Args, path: impl Args, index: isize, ) -> PreparedCommand<'a, Self, R>

Remove and return an element from the index in the array

fn json_arrtrim<R: Response>( self, key: impl Args, path: impl Args, start: isize, stop: isize, ) -> PreparedCommand<'a, Self, R>

Remove and return an element from the index in the array

fn json_clear( self, key: impl Args, path: impl Args, ) -> PreparedCommand<'a, Self, usize>

Clear container values (arrays/objects) and set numeric values to 0

fn json_debug_memory<R: Response>( self, key: impl Args, path: impl Args, ) -> PreparedCommand<'a, Self, R>

Report a value’s memory usage in bytes

fn json_del( self, key: impl Args, path: impl Args, ) -> PreparedCommand<'a, Self, usize>

Delete a value

fn json_forget( self, key: impl Args, path: impl Args, ) -> PreparedCommand<'a, Self, usize>

See json_del

fn json_get<R: Response>( self, key: impl Args, options: JsonGetOptions, ) -> PreparedCommand<'a, Self, R>

Return the value at path in JSON serialized form

fn json_mget<R: Response>( self, keys: impl Args, path: impl Args, ) -> PreparedCommand<'a, Self, R>

Return the values at path from multiple key arguments

fn json_numincrby<R: Response>( self, key: impl Args, path: impl Args, value: impl Args, ) -> PreparedCommand<'a, Self, R>

Increment the number value stored at path by number

fn json_nummultby<R: Response>( self, key: impl Args, path: impl Args, value: impl Args, ) -> PreparedCommand<'a, Self, R>

Multiply the number value stored at path by number

fn json_objkeys<R: Response>( self, key: impl Args, path: impl Args, ) -> PreparedCommand<'a, Self, R>

Return the keys in the object that’s referenced by path

fn json_objlen<R: Response>( self, key: impl Args, path: impl Args, ) -> PreparedCommand<'a, Self, R>

Report the number of keys in the JSON object at path in key

fn json_resp<R: Response>( self, key: impl Args, path: impl Args, ) -> PreparedCommand<'a, Self, R>

Return the JSON in key in Redis serialization protocol specification form

fn json_set( self, key: impl Args, path: impl Args, value: impl Args, condition: SetCondition, ) -> PreparedCommand<'a, Self, ()>

Set the JSON value at path in key

fn json_strappend<R: Response>( self, key: impl Args, path: impl Args, value: impl Args, ) -> PreparedCommand<'a, Self, R>

Append the json-string values to the string at path

fn json_strlen<R: Response>( self, key: impl Args, path: impl Args, ) -> PreparedCommand<'a, Self, R>

Report the length of the JSON String at path in key

fn json_toggle<R: Response>( self, key: impl Args, path: impl Args, ) -> PreparedCommand<'a, Self, R>

Toggle a Boolean value stored at path

fn json_type<R: Response>( self, key: impl Args, path: impl Args, ) -> PreparedCommand<'a, Self, R>

Report the type of JSON value at path

impl<'a> ListCommands<'a> for &'a Client

fn lindex<R: Response>( self, key: impl Args, index: isize, ) -> PreparedCommand<'a, Self, R>

Returns the element at index index in the list stored at key.

fn linsert( self, key: impl Args, where_: LInsertWhere, pivot: impl Args, element: impl Args, ) -> PreparedCommand<'a, Self, usize>

Inserts element in the list stored at key either before or after the reference value pivot.

fn llen(self, key: impl Args) -> PreparedCommand<'a, Self, usize>

Inserts element in the list stored at key either before or after the reference value pivot.

fn lmove<R: Response>( self, source: impl Args, destination: impl Args, where_from: LMoveWhere, where_to: LMoveWhere, ) -> PreparedCommand<'a, Self, R>

Atomically returns and removes the first/last element (head/tail depending on the wherefrom argument) of the list stored at source, and pushes the element at the first/last element (head/tail depending on the whereto argument) of the list stored at destination.

fn lmpop<R: Response + DeserializeOwned>( self, keys: impl Args, where_: LMoveWhere, count: usize, ) -> PreparedCommand<'a, Self, (String, Vec<R>)>

Pops one or more elements from the first non-empty list key from the list of provided key names.

fn lpop<R: Response>( self, key: impl Args, count: usize, ) -> PreparedCommand<'a, Self, R>

Removes and returns the first elements of the list stored at key.

fn lpos( self, key: impl Args, element: impl Args, rank: Option<usize>, max_len: Option<usize>, ) -> PreparedCommand<'a, Self, Option<usize>>

Returns the index of matching elements inside a Redis list.

fn lpos_with_count<R: Response>( self, key: impl Args, element: impl Args, num_matches: usize, rank: Option<usize>, max_len: Option<usize>, ) -> PreparedCommand<'a, Self, R>

Returns the index of matching elements inside a Redis list.

fn lpush( self, key: impl Args, elements: impl Args, ) -> PreparedCommand<'a, Self, usize>

Insert all the specified values at the head of the list stored at key

fn lpushx( self, key: impl Args, elements: impl Args, ) -> PreparedCommand<'a, Self, usize>

Inserts specified values at the head of the list stored at key, only if key already exists and holds a list.

fn lrange<R: Response>( self, key: impl Args, start: isize, stop: isize, ) -> PreparedCommand<'a, Self, R>

Returns the specified elements of the list stored at key.

fn lrem( self, key: impl Args, count: isize, element: impl Args, ) -> PreparedCommand<'a, Self, usize>

Removes the first count occurrences of elements equal to element from the list stored at key.

fn lset( self, key: impl Args, index: isize, element: impl Args, ) -> PreparedCommand<'a, Self, ()>

Sets the list element at index to element.

fn ltrim( self, key: impl Args, start: isize, stop: isize, ) -> PreparedCommand<'a, Self, ()>

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

fn rpop<R: Response>( self, key: impl Args, count: usize, ) -> PreparedCommand<'a, Self, R>

Removes and returns the first elements of the list stored at key.

fn rpush( self, key: impl Args, elements: impl Args, ) -> PreparedCommand<'a, Self, usize>

Insert all the specified values at the tail of the list stored at key

fn rpushx( self, key: impl Args, elements: impl Args, ) -> PreparedCommand<'a, Self, usize>

Inserts specified values at the tail of the list stored at key, only if key already exists and holds a list.

impl<'a> PubSubCommands<'a> for &'a Client

async fn subscribe(self, channels: impl Args) -> Result<PubSubStream>

Subscribes the client to the specified channels.

async fn psubscribe(self, patterns: impl Args) -> Result<PubSubStream>

Subscribes the client to the given patterns.

async fn ssubscribe(self, shardchannels: impl Args) -> Result<PubSubStream>

Subscribes the client to the specified channels.

fn publish( self, channel: impl Args, message: impl Args, ) -> PreparedCommand<'a, Self, usize>

Posts a message to the given channel.

fn pub_sub_channels<R: Response>( self, options: PubSubChannelsOptions, ) -> PreparedCommand<'a, Self, R>

Lists the currently active channels.

fn pub_sub_help(self) -> PreparedCommand<'a, Self, Vec<String>>

The command returns a helpful text describing the different PUBSUB subcommands.

fn pub_sub_numpat(self) -> PreparedCommand<'a, Self, usize>

Returns the number of unique patterns that are subscribed to by clients (that are performed using the PSUBSCRIBE command).

fn pub_sub_numsub<R: Response>( self, channels: impl Args, ) -> PreparedCommand<'a, Self, R>

Returns the number of subscribers (exclusive of clients subscribed to patterns) for the specified channels.

fn pub_sub_shardchannels<R: Response>( self, options: PubSubChannelsOptions, ) -> PreparedCommand<'a, Self, R>

Lists the currently active shard channels.

fn pub_sub_shardnumsub<R: Response>( self, channels: impl Args, ) -> PreparedCommand<'a, Self, R>

Returns the number of subscribers for the specified shard channels.

fn spublish( self, shardchannel: impl Args, message: impl Args, ) -> PreparedCommand<'a, Self, usize>

Posts a message to the given shard channel.

impl<'a> ScriptingCommands<'a> for &'a Client

fn eval<R: Response>(self, builder: CallBuilder) -> PreparedCommand<'a, Self, R>

Invoke the execution of a server-side Lua script.

fn eval_readonly<R: Response>( self, builder: CallBuilder, ) -> PreparedCommand<'a, Self, R>

This is a read-only variant of the eval] command that cannot execute commands that modify data.

fn evalsha<R: Response>( self, builder: CallBuilder, ) -> PreparedCommand<'a, Self, R>

Evaluate a script from the server’s cache by its SHA1 digest.

fn evalsha_readonly<R: Response>( self, builder: CallBuilder, ) -> PreparedCommand<'a, Self, R>

This is a read-only variant of the evalsha command that cannot execute commands that modify data.

fn fcall<R: Response>( self, builder: CallBuilder, ) -> PreparedCommand<'a, Self, R>

Invoke a function.

fn fcall_readonly<R: Response>( self, builder: CallBuilder, ) -> PreparedCommand<'a, Self, R>

Invoke a function.

fn function_delete( self, library_name: impl Args, ) -> PreparedCommand<'a, Self, ()>

Delete a library and all its functions.

fn function_dump(self) -> PreparedCommand<'a, Self, FunctionDumpResult>

Return the serialized payload of loaded libraries. You can restore the serialized payload later with the function_restore command.

fn function_flush( self, flushing_mode: FlushingMode, ) -> PreparedCommand<'a, Self, ()>

Deletes all the libraries.

fn function_help(self) -> PreparedCommand<'a, Self, Vec<String>>

The command returns a helpful text describing the different FUNCTION subcommands.

fn function_kill(self) -> PreparedCommand<'a, Self, ()>

Kill a function that is currently executing.

fn function_list( self, options: FunctionListOptions, ) -> PreparedCommand<'a, Self, Vec<LibraryInfo>>

Return information about the functions and libraries.

fn function_load<R: Response>( self, replace: bool, function_code: impl Args, ) -> PreparedCommand<'a, Self, R>

Load a library to Redis.

fn function_restore( self, serialized_payload: impl Args, policy: FunctionRestorePolicy, ) -> PreparedCommand<'a, Self, ()>

Restore libraries from the serialized payload.

fn function_stats(self) -> PreparedCommand<'a, Self, FunctionStats>

Return information about the function that’s currently running and information about the available execution engines.

fn script_debug( self, debug_mode: ScriptDebugMode, ) -> PreparedCommand<'a, Self, ()>

Set the debug mode for subsequent scripts executed with EVAL.

fn script_exists(self, sha1s: impl Args) -> PreparedCommand<'a, Self, Vec<bool>>

Returns information about the existence of the scripts in the script cache.

fn script_flush( self, flushing_mode: FlushingMode, ) -> PreparedCommand<'a, Self, ()>

Flush the Lua scripts cache.

fn script_kill(self) -> PreparedCommand<'a, Self, ()>

Kills the currently executing EVAL script, assuming no write operation was yet performed by the script.

fn script_load<R: Response>( self, script: impl Args, ) -> PreparedCommand<'a, Self, R>

Load a script into the scripts cache, without executing it.

impl<'a> SearchCommands<'a> for &'a Client

fn ft_aggregate( self, index: impl Args, query: impl Args, options: FtAggregateOptions, ) -> PreparedCommand<'a, Self, FtAggregateResult>

Run a search query on an index, and perform aggregate transformations on the results, extracting statistics etc from them

fn ft_aliasadd( self, alias: impl Args, index: impl Args, ) -> PreparedCommand<'a, Self, ()>

Add an alias to an index

fn ft_aliasdel(self, alias: impl Args) -> PreparedCommand<'a, Self, ()>

Remove an alias from an index

fn ft_aliasupdate( self, alias: impl Args, index: impl Args, ) -> PreparedCommand<'a, Self, ()>

Add an alias to an index.

fn ft_alter( self, index: impl Args, skip_initial_scan: bool, attribute: FtFieldSchema, ) -> PreparedCommand<'a, Self, ()>

Add a new attribute to the index.

fn ft_config_get<R: Response>( self, option: impl Args, ) -> PreparedCommand<'a, Self, R>

Retrieve configuration options

fn ft_config_set( self, option: impl Args, value: impl Args, ) -> PreparedCommand<'a, Self, ()>

Set configuration options

fn ft_create( self, index: impl Args, options: FtCreateOptions, schema: impl Args, ) -> PreparedCommand<'a, Self, ()>

Create an index with the given specification

fn ft_cursor_del( self, index: impl Args, cursor_id: u64, ) -> PreparedCommand<'a, Self, ()>

Delete a cursor

fn ft_cursor_read( self, index: impl Args, cursor_id: u64, ) -> PreparedCommand<'a, Self, FtAggregateResult>

Read next results from an existing cursor

fn ft_dictadd( self, dict: impl Args, terms: impl Args, ) -> PreparedCommand<'a, Self, usize>

Add terms to a dictionary

fn ft_dictdel( self, dict: impl Args, terms: impl Args, ) -> PreparedCommand<'a, Self, usize>

Delete terms from a dictionary

fn ft_dictdump<R: Response>( self, dict: impl Args, ) -> PreparedCommand<'a, Self, R>

Dump all terms in the given dictionary

fn ft_dropindex( self, index: impl Args, dd: bool, ) -> PreparedCommand<'a, Self, ()>

Delete an index

fn ft_explain<R: Response>( self, index: impl Args, query: impl Args, dialect_version: Option<u64>, ) -> PreparedCommand<'a, Self, R>

Return the execution plan for a complex query

fn ft_explaincli( self, index: impl Args, query: impl Args, dialect_version: Option<u64>, ) -> PreparedCommand<'a, Self, Value>

Return the execution plan for a complex query but formatted for easier reading without using redis-cli --raw

fn ft_info(self, index: impl Args) -> PreparedCommand<'a, Self, FtInfoResult>

Return information and statistics on the index

fn ft_list<R: Response>(self) -> PreparedCommand<'a, Self, R>

Returns a list of all existing indexes.

fn ft_profile_search<I>( self, index: impl Args, limited: bool, query: impl Args, ) -> PreparedCommand<'a, Self, Value>

Perform a ft_search command and collects performance information

fn ft_profile_aggregate( self, index: impl Args, limited: bool, query: impl Args, ) -> PreparedCommand<'a, Self, Value>

Perform a ft_aggregate command and collects performance information

fn ft_search( self, index: impl Args, query: impl Args, options: FtSearchOptions, ) -> PreparedCommand<'a, Self, FtSearchResult>

Search the index with a textual query, returning either documents or just ids

fn ft_spellcheck( self, index: impl Args, query: impl Args, options: FtSpellCheckOptions, ) -> PreparedCommand<'a, Self, FtSpellCheckResult>

Perform spelling correction on a query, returning suggestions for misspelled terms

fn ft_syndump<R: Response>( self, index: impl Args, ) -> PreparedCommand<'a, Self, R>

Dump the contents of a synonym group

fn ft_synupdate( self, index: impl Args, synonym_group_id: impl Args, skip_initial_scan: bool, terms: impl Args, ) -> PreparedCommand<'a, Self, ()>

Update a synonym group

fn ft_tagvals<R: Response>( self, index: impl Args, field_name: impl Args, ) -> PreparedCommand<'a, Self, R>

Return a distinct set of values indexed in a Tag field

fn ft_sugadd( self, key: impl Args, string: impl Args, score: f64, options: FtSugAddOptions, ) -> PreparedCommand<'a, Self, usize>

Add a suggestion string to an auto-complete suggestion dictionary

fn ft_sugdel( self, key: impl Args, string: impl Args, ) -> PreparedCommand<'a, Self, bool>

Delete a string from a suggestion index

fn ft_sugget( self, key: impl Args, prefix: impl Args, options: FtSugGetOptions, ) -> PreparedCommand<'a, Self, Vec<FtSuggestion>>

Get completion suggestions for a prefix

fn ft_suglen(self, key: impl Args) -> PreparedCommand<'a, Self, usize>

Get the size of an auto-complete suggestion dictionary

impl<'a> SentinelCommands<'a> for &'a Client

fn sentinel_config_get<R: Response>( self, name: impl Args, ) -> PreparedCommand<'a, Self, R>

Get the current value of a global Sentinel configuration parameter.

fn sentinel_config_set( self, name: impl Args, value: impl Args, ) -> PreparedCommand<'a, Self, ()>

Set the value of a global Sentinel configuration parameter.

fn sentinel_ckquorum( self, master_name: impl Args, ) -> PreparedCommand<'a, Self, ()>

Check if the current Sentinel configuration is able to reach the quorum needed to failover a master, and the majority needed to authorize the failover.

fn sentinel_failover<N>( self, master_name: impl Args, ) -> PreparedCommand<'a, Self, ()>

Force a failover as if the master was not reachable, and without asking for agreement to other Sentinels (however a new version of the configuration will be published so that the other Sentinels will update their configurations).

fn sentinel_flushconfig(self) -> PreparedCommand<'a, Self, ()>

where Self: Sized,

Force Sentinel to rewrite its configuration on disk, including the current Sentinel state.

fn sentinel_get_master_addr_by_name( self, master_name: impl Args, ) -> PreparedCommand<'a, Self, Option<(String, u16)>>

Return the ip and port number of the master with that name.

fn sentinel_info_cache<R: Response>( self, master_names: impl Args, ) -> PreparedCommand<'a, Self, R>

Return cached info output from masters and replicas.

fn sentinel_master( self, master_name: impl Args, ) -> PreparedCommand<'a, Self, SentinelMasterInfo>

Show the state and info of the specified master.

fn sentinel_masters(self) -> PreparedCommand<'a, Self, Vec<SentinelMasterInfo>>

where Self: Sized,

Show a list of monitored masters and their state.

fn sentinel_monitor( self, name: impl Args, ip: impl Args, port: u16, quorum: usize, ) -> PreparedCommand<'a, Self, ()>

This command tells the Sentinel to start monitoring a new master with the specified name, ip, port, and quorum.

fn sentinel_remove(self, name: impl Args) -> PreparedCommand<'a, Self, ()>

This command is used in order to remove the specified master.

fn sentinel_set( self, name: impl Args, configs: impl Args, ) -> PreparedCommand<'a, Self, ()>

The SET command is very similar to the config_set command of Redis, and is used in order to change configuration parameters of a specific master.

fn sentinel_myid(self) -> PreparedCommand<'a, Self, String>

Return the ID of the Sentinel instance.

fn sentinel_pending_scripts(self) -> PreparedCommand<'a, Self, Vec<Value>>

This command returns information about pending scripts.

fn sentinel_replicas( self, master_name: impl Args, ) -> PreparedCommand<'a, Self, Vec<SentinelReplicaInfo>>

Show a list of replicas for this master, and their state.

fn sentinel_reset(self, pattern: impl Args) -> PreparedCommand<'a, Self, usize>

This command will reset all the masters with matching name.

fn sentinel_sentinels( self, master_name: impl Args, ) -> PreparedCommand<'a, Self, Vec<SentinelInfo>>

Show a list of sentinel instances for this master, and their state.

fn sentinel_simulate_failure( self, mode: SentinelSimulateFailureMode, ) -> PreparedCommand<'a, Self, ()>

where Self: Sized,

This command simulates different Sentinel crash scenarios.

impl<'a> ServerCommands<'a> for &'a Client

fn acl_cat<R: Response>( self, options: AclCatOptions, ) -> PreparedCommand<'a, Self, R>

The command shows the available ACL categories if called without arguments. If a category name is given, the command shows all the Redis commands in the specified category.

fn acl_deluser(self, usernames: impl Args) -> PreparedCommand<'a, Self, usize>

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

fn acl_dryrun<R: Response>( self, username: impl Args, command: impl Args, options: AclDryRunOptions, ) -> PreparedCommand<'a, Self, R>

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

fn acl_genpass<R: Response>( self, options: AclGenPassOptions, ) -> PreparedCommand<'a, Self, R>

Generates a password starting from /dev/urandom if available, otherwise (in systems without /dev/urandom) it uses a weaker system that is likely still better than picking a weak password by hand.

fn acl_getuser<R: Response>( self, username: impl Args, ) -> PreparedCommand<'a, Self, R>

The command returns all the rules defined for an existing ACL user.

fn acl_help<R: Response>(self) -> PreparedCommand<'a, Self, R>

where Self: Sized,

The command returns a helpful text describing the different ACL subcommands.

fn acl_list<R: Response>(self) -> PreparedCommand<'a, Self, R>

where Self: Sized,

The command shows the currently active ACL rules in the Redis server.

fn acl_load(self) -> PreparedCommand<'a, Self, ()>

where Self: Sized,

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.

fn acl_log<R: Response>( self, options: AclLogOptions, ) -> PreparedCommand<'a, Self, R>

The command shows a list of recent ACL security events

fn acl_save(self) -> PreparedCommand<'a, Self, ()>

where Self: Sized,

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.

fn acl_setuser( self, username: impl Args, rules: impl Args, ) -> PreparedCommand<'a, Self, ()>

Create an ACL user with the specified rules or modify the rules of an existing user.

fn acl_users<R: Response>(self) -> PreparedCommand<'a, Self, R>

The command shows a list of all the usernames of the currently configured users in the Redis ACL system.

fn acl_whoami<R: Response>(self) -> PreparedCommand<'a, Self, R>

where Self: Sized,

Return the username the current connection is authenticated with.

fn bgrewriteaof<R: Response>(self) -> PreparedCommand<'a, Self, R>

The command async rewrites the append-only file to disk.

fn bgsave<R: Response>( self, options: BgsaveOptions, ) -> PreparedCommand<'a, Self, R>

The command save the DB in background.

fn command(self) -> PreparedCommand<'a, Self, Vec<CommandInfo>>

where Self: Sized,

Return an array with details about every Redis command.

fn command_count(self) -> PreparedCommand<'a, Self, usize>

where Self: Sized,

Number of total commands in this Redis server.

fn command_docs<R: Response>( self, command_names: impl Args, ) -> PreparedCommand<'a, Self, R>

Number of total commands in this Redis server.

fn command_getkeys<R: Response>( self, args: impl Args, ) -> PreparedCommand<'a, Self, R>

A helper command to let you find the keys from a full Redis command.

fn command_getkeysandflags<R: Response>( self, args: impl Args, ) -> PreparedCommand<'a, Self, R>

A helper command to let you find the keys from a full Redis command together with flags indicating what each key is used for.

fn command_help<R: Response>(self) -> PreparedCommand<'a, Self, R>

where Self: Sized,

The command returns a helpful text describing the different COMMAND subcommands.

fn command_info( self, command_names: impl Args, ) -> PreparedCommand<'a, Self, Vec<CommandInfo>>

Return an array with details about multiple Redis command.

fn command_list<R: Response>( self, options: CommandListOptions, ) -> PreparedCommand<'a, Self, R>

Return an array of the server’s command names based on optional filters

fn config_get<R: Response>( self, params: impl Args, ) -> PreparedCommand<'a, Self, R>

Used to read the configuration parameters of a running Redis server.

fn config_help(self) -> PreparedCommand<'a, Self, Vec<String>>

where Self: Sized,

The command returns a helpful text describing the different CONFIG subcommands.

fn config_resetstat(self) -> PreparedCommand<'a, Self, ()>

where Self: Sized,

Resets the statistics reported by Redis using the info command.

fn config_rewrite(self) -> PreparedCommand<'a, Self, ()>

where Self: Sized,

Rewrites the redis.conf file the server was started with, applying the minimal changes needed to make it reflect the configuration currently used by the server, which may be different compared to the original one because of the use of the config_set command.

fn config_set(self, configs: impl Args) -> PreparedCommand<'a, Self, ()>

Used in order to reconfigure the server at run time without the need to restart Redis.

fn dbsize(self) -> PreparedCommand<'a, Self, usize>

where Self: Sized,

Return the number of keys in the currently-selected database.

fn failover(self, options: FailOverOptions) -> PreparedCommand<'a, Self, ()>

where Self: Sized,

This command will start a coordinated failover between the currently-connected-to master and one of its replicas.

fn flushdb(self, flushing_mode: FlushingMode) -> PreparedCommand<'a, Self, ()>

where Self: Sized,

Delete all the keys of the currently selected DB.

fn flushall(self, flushing_mode: FlushingMode) -> PreparedCommand<'a, Self, ()>

where Self: Sized,

Delete all the keys of all the existing databases, not just the currently selected one.

fn info<R: Response>(self, sections: impl Args) -> PreparedCommand<'a, Self, R>

This command returns information and statistics about the server in a format that is simple to parse by computers and easy to read by humans.

fn lastsave(self) -> PreparedCommand<'a, Self, u64>

where Self: Sized,

Return the UNIX TIME of the last DB save executed with success.

fn latency_doctor<R: Response>(self) -> PreparedCommand<'a, Self, R>

where Self: Sized,

This command reports about different latency-related issues and advises about possible remedies.

fn latency_graph<R: Response>( self, event: LatencyHistoryEvent, ) -> PreparedCommand<'a, Self, R>

where Self: Sized,

Produces an ASCII-art style graph for the specified event.

fn latency_help<R: Response>(self) -> PreparedCommand<'a, Self, R>

where Self: Sized,

The command returns a helpful text describing the different LATENCY subcommands.

fn latency_histogram<R: Response>( self, commands: impl Args, ) -> PreparedCommand<'a, Self, R>

This command reports a cumulative distribution of latencies in the format of a histogram for each of the specified command names.

fn latency_history<R: Response>( self, event: LatencyHistoryEvent, ) -> PreparedCommand<'a, Self, R>

This command returns the raw data of the event’s latency spikes time series.

fn latency_latest<R: Response>(self) -> PreparedCommand<'a, Self, R>

This command reports the latest latency events logged.

fn latency_reset(self, events: impl Args) -> PreparedCommand<'a, Self, usize>

This command resets the latency spikes time series of all, or only some, events.

fn lolwut(self, options: LolWutOptions) -> PreparedCommand<'a, Self, String>

where Self: Sized,

The LOLWUT command displays the Redis version: however as a side effect of doing so, it also creates a piece of generative computer art that is different with each version of Redis.

fn memory_doctor(self) -> PreparedCommand<'a, Self, String>

where Self: Sized,

This command reports about different memory-related issues that the Redis server experiences, and advises about possible remedies.

fn memory_help(self) -> PreparedCommand<'a, Self, Vec<String>>

where Self: Sized,

The command returns a helpful text describing the different MEMORY subcommands.

fn memory_malloc_stats(self) -> PreparedCommand<'a, Self, String>

where Self: Sized,

This command provides an internal statistics report from the memory allocator.

fn memory_purge(self) -> PreparedCommand<'a, Self, ()>

where Self: Sized,

This command attempts to purge dirty pages so these can be reclaimed by the allocator.

fn memory_stats(self) -> PreparedCommand<'a, Self, MemoryStats>

where Self: Sized,

This command returns information about the memory usage of the server.

fn memory_usage( self, key: impl Args, options: MemoryUsageOptions, ) -> PreparedCommand<'a, Self, Option<usize>>

This command reports the number of bytes that a key and its value require to be stored in RAM.

fn module_list<R: Response>(self) -> PreparedCommand<'a, Self, R>

Returns information about the modules loaded to the server.

fn module_help(self) -> PreparedCommand<'a, Self, Vec<String>>

where Self: Sized,

The command returns a helpful text describing the different MODULE subcommands.

fn module_load( self, path: impl Args, options: ModuleLoadOptions, ) -> PreparedCommand<'a, Self, ()>

Loads a module from a dynamic library at runtime.

fn module_unload(self, name: impl Args) -> PreparedCommand<'a, Self, ()>

Unloads a module.

fn replicaof(self, options: ReplicaOfOptions) -> PreparedCommand<'a, Self, ()>

where Self: Sized,

This command can change the replication settings of a replica on the fly.

fn role(self) -> PreparedCommand<'a, Self, RoleResult>

where Self: Sized,

Provide information on the role of a Redis instance in the context of replication, by returning if the instance is currently a master, slave, or sentinel.

fn save(self) -> PreparedCommand<'a, Self, ()>

where Self: Sized,

This command performs a synchronous save of the dataset producing a point in time snapshot of all the data inside the Redis instance, in the form of an RDB file.

fn shutdown(self, options: ShutdownOptions) -> PreparedCommand<'a, Self, ()>

where Self: Sized,

Shutdown the server

fn slowlog_get( self, options: SlowLogOptions, ) -> PreparedCommand<'a, Self, Vec<SlowLogEntry>>

where Self: Sized,

This command returns entries from the slow log in chronological order.

fn slowlog_help(self) -> PreparedCommand<'a, Self, Vec<String>>

where Self: Sized,

The command returns a helpful text describing the different SLOWLOG subcommands.

fn slowlog_len(self) -> PreparedCommand<'a, Self, usize>

where Self: Sized,

This command returns the current number of entries in the slow log.

fn slowlog_reset(self) -> PreparedCommand<'a, Self, ()>

where Self: Sized,

This command resets the slow log, clearing all entries in it.

fn swapdb(self, index1: usize, index2: usize) -> PreparedCommand<'a, Self, ()>

where Self: Sized,

This command swaps two Redis databases, so that immediately all the clients connected to a given database will see the data of the other database, and the other way around.

fn time(self) -> PreparedCommand<'a, Self, (u32, u32)>

where Self: Sized,

The TIME command returns the current server time as a two items lists: a Unix timestamp and the amount of microseconds already elapsed in the current second.

impl<'a> SetCommands<'a> for &'a Client

fn sadd( self, key: impl Args, members: impl Args, ) -> PreparedCommand<'a, Self, usize>

Add the specified members to the set stored at key.

fn scard(self, key: impl Args) -> PreparedCommand<'a, Self, usize>

Returns the set cardinality (number of elements) of the set stored at key.

fn sdiff<R: Response>(self, keys: impl Args) -> PreparedCommand<'a, Self, R>

Returns the members of the set resulting from the difference between the first set and all the successive sets.

fn sdiffstore( self, destination: impl Args, keys: impl Args, ) -> PreparedCommand<'a, Self, usize>

This command is equal to sdiff, but instead of returning the resulting set, it is stored in destination.

fn sinter<R: Response>(self, keys: impl Args) -> PreparedCommand<'a, Self, R>

Returns the members of the set resulting from the intersection of all the given sets.

fn sintercard( self, keys: impl Args, limit: usize, ) -> PreparedCommand<'a, Self, usize>

This command is similar to sinter, but instead of returning the result set, it returns just the cardinality of the result.

fn sinterstore( self, destination: impl Args, keys: impl Args, ) -> PreparedCommand<'a, Self, usize>

This command is equal to sinter, but instead of returning the resulting set, it is stored in destination.

fn sismember( self, key: impl Args, member: impl Args, ) -> PreparedCommand<'a, Self, bool>

Returns if member is a member of the set stored at key.

fn smembers<R: Response>(self, key: impl Args) -> PreparedCommand<'a, Self, R>

Returns all the members of the set value stored at key.

fn smismember<R: Response>( self, key: impl Args, members: impl Args, ) -> PreparedCommand<'a, Self, R>

Returns whether each member is a member of the set stored at key.

fn smove( self, source: impl Args, destination: impl Args, member: impl Args, ) -> PreparedCommand<'a, Self, bool>

Move member from the set at source to the set at destination.

fn spop<R: Response>( self, key: impl Args, count: usize, ) -> PreparedCommand<'a, Self, R>

Removes and returns one or more random members from the set value store at key.

fn srandmember<R: Response>( self, key: impl Args, count: usize, ) -> PreparedCommand<'a, Self, R>

Removes and returns one or more random members from the set value store at key.

fn srem( self, key: impl Args, members: impl Args, ) -> PreparedCommand<'a, Self, usize>

Remove the specified members from the set stored at key.

fn sscan<R: Response + DeserializeOwned>( self, key: impl Args, cursor: u64, options: SScanOptions, ) -> PreparedCommand<'a, Self, (u64, R)>

Iterates elements of Sets types.

fn sunion<R: Response>(self, keys: impl Args) -> PreparedCommand<'a, Self, R>

Returns the members of the set resulting from the union of all the given sets.

fn sunionstore( self, destination: impl Args, keys: impl Args, ) -> PreparedCommand<'a, Self, usize>

This command is equal to sunion, but instead of returning the resulting set, it is stored in destination.

impl<'a> SortedSetCommands<'a> for &'a Client

fn zadd( self, key: impl Args, items: impl Args, options: ZAddOptions, ) -> PreparedCommand<'a, Self, usize>

Adds all the specified members with the specified scores to the sorted set stored at key.

fn zadd_incr( self, key: impl Args, condition: ZAddCondition, comparison: ZAddComparison, change: bool, score: f64, member: impl Args, ) -> PreparedCommand<'a, Self, Option<f64>>

In this mode ZADD acts like ZINCRBY. Only one score-element pair can be specified in this mode.

fn zcard(self, key: impl Args) -> PreparedCommand<'a, Self, usize>

Returns the sorted set cardinality (number of elements) of the sorted set stored at key.

fn zcount( self, key: impl Args, min: impl Args, max: impl Args, ) -> PreparedCommand<'a, Self, usize>

Returns the number of elements in the sorted set at key with a score between min and max.

fn zdiff<R: Response>(self, keys: impl Args) -> PreparedCommand<'a, Self, R>

This command is similar to zdiffstore, but instead of storing the resulting sorted set, it is returned to the client.

fn zdiff_with_scores<R: Response>( self, keys: impl Args, ) -> PreparedCommand<'a, Self, R>

This command is similar to zdiffstore, but instead of storing the resulting sorted set, it is returned to the client.

fn zdiffstore( self, destination: impl Args, keys: impl Args, ) -> PreparedCommand<'a, Self, usize>

Computes the difference between the first and all successive input sorted sets and stores the result in destination.

fn zincrby( self, key: impl Args, increment: f64, member: impl Args, ) -> PreparedCommand<'a, Self, f64>

Increments the score of member in the sorted set stored at key by increment.

fn zinter<R: Response>( self, keys: impl Args, weights: Option<impl Args>, aggregate: ZAggregate, ) -> PreparedCommand<'a, Self, R>

This command is similar to zinterstore, but instead of storing the resulting sorted set, it is returned to the client.

fn zinter_with_scores<R: Response>( self, keys: impl Args, weights: Option<impl Args>, aggregate: ZAggregate, ) -> PreparedCommand<'a, Self, R>

This command is similar to zinterstore, but instead of storing the resulting sorted set, it is returned to the client.

fn zintercard( self, keys: impl Args, limit: usize, ) -> PreparedCommand<'a, Self, usize>

This command is similar to zinter, but instead of returning the result set, it returns just the cardinality of the result.

fn zinterstore( self, destination: impl Args, keys: impl Args, weights: Option<impl Args>, aggregate: ZAggregate, ) -> PreparedCommand<'a, Self, usize>

Computes the intersection of numkeys sorted sets given by the specified keys, and stores the result in destination.

fn zlexcount( self, key: impl Args, min: impl Args, max: impl Args, ) -> PreparedCommand<'a, Self, usize>

When all the elements in a sorted set are inserted with the same score, in order to force lexicographical ordering, this command returns the number of elements in the sorted set at key with a value between min and max.

fn zmpop<R: Response + DeserializeOwned>( self, keys: impl Args, where_: ZWhere, count: usize, ) -> PreparedCommand<'a, Self, Option<ZMPopResult<R>>>

Pops one or more elements, that are member-score pairs, from the first non-empty sorted set in the provided list of key names.

fn zmscore<R: Response>( self, key: impl Args, members: impl Args, ) -> PreparedCommand<'a, Self, R>

Returns the scores associated with the specified members in the sorted set stored at key.

fn zpopmax<R: Response>( self, key: impl Args, count: usize, ) -> PreparedCommand<'a, Self, R>

Removes and returns up to count members with the highest scores in the sorted set stored at key.

fn zpopmin<R: Response>( self, key: impl Args, count: usize, ) -> PreparedCommand<'a, Self, R>

Removes and returns up to count members with the lowest scores in the sorted set stored at key.

fn zrandmember<R: Response>( self, key: impl Args, ) -> PreparedCommand<'a, Self, R>

Return a random element from the sorted set value stored at key.

fn zrandmembers<R: Response>( self, key: impl Args, count: isize, ) -> PreparedCommand<'a, Self, R>

Return random elements from the sorted set value stored at key.

fn zrandmembers_with_scores<R: Response>( self, key: impl Args, count: isize, ) -> PreparedCommand<'a, Self, R>

Return random elements with their scores from the sorted set value stored at key.

fn zrange<R: Response>( self, key: impl Args, start: impl Args, stop: impl Args, options: ZRangeOptions, ) -> PreparedCommand<'a, Self, R>

Returns the specified range of elements in the sorted set stored at key.

fn zrange_with_scores<R: Response>( self, key: impl Args, start: impl Args, stop: impl Args, options: ZRangeOptions, ) -> PreparedCommand<'a, Self, R>

Returns the specified range of elements in the sorted set stored at key.

fn zrangestore( self, dst: impl Args, src: impl Args, start: impl Args, stop: impl Args, options: ZRangeOptions, ) -> PreparedCommand<'a, Self, usize>

This command is like zrange, but stores the result in the dst destination key.

fn zrank( self, key: impl Args, member: impl Args, ) -> PreparedCommand<'a, Self, Option<usize>>

Returns the rank of member in the sorted set stored at key, with the scores ordered from low to high.

fn zrank_with_score( self, key: impl Args, member: impl Args, ) -> PreparedCommand<'a, Self, Option<(usize, f64)>>

Returns the rank of member in the sorted set stored at key, with the scores ordered from low to high.

fn zrem( self, key: impl Args, members: impl Args, ) -> PreparedCommand<'a, Self, usize>

Removes the specified members from the sorted set stored at key.

fn zremrangebylex( self, key: impl Args, start: impl Args, stop: impl Args, ) -> PreparedCommand<'a, Self, usize>

When all the elements in a sorted set are inserted with the same score, in order to force lexicographical ordering, this command removes all elements in the sorted set stored at key between the lexicographical range specified by min and max.

fn zremrangebyrank( self, key: impl Args, start: isize, stop: isize, ) -> PreparedCommand<'a, Self, usize>

Removes all elements in the sorted set stored at key with rank between start and stop.

fn zremrangebyscore( self, key: impl Args, start: impl Args, stop: impl Args, ) -> PreparedCommand<'a, Self, usize>

Removes all elements in the sorted set stored at key with a score between min and max (inclusive).

fn zrevrank( self, key: impl Args, member: impl Args, ) -> PreparedCommand<'a, Self, Option<usize>>

Returns the rank of member in the sorted set stored at key, with the scores ordered from high to low.

fn zrevrank_with_score( self, key: impl Args, member: impl Args, ) -> PreparedCommand<'a, Self, Option<(usize, f64)>>

Returns the rank of member in the sorted set stored at key, with the scores ordered from high to low.

fn zscan<R: Response + DeserializeOwned>( self, key: impl Args, cursor: usize, options: ZScanOptions, ) -> PreparedCommand<'a, Self, ZScanResult<R>>

Iterates elements of Sorted Set types and their associated scores.

fn zscore( self, key: impl Args, member: impl Args, ) -> PreparedCommand<'a, Self, Option<f64>>

Returns the score of member in the sorted set at key.

fn zunion<R: Response>( self, keys: impl Args, weights: Option<impl Args>, aggregate: ZAggregate, ) -> PreparedCommand<'a, Self, R>

This command is similar to zunionstore, but instead of storing the resulting sorted set, it is returned to the client.

fn zunion_with_scores<R: Response>( self, keys: impl Args, weights: Option<impl Args>, aggregate: ZAggregate, ) -> PreparedCommand<'a, Self, R>

This command is similar to zunionstore, but instead of storing the resulting sorted set, it is returned to the client.

fn zunionstore( self, destination: impl Args, keys: impl Args, weights: Option<impl Args>, aggregate: ZAggregate, ) -> PreparedCommand<'a, Self, usize>

Computes the unionsection of numkeys sorted sets given by the specified keys, and stores the result in destination.

impl<'a> StreamCommands<'a> for &'a Client

fn xack( self, key: impl Args, group: impl Args, ids: impl Args, ) -> PreparedCommand<'a, Self, usize>

The XACK command removes one or multiple messages from the Pending Entries List (PEL) of a stream consumer group

fn xadd<R: Response>( self, key: impl Args, stream_id: impl Args, items: impl Args, options: XAddOptions, ) -> PreparedCommand<'a, Self, R>

Appends the specified stream entry to the stream at the specified key.

fn xautoclaim<R: Response + DeserializeOwned>( self, key: impl Args, group: impl Args, consumer: impl Args, min_idle_time: u64, start: impl Args, options: XAutoClaimOptions, ) -> PreparedCommand<'a, Self, XAutoClaimResult<R>>

This command transfers ownership of pending stream entries that match the specified criteria.

fn xclaim<R: Response>( self, key: impl Args, group: impl Args, consumer: impl Args, min_idle_time: u64, ids: impl Args, options: XClaimOptions, ) -> PreparedCommand<'a, Self, R>

In the context of a stream consumer group, this command changes the ownership of a pending message, so that the new owner is the consumer specified as the command argument.

fn xdel( self, key: impl Args, ids: impl Args, ) -> PreparedCommand<'a, Self, usize>

Removes the specified entries from a stream, and returns the number of entries deleted.

fn xgroup_create( self, key: impl Args, groupname: impl Args, id: impl Args, options: XGroupCreateOptions, ) -> PreparedCommand<'a, Self, bool>

This command creates a new consumer group uniquely identified by groupname for the stream stored at key.

fn xgroup_createconsumer( self, key: impl Args, groupname: impl Args, consumername: impl Args, ) -> PreparedCommand<'a, Self, bool>

Create a consumer named consumername in the consumer group groupname`` of the stream that's stored at key.

fn xgroup_delconsumer( self, key: impl Args, groupname: impl Args, consumername: impl Args, ) -> PreparedCommand<'a, Self, usize>

The XGROUP DELCONSUMER command deletes a consumer from the consumer group.

fn xgroup_destroy( self, key: impl Args, groupname: impl Args, ) -> PreparedCommand<'a, Self, bool>

The XGROUP DESTROY command completely destroys a consumer group.

fn xgroup_help(self) -> PreparedCommand<'a, Self, Vec<String>>

where Self: Sized,

The command returns a helpful text describing the different XGROUP subcommands.

fn xgroup_setid( self, key: impl Args, groupname: impl Args, id: impl Args, entries_read: Option<usize>, ) -> PreparedCommand<'a, Self, ()>

Set the last delivered ID for a consumer group.

fn xinfo_consumers( self, key: impl Args, groupname: impl Args, ) -> PreparedCommand<'a, Self, Vec<XConsumerInfo>>

This command returns the list of consumers that belong to the groupname consumer group of the stream stored at key.

fn xinfo_groups( self, key: impl Args, ) -> PreparedCommand<'a, Self, Vec<XGroupInfo>>

This command returns the list of consumers that belong to the groupname consumer group of the stream stored at key.

fn xinfo_help(self) -> PreparedCommand<'a, Self, Vec<String>>

where Self: Sized,

The command returns a helpful text describing the different XINFO subcommands.

fn xinfo_stream( self, key: impl Args, options: XInfoStreamOptions, ) -> PreparedCommand<'a, Self, XStreamInfo>

This command returns information about the stream stored at key.

fn xlen(self, key: impl Args) -> PreparedCommand<'a, Self, usize>

Returns the number of entries inside a stream.

fn xpending( self, key: impl Args, group: impl Args, ) -> PreparedCommand<'a, Self, XPendingResult>

The XPENDING command is the interface to inspect the list of pending messages.

fn xpending_with_options<R: Response>( self, key: impl Args, group: impl Args, options: XPendingOptions, ) -> PreparedCommand<'a, Self, R>

The XPENDING command is the interface to inspect the list of pending messages.

fn xrange<R: Response>( self, key: impl Args, start: impl Args, end: impl Args, count: Option<usize>, ) -> PreparedCommand<'a, Self, R>

The command returns the stream entries matching a given range of IDs.

fn xread<R: Response>( self, options: XReadOptions, keys: impl Args, ids: impl Args, ) -> PreparedCommand<'a, Self, R>

Read data from one or multiple streams, only returning entries with an ID greater than the last received ID reported by the caller.

fn xreadgroup<R: Response>( self, group: impl Args, consumer: impl Args, options: XReadGroupOptions, keys: impl Args, ids: impl Args, ) -> PreparedCommand<'a, Self, R>

The XREADGROUP command is a special version of the xread command with support for consumer groups.

fn xrevrange<R: Response>( self, key: impl Args, end: impl Args, start: impl Args, count: Option<usize>, ) -> PreparedCommand<'a, Self, R>

This command is exactly like xrange, but with the notable difference of returning the entries in reverse order, and also taking the start-end range in reverse order

fn xtrim( self, key: impl Args, options: XTrimOptions, ) -> PreparedCommand<'a, Self, usize>

XTRIM trims the stream by evicting older entries (entries with lower IDs) if needed.

impl<'a> StringCommands<'a> for &'a Client

fn append( self, key: impl Args, value: impl Args, ) -> PreparedCommand<'a, Self, usize>

If key already exists and is a string, this command appends the value at the end of the string. If key does not exist it is created and set as an empty string, so APPEND will be similar to SET in this special case.

fn decr(self, key: impl Args) -> PreparedCommand<'a, Self, i64>

Decrements the number stored at key by one.

fn decrby( self, key: impl Args, decrement: i64, ) -> PreparedCommand<'a, Self, i64>

Decrements the number stored at key by one.

fn get<R: Response>(self, key: impl Args) -> PreparedCommand<'a, Self, R>

Get the value of key.

fn getdel<R: Response>(self, key: impl Args) -> PreparedCommand<'a, Self, R>

Get the value of key and delete the key.

fn getex<R: Response>( self, key: impl Args, options: GetExOptions, ) -> PreparedCommand<'a, Self, R>

Get the value of key and optionally set its expiration. GETEX is similar to GET, but is a write command with additional options.

fn getrange<R: Response>( self, key: impl Args, start: isize, end: isize, ) -> PreparedCommand<'a, Self, R>

Returns the substring of the string value stored at key, determined by the offsets start and end (both are inclusive).

fn getset<R: Response>( self, key: impl Args, value: impl Args, ) -> PreparedCommand<'a, Self, R>

Atomically sets key to value and returns the old value stored at key. Returns an error when key exists but does not hold a string value. Any previous time to live associated with the key is discarded on successful SET operation.

fn incr(self, key: impl Args) -> PreparedCommand<'a, Self, i64>

Increments the number stored at key by one.

fn incrby( self, key: impl Args, increment: i64, ) -> PreparedCommand<'a, Self, i64>

Increments the number stored at key by increment.

fn incrbyfloat( self, key: impl Args, increment: f64, ) -> PreparedCommand<'a, Self, f64>

Increment the string representing a floating point number stored at key by the specified increment. By using a negative increment value, the result is that the value stored at the key is decremented (by the obvious properties of addition). If the key does not exist, it is set to 0 before performing the operation. An error is returned if one of the following conditions occur:

fn lcs<R: Response>( self, key1: impl Args, key2: impl Args, ) -> PreparedCommand<'a, Self, R>

The LCS command implements the longest common subsequence algorithm

fn lcs_len( self, key1: impl Args, key2: impl Args, ) -> PreparedCommand<'a, Self, usize>

The LCS command implements the longest common subsequence algorithm

fn lcs_idx( self, key1: impl Args, key2: impl Args, min_match_len: Option<usize>, with_match_len: bool, ) -> PreparedCommand<'a, Self, LcsResult>

The LCS command implements the longest common subsequence algorithm

fn mget<R: Response>(self, keys: impl Args) -> PreparedCommand<'a, Self, R>

Returns the values of all specified keys.

fn mset(self, items: impl Args) -> PreparedCommand<'a, Self, ()>

Sets the given keys to their respective values.

fn msetnx(self, items: impl Args) -> PreparedCommand<'a, Self, bool>

Sets the given keys to their respective values. MSETNX will not perform any operation at all even if just a single key already exists.

fn psetex( self, key: impl Args, milliseconds: u64, value: impl Args, ) -> PreparedCommand<'a, Self, ()>

Works exactly like setex with the sole difference that the expire time is specified in milliseconds instead of seconds.

fn set(self, key: impl Args, value: impl Args) -> PreparedCommand<'a, Self, ()>

Set key to hold the string value.

fn set_with_options( self, key: impl Args, value: impl Args, condition: SetCondition, expiration: SetExpiration, keep_ttl: bool, ) -> PreparedCommand<'a, Self, bool>

Set key to hold the string value.

fn set_get_with_options<R: Response>( self, key: impl Args, value: impl Args, condition: SetCondition, expiration: SetExpiration, keep_ttl: bool, ) -> PreparedCommand<'a, Self, R>

Set key to hold the string value wit GET option enforced

fn setex( self, key: impl Args, seconds: u64, value: impl Args, ) -> PreparedCommand<'a, Self, ()>

Set key to hold the string value and set key to timeout after a given number of seconds.

fn setnx( self, key: impl Args, value: impl Args, ) -> PreparedCommand<'a, Self, bool>

Set key to hold string value if key does not exist.

fn setrange( self, key: impl Args, offset: usize, value: impl Args, ) -> PreparedCommand<'a, Self, usize>

Overwrites part of the string stored at key, starting at the specified offset, for the entire length of value.

fn strlen(self, key: impl Args) -> PreparedCommand<'a, Self, usize>

Returns the length of the string value stored at key.

fn substr<R: Response>( self, key: impl Args, start: isize, end: isize, ) -> PreparedCommand<'a, Self, R>

Returns the substring of the string value stored at key, determined by the offsets start and end (both are inclusive).

impl<'a> TDigestCommands<'a> for &'a Client

fn tdigest_add( self, key: impl Args, values: impl Args, ) -> PreparedCommand<'a, Self, ()>

where Self: Sized,

Adds one or more observations to a t-digest sketch.

fn tdigest_byrank<R: Response>( self, key: impl Args, ranks: impl Args, ) -> PreparedCommand<'a, Self, R>

where Self: Sized,

Returns, for each input rank, an estimation of the value (floating-point) with that rank.

fn tdigest_byrevrank<R: Response>( self, key: impl Args, ranks: impl Args, ) -> PreparedCommand<'a, Self, R>

where Self: Sized,

Returns, for each input reverse rank, an estimation of the value (floating-point) with that reverse rank.

fn tdigest_cdf<R: Response>( self, key: impl Args, values: impl Args, ) -> PreparedCommand<'a, Self, R>

where Self: Sized,

Returns, for each input reverse rank, an estimation of the value (floating-point) with that reverse rank.

fn tdigest_create( self, key: impl Args, compression: Option<i64>, ) -> PreparedCommand<'a, Self, ()>

where Self: Sized,

Allocates memory and initializes a new t-digest sketch.

fn tdigest_info( self, key: impl Args, ) -> PreparedCommand<'a, Self, TDigestInfoResult>

where Self: Sized,

Returns information and statistics about a t-digest sketch

fn tdigest_max(self, key: impl Args) -> PreparedCommand<'a, Self, f64>

where Self: Sized,

Returns the maximum observation value from a t-digest sketch.

fn tdigest_merge( self, destination: impl Args, sources: impl Args, options: TDigestMergeOptions, ) -> PreparedCommand<'a, Self, ()>

where Self: Sized,

Merges multiple t-digest sketches into a single sketch.

fn tdigest_min(self, key: impl Args) -> PreparedCommand<'a, Self, f64>

where Self: Sized,

Returns the minimum observation value from a t-digest sketch.

fn tdigest_quantile<R: Response>( self, key: impl Args, quantiles: impl Args, ) -> PreparedCommand<'a, Self, R>

where Self: Sized,

Returns, for each input fraction, an estimation of the value (floating point) that is smaller than the given fraction of observations.

fn tdigest_rank<R: Response>( self, key: impl Args, values: impl Args, ) -> PreparedCommand<'a, Self, R>

where Self: Sized,

Returns, for each input value (floating-point), the estimated rank of the value (the number of observations in the sketch that are smaller than the value + half the number of observations that are equal to the value).

fn tdigest_reset(self, key: impl Args) -> PreparedCommand<'a, Self, ()>

where Self: Sized,

Resets a t-digest sketch: empty the sketch and re-initializes it.

fn tdigest_revrank<R: Response>( self, key: impl Args, values: impl Args, ) -> PreparedCommand<'a, Self, R>

where Self: Sized,

Returns, for each input value (floating-point), the estimated reverse rank of the value (the number of observations in the sketch that are smaller than the value + half the number of observations that are equal to the value).

fn tdigest_trimmed_mean( self, key: impl Args, low_cut_quantile: f64, high_cut_quantile: f64, ) -> PreparedCommand<'a, Self, f64>

where Self: Sized,

Returns an estimation of the mean value from the sketch, excluding observation values outside the low and high cutoff quantiles.

impl<'a> TimeSeriesCommands<'a> for &'a Client

fn ts_add( self, key: impl Args, timestamp: impl Args, value: f64, options: TsAddOptions, ) -> PreparedCommand<'a, Self, u64>

Append a sample to a time series

fn ts_alter( self, key: impl Args, options: TsCreateOptions, ) -> PreparedCommand<'a, Self, ()>

Update the retention, chunk size, duplicate policy, and labels of an existing time series

fn ts_create( self, key: impl Args, options: TsCreateOptions, ) -> PreparedCommand<'a, Self, ()>

Create a new time series

fn ts_createrule( self, src_key: impl Args, dst_key: impl Args, aggregator: TsAggregationType, bucket_duration: u64, options: TsCreateRuleOptions, ) -> PreparedCommand<'a, Self, ()>

Create a compaction rule

fn ts_decrby( self, key: impl Args, value: f64, options: TsIncrByDecrByOptions, ) -> PreparedCommand<'a, Self, ()>

Decrease the value of the sample with the maximum existing timestamp, or create a new sample with a value equal to the value of the sample with the maximum existing timestamp with a given decrement

fn ts_del( self, key: impl Args, from_timestamp: u64, to_timestamp: u64, ) -> PreparedCommand<'a, Self, usize>

Delete all samples between two timestamps for a given time series

fn ts_deleterule( self, src_key: impl Args, dst_key: impl Args, ) -> PreparedCommand<'a, Self, ()>

Delete a compaction rule

fn ts_get( self, key: impl Args, options: TsGetOptions, ) -> PreparedCommand<'a, Self, Option<(u64, f64)>>

Get the last sample

fn ts_incrby( self, key: impl Args, value: f64, options: TsIncrByDecrByOptions, ) -> PreparedCommand<'a, Self, u64>

Increase the value of the sample with the maximum existing timestamp, or create a new sample with a value equal to the value of the sample with the maximum existing timestamp with a given increment

fn ts_info( self, key: impl Args, debug: bool, ) -> PreparedCommand<'a, Self, TsInfoResult>

Return information and statistics for a time series.

fn ts_madd<R: Response>(self, items: impl Args) -> PreparedCommand<'a, Self, R>

Append new samples to one or more time series

fn ts_mget<R: Response>( self, options: TsMGetOptions, filters: impl Args, ) -> PreparedCommand<'a, Self, R>

Get the last samples matching a specific filter

fn ts_mrange<R: Response>( self, from_timestamp: impl Args, to_timestamp: impl Args, options: TsMRangeOptions, filters: impl Args, groupby_options: TsGroupByOptions, ) -> PreparedCommand<'a, Self, R>

Query a range across multiple time series by filters in forward direction

fn ts_mrevrange<R: Response>( self, from_timestamp: impl Args, to_timestamp: impl Args, options: TsMRangeOptions, filters: impl Args, groupby_options: TsGroupByOptions, ) -> PreparedCommand<'a, Self, R>

Query a range across multiple time series by filters in reverse direction

fn ts_queryindex<R: Response>( self, filters: impl Args, ) -> PreparedCommand<'a, Self, R>

Get all time series keys matching a filter list

fn ts_range<R: Response>( self, key: impl Args, from_timestamp: impl Args, to_timestamp: impl Args, options: TsRangeOptions, ) -> PreparedCommand<'a, Self, R>

Query a range in forward direction

fn ts_revrange<R: Response>( self, key: impl Args, from_timestamp: impl Args, to_timestamp: impl Args, options: TsRangeOptions, ) -> PreparedCommand<'a, Self, R>

Query a range in reverse direction

impl<'a> TopKCommands<'a> for &'a Client

fn topk_add<R: Response>( self, key: impl Args, items: impl Args, ) -> PreparedCommand<'a, Self, R>

Adds an item to the data structure.

fn topk_incrby<R: Response>( self, key: impl Args, items: impl Args, ) -> PreparedCommand<'a, Self, R>

Increase the score of an item in the data structure by increment.

fn topk_info(self, key: impl Args) -> PreparedCommand<'a, Self, TopKInfoResult>

Returns number of required items (k), width, depth and decay values.

fn topk_list<R: Response>(self, key: impl Args) -> PreparedCommand<'a, Self, R>

Return full list of items in Top K list.

fn topk_list_with_count<R: Response + DeserializeOwned>( self, key: impl Args, ) -> PreparedCommand<'a, Self, TopKListWithCountResult<R>>

Return full list of items in Top K list.

fn topk_query<R: Response>( self, key: impl Args, items: impl Args, ) -> PreparedCommand<'a, Self, R>

Return full list of items in Top K list.

fn topk_reserve( self, key: impl Args, topk: usize, width_depth_decay: Option<(usize, usize, f64)>, ) -> PreparedCommand<'a, Self, ()>

Initializes a TopK with specified parameters.

impl<'a> TransactionCommands<'a> for &'a Client

fn watch(self, keys: impl Args) -> PreparedCommand<'a, Self, ()>

Marks the given keys to be watched for conditional execution of a transaction.

fn unwatch(self) -> PreparedCommand<'a, Self, ()>

Flushes all the previously watched keys for a transaction.

impl<'a> VectorSetCommands<'a> for &'a Client

fn vadd( self, key: impl Args, reduce_dim: Option<usize>, values: &[f32], element: impl Args, options: VAddOptions, ) -> PreparedCommand<'a, Self, bool>

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

fn vcard(self, key: impl Args) -> PreparedCommand<'a, Self, usize>

Return the number of elements in the specified vector set.

fn vdim(self, key: impl Args) -> PreparedCommand<'a, Self, usize>

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

fn vemb<R: Response>( self, key: impl Args, element: impl Args, ) -> PreparedCommand<'a, Self, R>

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

fn vgetattr<R: Response>( self, key: impl Args, element: impl Args, ) -> PreparedCommand<'a, Self, R>

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

fn vinfo(self, key: impl Args) -> PreparedCommand<'a, Self, VInfoResult>

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

fn vlinks<R: Response>( self, key: impl Args, element: impl Args, ) -> PreparedCommand<'a, Self, R>

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

fn vlinks_with_score<R: Response>( self, key: impl Args, element: impl Args, ) -> PreparedCommand<'a, Self, R>

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

fn vrandmember<R: Response>( self, key: impl Args, count: isize, ) -> PreparedCommand<'a, Self, R>

Return one or more random elements from a vector set.

fn vrem( self, key: impl Args, element: impl Args, ) -> PreparedCommand<'a, Self, bool>

Remove an element from a vector set.

fn vsetattr( self, key: impl Args, element: impl Args, json: impl Args, ) -> PreparedCommand<'a, Self, bool>

Associate a JSON object with an element in a vector set.

fn vsim<R: Response>( self, key: impl Args, vector_or_element: VectorOrElement<'_>, options: VSimOptions, ) -> PreparedCommand<'a, Self, R>

Return elements similar to a given vector or element. Use this command to perform approximate or exact similarity searches within a vector set.

fn vsim_with_scores<R: Response>( self, key: impl Args, vector_or_element: VectorOrElement<'_>, options: VSimOptions, ) -> PreparedCommand<'a, Self, R>

Return elements similar to a given vector or element. Use this command to perform approximate or exact similarity searches within a vector set.