Struct CachePlugin 

pub struct CachePlugin { /* private fields */ }

The cache engine – a Redis-like in-memory data structure store.

Implementations

impl CachePlugin

pub fn new(max_keys: usize) -> Self

pub fn set(&self, key: &str, value: &str, ttl: Option<u64>)

SET key value [EX seconds]

pub fn get(&self, key: &str) -> Option<String>

GET key – returns None if expired or missing.

pub fn del(&self, key: &str) -> bool

DEL key – returns true if key existed.

pub fn exists(&self, key: &str) -> bool

EXISTS key

pub fn incr(&self, key: &str) -> Result<i64, String>

INCR key – increment integer value, creates if not exists (starts at 0).

pub fn decr(&self, key: &str) -> Result<i64, String>

DECR key

pub fn incrby(&self, key: &str, amount: i64) -> Result<i64, String>

INCRBY key amount

pub fn setnx(&self, key: &str, value: &str, ttl: Option<u64>) -> bool

SETNX – set only if key doesn’t exist. Returns true if set.

pub fn getset(&self, key: &str, value: &str) -> Option<String>

GETSET – set new value and return old value.

pub fn mget(&self, keys: &[&str]) -> Vec<Option<String>>

MGET – get multiple keys.

pub fn mset(&self, pairs: &[(&str, &str)])

MSET – set multiple keys.

pub fn ttl(&self, key: &str) -> i64

TTL key – returns remaining seconds, -1 if no expiry, -2 if key doesn’t exist.

pub fn expire(&self, key: &str, seconds: u64) -> bool

EXPIRE key seconds – set expiry on existing key.

pub fn persist(&self, key: &str) -> bool

PERSIST key – remove expiry.

pub fn keys(&self, pattern: &str) -> Vec<String>

KEYS pattern – find keys matching glob pattern.

pub fn lpush(&self, key: &str, value: &str) -> usize

LPUSH key value – push to front, creates list if needed.

pub fn rpush(&self, key: &str, value: &str) -> usize

RPUSH key value – push to back.

pub fn lpop(&self, key: &str) -> Option<String>

LPOP key – pop from front.

pub fn rpop(&self, key: &str) -> Option<String>

RPOP key – pop from back.

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

LRANGE key start stop – get range (inclusive, supports negative indices).

pub fn llen(&self, key: &str) -> usize

LLEN key – list length.

pub fn sadd(&self, key: &str, member: &str) -> bool

SADD key member – add to set. Returns true if the member was newly added.

pub fn srem(&self, key: &str, member: &str) -> bool

SREM key member – remove from set.

pub fn smembers(&self, key: &str) -> Vec<String>

SMEMBERS key – all members.

pub fn sismember(&self, key: &str, member: &str) -> bool

SISMEMBER key member

pub fn scard(&self, key: &str) -> usize

SCARD key – set size.

pub fn sinter(&self, key1: &str, key2: &str) -> Vec<String>

SINTER key1 key2 – intersection of two sets.

pub fn sunion(&self, key1: &str, key2: &str) -> Vec<String>

SUNION key1 key2 – union of two sets.

pub fn hset(&self, key: &str, field: &str, value: &str)

HSET key field value

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

HGET key field

pub fn hdel(&self, key: &str, field: &str) -> bool

HDEL key field

pub fn hgetall(&self, key: &str) -> HashMap<String, String>

HGETALL key – all field-value pairs.

pub fn hexists(&self, key: &str, field: &str) -> bool

HEXISTS key field

pub fn hlen(&self, key: &str) -> usize

HLEN key

pub fn hkeys(&self, key: &str) -> Vec<String>

HKEYS key – all field names.

pub fn hincrby( &self, key: &str, field: &str, amount: i64, ) -> Result<i64, String>

HINCRBY key field amount

pub fn zadd(&self, key: &str, score: f64, member: &str)

ZADD key score member

pub fn zrem(&self, key: &str, member: &str) -> bool

ZREM key member

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

ZSCORE key member

pub fn zrank(&self, key: &str, member: &str) -> Option<usize>

ZRANK key member – rank by score (0-based).

pub fn zrange(&self, key: &str, start: usize, stop: usize) -> Vec<(String, f64)>

ZRANGE key start stop – members by rank range (inclusive).

pub fn zcard(&self, key: &str) -> usize

ZCARD key – sorted set size.

pub fn dbsize(&self) -> usize

DBSIZE – total key count (excluding expired).

pub fn flushall(&self)

FLUSHALL – delete everything.

pub fn info(&self) -> CacheStats

INFO – cache statistics.

pub fn key_type(&self, key: &str) -> Option<&'static str>

TYPE key – returns the type of value stored.

pub fn cleanup_expired(&self) -> usize

Cleanup expired keys (call periodically). Returns number of keys removed.

Trait Implementations

impl Plugin for CachePlugin

fn name(&self) -> &str

Unique name for this plugin.

fn on_init(&self, _ctx: &PluginContext)

Called once when the plugin is registered.

fn routes(&self) -> Vec<PluginRoute>

Custom API routes this plugin handles.

fn before_insert( &self, _entity: &str, _data: &mut Value, _auth: &AuthContext, ) -> Result<(), PluginError>

Called before an entity insert. Return Err to reject.

fn after_insert( &self, _entity: &str, _id: &str, _data: &Value, _auth: &AuthContext, )

Called after a successful insert.

fn before_update( &self, _entity: &str, _id: &str, _data: &mut Value, _auth: &AuthContext, ) -> Result<(), PluginError>

Called before an entity update. Return Err to reject.

fn after_update( &self, _entity: &str, _id: &str, _data: &Value, _auth: &AuthContext, )

Called after a successful update.

fn before_delete( &self, _entity: &str, _id: &str, _auth: &AuthContext, ) -> Result<(), PluginError>

Called before an entity delete. Return Err to reject.

fn after_delete(&self, _entity: &str, _id: &str, _auth: &AuthContext)

Called after a successful delete.

fn on_request( &self, _method: &str, _path: &str, _auth: &AuthContext, ) -> Result<(), PluginError>

Called on every incoming request (middleware).

fn on_request_with_meta( &self, method: &str, path: &str, auth: &AuthContext, _meta: &RequestMeta<'_>, ) -> Result<(), PluginError>

Richer variant of [on_request] that also receives per-request metadata (peer IP today; more fields may be added later). The default implementation delegates to on_request so existing plugins keep working without changes. Plugins that care about IP — notably rate limiting — override this hook.

fn on_session_create(&self, _user_id: &str, _token: &str)

Called when a new session is created.

fn entities(&self) -> Vec<ManifestEntity>

Additional manifest entities this plugin contributes.