Struct redis_driver::Database

pub struct Database { /* private fields */ }

Implementations

impl Database

Set of Redis commands related to a specific database

pub fn get_database(&self) -> usize

The numeric identifier of this database

pub fn send<'a>(
    &'a self,
    command: Command
) -> impl Future<Output = Result<Value>> + 'a

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

• name - Command name in uppercase.
• args - Command arguments which can be provided as arrays (up to 4 elements) or vectors of BulkString.

Example

let connection = ConnectionMultiplexer::connect("127.0.0.1:6379").await?;
let database = connection.get_default_database();

let values: Vec<String> = database
    .send(cmd("MGET").arg("key1").arg("key2").arg("key3").arg("key4"))
    .await?
    .into()?;

Trait Implementations

impl Clone for Database

fn clone(&self) -> Database

Returns a copy of the value.

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

Performs copy-assignment from source.

impl GenericCommands for Database

fn del<'life0, 'async_trait, K>(
    &'life0 self,
    keys: K
) -> Pin<Box<dyn Future<Output = Result<usize>> + Send + 'async_trait>> where
    K: IntoArgs + Send,
    K: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

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

impl ListCommands for Database

fn lpush<'life0, 'async_trait, K, E>(
    &'life0 self,
    key: K,
    elements: E
) -> Pin<Box<dyn Future<Output = Result<i64>> + Send + 'async_trait>> where
    K: Into<BulkString> + Send,
    E: IntoArgs + Send,
    K: 'async_trait,
    E: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

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

fn lpop<'life0, 'async_trait, K, E>(
    &'life0 self,
    key: K,
    count: usize
) -> Pin<Box<dyn Future<Output = Result<Vec<E>>> + Send + 'async_trait>> where
    K: Into<BulkString> + Send,
    E: FromValue,
    K: 'async_trait,
    E: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

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

impl StringCommands for Database

fn append<'life0, 'async_trait, K, V>(
    &'life0 self,
    key: K,
    value: V
) -> Pin<Box<dyn Future<Output = Result<usize>> + Send + 'async_trait>> where
    K: Into<BulkString> + Send,
    V: Into<BulkString> + Send,
    K: 'async_trait,
    V: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

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<'life0, 'async_trait, K>(
    &'life0 self,
    key: K
) -> Pin<Box<dyn Future<Output = Result<i64>> + Send + 'async_trait>> where
    K: Into<BulkString> + Send,
    K: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

Decrements the number stored at key by one.

fn decrby<'life0, 'async_trait, K>(
    &'life0 self,
    key: K,
    decrement: i64
) -> Pin<Box<dyn Future<Output = Result<i64>> + Send + 'async_trait>> where
    K: Into<BulkString> + Send,
    K: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

Decrements the number stored at key by one.

fn get<'life0, 'async_trait, K, V>(
    &'life0 self,
    key: K
) -> Pin<Box<dyn Future<Output = Result<V>> + Send + 'async_trait>> where
    K: Into<BulkString> + Send,
    V: FromValue,
    K: 'async_trait,
    V: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

Get the value of key.

fn getdel<'life0, 'async_trait, K, V>(
    &'life0 self,
    key: K
) -> Pin<Box<dyn Future<Output = Result<V>> + Send + 'async_trait>> where
    K: Into<BulkString> + Send,
    V: FromValue,
    K: 'async_trait,
    V: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

Get the value of key and delete the key.

fn getex<K>(&self, key: K) -> GetEx<'_> where
    K: Into<BulkString> + Send, 

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<'life0, 'async_trait, K, V>(
    &'life0 self,
    key: K,
    start: usize,
    end: isize
) -> Pin<Box<dyn Future<Output = Result<V>> + Send + 'async_trait>> where
    K: Into<BulkString> + Send,
    V: FromValue,
    K: 'async_trait,
    V: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

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

