Struct actix_storage_redis::RedisBackend

pub struct RedisBackend { /* fields omitted */ }

An implementation of ExpiryStore based on redis using redis-rs async runtime

Example

use actix_storage::Storage;
use actix_storage_redis::{RedisBackend, ConnectionInfo, ConnectionAddr};
use actix_web::{App, HttpServer};

#[actix_web::main]
async fn main() -> std::io::Result<()> {
    const THREADS_NUMBER: usize = 4;
    let store = RedisBackend::connect_default();
    // OR
    let connection_info = ConnectionInfo {
        addr: ConnectionAddr::Tcp("127.0.0.1".to_string(), 1234).into(),
        db: 0,
        username: Some("god".to_string()),
        passwd: Some("bless".to_string()),
    };
    let store = RedisBackend::connect(connection_info).await.expect("Redis connection failed");

    let storage = Storage::build().expiry_store(store).finish();
    let server = HttpServer::new(move || {
        App::new()
            .data(storage.clone())
    });
    server.bind("localhost:5000")?.run().await
}

requires ["actor"] feature

Implementations

impl RedisBackend

pub async fn connect(connection_info: ConnectionInfo) -> RedisResult<Self>

Connect using the provided connection info

pub async fn connect_default() -> RedisResult<Self>

Connect using the default redis port on local machine

Trait Implementations

impl Clone for RedisBackend

fn clone(&self) -> RedisBackend

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Expiry for RedisBackend

fn persist<'life0, 'async_trait>(
    &'life0 self,
    key: Arc<[u8]>
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Remove all expiry requests from a key and make it persistent, the persistenty can be overwriten by calling expire on the key.

fn expiry<'life0, 'async_trait>(
    &'life0 self,
    key: Arc<[u8]>
) -> Pin<Box<dyn Future<Output = Result<Option<Duration>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Gets expiry for a key, returning None means it doesn't have an expiry, if the provider can't return an expiry, it should return an error instead. The result of this function can have some error, but it should be documented.

fn expire<'life0, 'async_trait>(
    &'life0 self,
    key: Arc<[u8]>,
    expire_in: Duration
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Sets an expiry for a key, the key may or may not be removed based on implementation, but it should be guaranteed that it won't appear in get based methods or contains checks after the period specified.

#[must_use]fn extend<'life0, 'async_trait>(
    &'life0 self,
    key: Arc<[u8]>,
    expire_in: Duration
) -> Pin<Box<dyn Future<Output = Result<(), StorageError>> + 'async_trait + Send>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Extend expiry for a key for another duration of time. If the key doesn't have an expiry, it should be equivalent of calling expire.

#[must_use]fn set_called<'life0, 'async_trait>(
    &'life0 self,
    key: Arc<[u8]>
) -> Pin<Box<dyn Future<Output = ()> + 'async_trait + Send>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

A notification that should be implemented if expiry is a different entity that store itself to remove expiry when set is called for a key.

impl ExpiryStore for RedisBackend

fn set_expiring<'life0, 'async_trait>(
    &'life0 self,
    key: Arc<[u8]>,
    value: Arc<[u8]>,
    expire_in: Duration
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Set a key-value for a duration of time, if the key already exists, it should overwrite both the value and the expiry for that key.

#[must_use]fn get_expiring<'life0, 'async_trait>(
    &'life0 self,
    key: Arc<[u8]>
) -> Pin<Box<dyn Future<Output = Result<Option<(Arc<[u8]>, Option<Duration>)>, StorageError>> + 'async_trait + Send>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Get the value and expiry for a key, it is possible to return None if the key doesn't exist, or return None for the expiry if the key is persistent.

impl Store for RedisBackend

fn set<'life0, 'async_trait>(
    &'life0 self,
    key: Arc<[u8]>,
    value: Arc<[u8]>
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Set a key-value pair, if the key already exist, value should be overwritten

fn get<'life0, 'async_trait>(
    &'life0 self,
    key: Arc<[u8]>
) -> Pin<Box<dyn Future<Output = Result<Option<Arc<[u8]>>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Get a value for specified key, it should result in None if the value does not exist

fn delete<'life0, 'async_trait>(
    &'life0 self,
    key: Arc<[u8]>
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Delete the key from storage, if the key doesn't exist, it shouldn't return an error

fn contains_key<'life0, 'async_trait>(
    &'life0 self,
    key: Arc<[u8]>
) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Check if key exist in storage