Struct InMemoryCache

pub struct InMemoryCache { /* private fields */ }

An in-memory cache of Revolt data.

To use a cache instance in multiple tasks, consider wrapping it in an std::sync::Arc or std::rc::Rc.

Implementations

impl InMemoryCache

pub fn new() -> Self

Create new InMemoryCache instance with default Config.

pub fn new_with_config(config: Config) -> Self

Create new InMemoryCache instance with provided Config.

pub const fn builder() -> InMemoryCacheBuilder

Create a new builder to configure and construct an in-memory cache.

pub fn clear(&self)

Clear the cache.

pub const fn stats(&self) -> InMemoryCacheStats<'_>

Create an interface for retrieving cache statistics.

Example:

use rive_cache_inmemory::InMemoryCache;

let cache = InMemoryCache::new();

// later in the code...
let messages = cache.stats().messages();
println!("messages count: {messages}");

pub const fn iter(&self) -> InMemoryCacheIter<'_>

Create an interface for iterating over the various resources in the cache.

Example:

use rive_cache_inmemory::InMemoryCache;

let cache = InMemoryCache::new();

// later in the code...
for user in cache.iter().users() {
    println!("{}: {}#{}", user.id, user.username, user.discriminator);
}

pub fn user(&self, id: &str) -> Option<Reference<'_, String, User>>

Get a user by ID.

pub fn server(&self, id: &str) -> Option<Reference<'_, String, Server>>

Get a server by ID.

pub fn channel(&self, id: &str) -> Option<Reference<'_, String, Channel>>

Get a channel by ID.

pub fn message(&self, id: &str) -> Option<Reference<'_, String, Message>>

Get a message by ID.

pub fn emoji(&self, id: &str) -> Option<Reference<'_, String, Emoji>>

Get an emoji by ID.

pub fn member( &self, id: &MemberCompositeKey, ) -> Option<Reference<'_, MemberCompositeKey, Member>>

Get a member by MemberCompositeKey.

pub fn update(&self, event: &impl CacheUpdate)

Update the cache with an incoming event.

Trait Implementations

impl Debug for InMemoryCache

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

Formats the value using the given formatter.

impl Default for InMemoryCache

fn default() -> InMemoryCache

Returns the “default value” for a type.