Struct RedisApiKeyStore

pub struct RedisApiKeyStore { /* private fields */ }

Implementations

impl RedisApiKeyStore

pub fn new(pool: Pool) -> Self

pub fn new_with_config(pool: Pool, config: BarnacleConfig) -> Self

pub fn from_url(url: &str) -> Result<Self, PoolError>

pub fn with_key_prefix(self, prefix: String) -> Self

pub async fn save_key( &self, api_key: &str, config: Option<&BarnacleConfig>, ttl_seconds: Option<u64>, ) -> Result<(), BarnacleError>

pub async fn validate_key_with_fallback<F, Fut, E>( &self, api_key: &str, validator: F, config: Option<&BarnacleConfig>, ttl_seconds: Option<u64>, ) -> Result<ApiKeyValidationResult, E>

where F: FnOnce(String) -> Fut, Fut: Future<Output = Result<Option<String>, E>>, E: Debug,

Validates an API key with a fallback mechanism:

1. First checks if the key exists in Redis
2. If not, calls the provided validator function
3. If the validator returns a valid result, saves the key to Redis

This is useful for validating API keys against a database only when needed

pub async fn invalidate_all_keys(&self) -> Result<u32, BarnacleError>

Invalidates all API keys from the Redis cache This is useful when API keys are modified in the database

Trait Implementations

impl ApiKeyStore for RedisApiKeyStore

fn validate_key<'life0, 'life1, 'async_trait>( &'life0 self, api_key: &'life1 str, ) -> Pin<Box<dyn Future<Output = ApiKeyValidationResult> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Validate an API key and return its configuration

fn get_rate_limit_config<'life0, 'life1, 'async_trait>( &'life0 self, api_key: &'life1 str, ) -> Pin<Box<dyn Future<Output = Option<BarnacleConfig>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Optional: Get rate limit configuration for a specific key This allows for dynamic per-key configuration

fn try_cache_key<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, api_key: &'life1 str, config: &'life2 BarnacleConfig, ttl_seconds: Option<u64>, ) -> Pin<Box<dyn Future<Output = Result<(), BarnacleError>> + Send + 'async_trait>>

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

Optional: Cache a validated API key for future requests Default implementation does nothing - stores can override if they support caching

impl Clone for RedisApiKeyStore

fn clone(&self) -> RedisApiKeyStore

Returns a duplicate of the value.

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

Performs copy-assignment from source.