Struct RedisStorage 

pub struct RedisStorage { /* private fields */ }

Async Redis helper for strings, hashes, lists, sets, and sorted sets.

All operations open a multiplexed connection and return Redis errors to the caller.

Implementations

impl RedisStorage

pub fn new(url: &str) -> RedisResult<Self>

Connects to the Redis server at url.

pub fn from_env() -> RedisResult<Self>

Connects using REDIS_URL (falling back to REDIS_URI, then localhost).

pub fn client(&self) -> &Client

Returns the underlying Redis client.

pub async fn get_value(&self, key: &str) -> RedisResult<Option<String>>

Gets the string value for key, or None when absent.

pub async fn set_value(&self, key: &str, value: &str) -> RedisResult<()>

Sets the string value for key.

pub async fn set_value_with_expiration( &self, key: &str, value: &str, seconds: u64, ) -> RedisResult<()>

Sets the string value for key with a TTL of seconds.

pub async fn set_value_if_absent( &self, key: &str, value: &str, ) -> RedisResult<bool>

Sets key only when absent; returns true when the key was set.

pub async fn delete_key(&self, key: &str) -> RedisResult<i64>

Deletes key and returns the number of keys removed.

pub async fn unlink_key(&self, key: &str) -> RedisResult<i64>

Lazily frees key with UNLINK and returns the number of keys removed.

pub async fn delete_keys(&self, keys: &[String]) -> RedisResult<i64>

Deletes all given keys and returns the number removed; returns 0 for an empty list.

pub async fn key_exists(&self, key: &str) -> RedisResult<bool>

Returns true when key exists.

pub async fn increment_value(&self, key: &str) -> RedisResult<i64>

Increments the integer at key by 1 and returns the new value.

pub async fn increment_value_by( &self, key: &str, delta: i64, ) -> RedisResult<i64>

Increments the integer at key by delta and returns the new value.

pub async fn decrement_value(&self, key: &str) -> RedisResult<i64>

Decrements the integer at key by 1 and returns the new value.

pub async fn decrement_value_by( &self, key: &str, delta: i64, ) -> RedisResult<i64>

Decrements the integer at key by delta and returns the new value.

pub async fn idle_time(&self, key: &str) -> RedisResult<i64>

Returns seconds since key was last accessed (OBJECT IDLETIME).

pub async fn set_expiration(&self, key: &str, seconds: u64) -> RedisResult<bool>

Sets the TTL of key to seconds; returns true when the timeout was set.

pub async fn get_time_to_live(&self, key: &str) -> RedisResult<i64>

Returns the TTL of key in seconds.

pub async fn get_multiple_values( &self, keys: &[String], ) -> RedisResult<Vec<Option<String>>>

Gets the values for several keys at once; missing keys yield None. Empty input returns empty output.

pub async fn set_multiple_values( &self, kv: &HashMap<String, String>, ) -> RedisResult<()>

Sets several key-value pairs at once with MSET; does nothing for empty input.

pub async fn get_hash_value( &self, key: &str, field: &str, ) -> RedisResult<Option<String>>

Gets a hash field value, or None when the key or field is absent.

pub async fn set_hash_value( &self, key: &str, field: &str, value: &str, ) -> RedisResult<()>

Sets a hash field value.

pub async fn delete_hash_field( &self, key: &str, field: &str, ) -> RedisResult<i64>

Deletes a hash field and returns the number of fields removed.

pub async fn set_hash_values( &self, key: &str, field_values: &HashMap<String, String>, ) -> RedisResult<()>

Sets several hash fields at once; does nothing for empty input.

pub async fn set_hash_value_if_absent( &self, key: &str, field: &str, value: &str, ) -> RedisResult<bool>

Sets a hash field only when absent; returns true when the field was set.

pub async fn increment_hash_field( &self, key: &str, field: &str, delta: i64, ) -> RedisResult<i64>

Increments a hash integer field by delta and returns the new value.

