Struct RedisStorage 

pub struct RedisStorage { /* private fields */ }

Redis存储实现

Implementations

impl RedisStorage

pub async fn new( redis_url: &str, key_prefix: impl Into<String>, ) -> Result<RedisStorage, StorageError>

使用 Redis URL 创建存储

参数

• redis_url - Redis 连接 URL
• key_prefix - 键前缀（例如：sa-token:）

URL 格式

• 无密码：redis://localhost:6379/0
• 有密码：redis://:password@localhost:6379/0
• 复杂密码：redis://:Aq23-hjPwFB3mBDNFp3W1@localhost:6379/0

示例

use sa_token_storage_redis::RedisStorage;

// 无密码
let storage = RedisStorage::new("redis://localhost:6379/0", "sa-token:").await?;

// 有密码
let storage = RedisStorage::new(
    "redis://:Aq23-hjPwFB3mBDNFp3W1@localhost:6379/0",
    "sa-token:"
).await?;

pub async fn from_config( config: RedisConfig, key_prefix: impl Into<String>, ) -> Result<RedisStorage, StorageError>

使用配置结构体创建存储

参数

• config - Redis 配置
• key_prefix - 键前缀（例如：sa-token:）

示例

use sa_token_storage_redis::{RedisStorage, RedisConfig};

let config = RedisConfig {
    host: "localhost".to_string(),
    port: 6379,
    password: Some("Aq23-hjPwFB3mBDNFp3W1".to_string()),
    database: 0,
    pool_size: 10,
};

let storage = RedisStorage::from_config(config, "sa-token:").await?;

pub fn builder() -> RedisStorageBuilder

使用构建器模式创建存储

示例

use sa_token_storage_redis::RedisStorage;

let storage = RedisStorage::builder()
    .host("localhost")
    .port(6379)
    .password("Aq23-hjPwFB3mBDNFp3W1")
    .database(0)
    .key_prefix("sa-token:")
    .build()
    .await?;

pub async fn connect(redis_url: &str) -> Result<RedisStorage, StorageError>

便捷构造：物理前缀默认为空（逻辑键由 SaKeys 提供）

Trait Implementations

impl Clone for RedisStorage

fn clone(&self) -> RedisStorage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RedisStorage

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl SaStorage for RedisStorage

fn get<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Option<String>, StorageError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, RedisStorage: 'async_trait,

Read value by key | 按键读取值

fn set<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, key: &'life1 str, value: &'life2 str, ttl: Option<Duration>, ) -> Pin<Box<dyn Future<Output = Result<(), StorageError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, RedisStorage: 'async_trait,

Write value with optional TTL | 写入值（可选 TTL）

fn delete<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), StorageError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, RedisStorage: 'async_trait,

Delete a key | 删除键

fn exists<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<bool, StorageError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, RedisStorage: 'async_trait,

Whether the key exists | 键是否存在

fn expire<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 str, ttl: Duration, ) -> Pin<Box<dyn Future<Output = Result<(), StorageError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, RedisStorage: 'async_trait,

Update key TTL | 更新键过期时间

fn ttl<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Option<Duration>, StorageError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, RedisStorage: 'async_trait,

Remaining TTL, if any | 剩余过期时间（若有）

fn mget<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, keys: &'life1 [&'life2 str], ) -> Pin<Box<dyn Future<Output = Result<Vec<Option<String>>, StorageError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, RedisStorage: 'async_trait,

批量读：默认逐键 get，具体后端可覆盖为 mget

fn mset<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, items: &'life1 [(&'life2 str, &'life3 str)], ttl: Option<Duration>, ) -> Pin<Box<dyn Future<Output = Result<(), StorageError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, RedisStorage: 'async_trait,

批量写：默认逐键 set

fn mdel<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, keys: &'life1 [&'life2 str], ) -> Pin<Box<dyn Future<Output = Result<(), StorageError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, RedisStorage: 'async_trait,

批量删：默认逐键 delete

fn incr<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<i64, StorageError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, RedisStorage: 'async_trait,

自增：默认实现非原子（读-改-写），并发环境下计数不准确

fn decr<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<i64, StorageError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, RedisStorage: 'async_trait,

自减：默认实现非原子（读-改-写），语义同 incr

fn clear<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), StorageError>> + Send + 'async_trait>>

where 'life0: 'async_trait, RedisStorage: 'async_trait,

Remove all keys | 清空全部键

fn set_if_absent<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, key: &'life1 str, value: &'life2 str, ttl: Option<Duration>, ) -> Pin<Box<dyn Future<Output = Result<bool, StorageError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, RedisStorage: 'async_trait,

仅当键不存在（或已过期）时写入；成功占位返回 true

fn get_del<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Option<String>, StorageError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, RedisStorage: 'async_trait,

读取并删除；保证单次消费者语义

fn compare_and_swap<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, key: &'life1 str, expected: Option<&'life2 str>, new_value: &'life3 str, ttl: Option<Duration>, ) -> Pin<Box<dyn Future<Output = Result<bool, StorageError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, RedisStorage: 'async_trait,

比较并交换：当且仅当当前值等于 expected 时，写入 new_value

fn compare_and_delete<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, key: &'life1 str, expected: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<bool, StorageError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, RedisStorage: 'async_trait,

比较并删除：仅当当前值等于 expected 时删除

fn list_push<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, key: &'life1 str, member: &'life2 str, unique: bool, ttl: Option<Duration>, ) -> Pin<Box<dyn Future<Output = Result<usize, StorageError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, RedisStorage: 'async_trait,

向集合追加成员；unique=true 时跳过重复项

fn list_remove<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, key: &'life1 str, member: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<bool, StorageError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, RedisStorage: 'async_trait,

从集合移除成员；返回是否确实移除

fn list_range<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 str, start: usize, limit: Option<usize>, ) -> Pin<Box<dyn Future<Output = Result<Vec<String>, StorageError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, RedisStorage: 'async_trait,

分页读取集合成员

fn list_len<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<usize, StorageError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, RedisStorage: 'async_trait,

集合长度

fn scan<'life0, 'life1, 'async_trait>( &'life0 self, pattern: &'life1 str, cursor: u64, limit: usize, ) -> Pin<Box<dyn Future<Output = Result<ScanPage, StorageError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, RedisStorage: 'async_trait,

游标扫描：pattern 为 glob（* / ?），cursor 为上一页 next_cursor