fn getset<'life0, 'async_trait, K, V, R>(
    &'life0 self,
    key: K,
    value: V
) -> Pin<Box<dyn Future<Output = Result<R>> + Send + 'async_trait>> where
    K: Into<BulkString> + Send,
    V: Into<BulkString> + Send,
    R: FromValue,
    K: 'async_trait,
    V: 'async_trait,
    R: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

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<'life0, 'async_trait, K>(
    &'life0 self,
    key: K
) -> Pin<Box<dyn Future<Output = Result<i64>> + Send + 'async_trait>> where
    K: Into<BulkString> + Send,
    K: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

Increments the number stored at key by one.

fn incrby<'life0, 'async_trait, K>(
    &'life0 self,
    key: K,
    increment: i64
) -> Pin<Box<dyn Future<Output = Result<i64>> + Send + 'async_trait>> where
    K: Into<BulkString> + Send,
    K: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

Increments the number stored at key by increment.

fn incrbyfloat<'life0, 'async_trait, K>(
    &'life0 self,
    key: K,
    increment: f64
) -> Pin<Box<dyn Future<Output = Result<f64>> + Send + 'async_trait>> where
    K: Into<BulkString> + Send,
    K: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

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<K>(&self, key1: K, key2: K) -> Lcs<'_> where
    K: Into<BulkString> + Send, 

The LCS command implements the longest common subsequence algorithm

fn mget<'a, 'async_trait, K, V>(
    &'a self,
    keys: K
) -> Pin<Box<dyn Future<Output = Result<Vec<Option<V>>>> + Send + 'async_trait>> where
    K: IntoArgs + Send + Sync,
    V: FromValue,
    'a: 'async_trait,
    K: 'async_trait,
    V: 'async_trait,
    Self: 'async_trait, 

Returns the values of all specified keys.

fn mset<'a, 'async_trait, K, V>(
    &'a self,
    items: &'a [(K, V)]
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where
    K: Into<BulkString> + Send + Sync + Copy,
    V: Into<BulkString> + Send + Sync + Copy,
    'a: 'async_trait,
    K: 'async_trait,
    V: 'async_trait,
    Self: 'async_trait, 

Sets the given keys to their respective values.

fn msetnx<'a, 'async_trait, K, V>(
    &'a self,
    items: &'a [(K, V)]
) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>> where
    K: Into<BulkString> + Send + Sync + Copy,
    V: Into<BulkString> + Send + Sync + Copy,
    'a: 'async_trait,
    K: 'async_trait,
    V: 'async_trait,
    Self: 'async_trait, 

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<'life0, 'async_trait, K, V>(
    &'life0 self,
    key: K,
    milliseconds: u64,
    value: V
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where
    K: Into<BulkString> + Send,
    V: Into<BulkString> + Send,
    K: 'async_trait,
    V: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

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

fn set<'life0, 'async_trait, K, V>(
    &'life0 self,
    key: K,
    value: V
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where
    K: Into<BulkString> + Send,
    V: Into<BulkString> + Send,
    K: 'async_trait,
    V: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

Set key to hold the string value.

fn set_with_options<K, V>(&self, key: K, value: V) -> SetWithOptions<'_> where
    K: Into<BulkString> + Send,
    V: Into<BulkString> + Send, 

Set key to hold the string value.

fn setex<'life0, 'async_trait, K, V>(
    &'life0 self,
    key: K,
    seconds: u64,
    value: V
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where
    K: Into<BulkString> + Send,
    V: Into<BulkString> + Send,
    K: 'async_trait,
    V: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

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

fn setnx<'life0, 'async_trait, K, V>(
    &'life0 self,
    key: K,
    value: V
) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>> where
    K: Into<BulkString> + Send,
    V: Into<BulkString> + Send,
    K: 'async_trait,
    V: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

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

fn setrange<'life0, 'async_trait, K, V>(
    &'life0 self,
    key: K,
    offset: usize,
    value: V
) -> Pin<Box<dyn Future<Output = Result<usize>> + Send + 'async_trait>> where
    K: Into<BulkString> + Send,
    V: Into<BulkString> + Send,
    K: 'async_trait,
    V: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

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

fn strlen<'life0, 'async_trait, K>(
    &'life0 self,
    key: K
) -> Pin<Box<dyn Future<Output = Result<usize>> + Send + 'async_trait>> where
    K: Into<BulkString> + Send,
    K: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns the length of the string value stored at key.