Struct EventCache

pub struct EventCache { /* private fields */ }

An event cache, providing lots of useful functionality for clients.

Cloning is shallow, and thus is cheap to do.

See also the module-level comment.

Implementations

impl EventCache

pub fn enable_storage(&self) -> Result<()>

Enable storing updates to storage, and reload events from storage.

Has an effect only the first time it’s called. It’s safe to call it multiple times.

pub fn has_storage(&self) -> bool

Check whether the storage is enabled or not.

pub fn subscribe(&self) -> Result<()>

Starts subscribing the EventCache to sync responses, if not done before.

Re-running this has no effect if we already subscribed before, and is cheap.

pub async fn event(&self, event_id: &EventId) -> Option<TimelineEvent>

Try to find an event by its ID in all the rooms.

pub async fn empty_immutable_cache(&self)

Available on crate feature testing only.

Clear all the events from the immutable event cache.

This keeps all the rooms along with their internal events linked chunks, but it clears the side immutable cache for events.

As such, it doesn’t emit any RoomEventCacheUpdate, and it’s expected to be only useful in testing contexts.

pub async fn add_initial_events( &self, room_id: &RoomId, events: Vec<TimelineEvent>, prev_batch: Option<String>, ) -> Result<()>

Add an initial set of events to the event cache, reloaded from a cache.

TODO: temporary for API compat, as the event cache should take care of its own store.

Trait Implementations

impl Clone for EventCache

fn clone(&self) -> EventCache

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EventCache

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

Formats the value using the given formatter.