Struct RoomEventCache

pub struct RoomEventCache { /* private fields */ }

A subset of an event cache, for a room.

Cloning is shallow, and thus is cheap to do.

Implementations

impl RoomEventCache

pub async fn events(&self) -> Vec<Event>

Read all current events.

Use RoomEventCache::subscribe to get all current events, plus a subscriber.

pub async fn subscribe(&self) -> (Vec<Event>, RoomEventCacheSubscriber)

Subscribe to this room updates, after getting the initial list of events.

Use RoomEventCache::events to get all current events without the subscriber. Creating, and especially dropping, a RoomEventCacheSubscriber isn’t free, as it triggers side-effects.

pub async fn subscribe_to_thread( &self, thread_root: OwnedEventId, ) -> (Vec<Event>, Receiver<ThreadEventCacheUpdate>)

Subscribe to thread for a given root event, and get a (maybe empty) initially known list of events for that thread.

pub async fn paginate_thread_backwards( &self, thread_root: OwnedEventId, num_events: u16, ) -> Result<bool>

Paginate backwards in a thread, given its root event ID.

Returns whether we’ve hit the start of the thread, in which case the root event will be prepended to the thread.

pub fn pagination(&self) -> RoomPagination

Return a RoomPagination API object useful for running back-pagination queries in the current room.

pub async fn rfind_map_event_in_memory_by<O, P>( &self, predicate: P, ) -> Option<O>

where P: FnMut(&Event) -> Option<O>,

Try to find a single event in this room, starting from the most recent event.

Warning! It looks into the loaded events from the in-memory linked chunk only. It doesn’t look inside the storage.

pub async fn find_event(&self, event_id: &EventId) -> Option<Event>

Try to find an event by ID in this room.

It starts by looking into loaded events before looking inside the storage.

pub async fn find_event_with_relations( &self, event_id: &EventId, filter: Option<Vec<RelationType>>, ) -> Option<(Event, Vec<Event>)>

Try to find an event by ID in this room, along with its related events.

You can filter which types of related events to retrieve using filter. None will retrieve related events of any type.

The related events are sorted like this:

• events saved out-of-band (with RoomEventCache::save_events) will be located at the beginning of the array.
• events present in the linked chunk (be it in memory or in the storage) will be sorted according to their ordering in the linked chunk.

pub async fn clear(&self) -> Result<()>

Clear all the storage for this RoomEventCache.

This will get rid of all the events from the linked chunk and persisted storage.

pub async fn debug_string(&self) -> Vec<String>

Return a nice debug string (a vector of lines) for the linked chunk of events for this room.

Trait Implementations

impl Clone for RoomEventCache

fn clone(&self) -> RoomEventCache

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RoomEventCache

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

Formats the value using the given formatter.