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 subscribe( &self, ) -> Result<(Vec<SyncTimelineEvent>, Receiver<RoomEventCacheUpdate>)>

Subscribe to room updates for this room, after getting the initial list of events. XXX: Could/should it use some kind of Observable instead? Or not something async, like explicit handlers as our event handlers?

pub fn pagination(&self) -> RoomPagination

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

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

Try to find an event by id in this room.

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

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.

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 copy of the value.

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.