pub async fn decrement_hash_field( &self, key: &str, field: &str, delta: i64, ) -> RedisResult<i64>

Decrements a hash integer field by delta and returns the new value.

pub async fn get_all_hash_fields( &self, key: &str, ) -> RedisResult<HashMap<String, String>>

Returns all fields and values of a hash.

pub async fn get_hash_keys(&self, key: &str) -> RedisResult<Vec<String>>

Returns all field names of a hash.

pub async fn get_hash_values(&self, key: &str) -> RedisResult<Vec<String>>

Returns all values of a hash.

pub async fn hash_field_exists( &self, key: &str, field: &str, ) -> RedisResult<bool>

Returns true when a hash field exists.

pub async fn push_to_list_start( &self, key: &str, value: &str, ) -> RedisResult<i64>

Prepends value to the list at key and returns the new length.

pub async fn push_to_list_end(&self, key: &str, value: &str) -> RedisResult<i64>

Appends value to the list at key and returns the new length.

pub async fn pop_from_list_start( &self, key: &str, ) -> RedisResult<Option<String>>

Removes and returns the first element of the list, or None when empty.

pub async fn pop_from_list_end(&self, key: &str) -> RedisResult<Option<String>>

Removes and returns the last element of the list, or None when empty.

pub async fn get_list_length(&self, key: &str) -> RedisResult<i64>

Returns the length of the list at key.

pub async fn get_list_range( &self, key: &str, start: i64, stop: i64, ) -> RedisResult<Vec<String>>

Returns list elements from start to stop inclusive.

pub async fn add_to_set(&self, key: &str, member: &str) -> RedisResult<i64>

Adds member to the set and returns the number of members added.

pub async fn remove_from_set(&self, key: &str, member: &str) -> RedisResult<i64>

Removes member from the set and returns the number of members removed.

pub async fn get_set_members(&self, key: &str) -> RedisResult<Vec<String>>

Returns all members of the set.

pub async fn is_set_member(&self, key: &str, member: &str) -> RedisResult<bool>

Returns true when member belongs to the set.

pub async fn get_set_size(&self, key: &str) -> RedisResult<i64>

Returns the number of members in the set.

pub async fn add_to_sorted_set( &self, key: &str, score: f64, member: &str, ) -> RedisResult<i64>

Adds member with score to the sorted set and returns the number of members added.

pub async fn get_sorted_set_range( &self, key: &str, start: i64, stop: i64, ) -> RedisResult<Vec<String>>

Returns sorted-set members from start to stop inclusive, by ascending score.

pub async fn remove_from_sorted_set( &self, key: &str, member: &str, ) -> RedisResult<i64>

Removes member from the sorted set and returns the number of members removed.

pub async fn get_sorted_set_score( &self, key: &str, member: &str, ) -> RedisResult<Option<f64>>

Returns the score of member, or None when absent.

pub async fn get_sorted_set_size(&self, key: &str) -> RedisResult<i64>

Returns the number of members in the sorted set.

pub async fn remove_expiration(&self, key: &str) -> RedisResult<bool>

Removes the expiration from key; returns true when a timeout was removed.

pub async fn rename_key(&self, old_key: &str, new_key: &str) -> RedisResult<()>

Renames old_key to new_key, overwriting any existing destination.

pub async fn scan_keys( &self, pattern: &str, count: usize, ) -> RedisResult<Vec<String>>

Collects keys matching pattern with a non-blocking incremental scan.

count is the COUNT hint for each scan round.

pub async fn scan_keys_default(&self, pattern: &str) -> RedisResult<Vec<String>>

Scans keys matching pattern with a count hint of 250.

pub async fn find_keys(&self, pattern: &str) -> RedisResult<Vec<String>>

👎Deprecated:

Use scan_keys instead to avoid blocking Redis

Deprecated alias for RedisStorage::scan_keys_default; prefer scan_keys to avoid blocking Redis.

Trait Implementations

impl Clone for RedisStorage

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.