Struct matrix_sdk::event_cache::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 async fn oldest_backpagination_token( &self, max_wait: Option<Duration> ) -> Result<Option<PaginationToken>>

Returns the oldest back-pagination token, that is, the one closest to the beginning of the timeline as we know it.

Optionally, wait at most for the given duration for a back-pagination token to be returned by a sync.

pub async fn backpaginate( &self, batch_size: u16, token: Option<PaginationToken> ) -> Result<BackPaginationOutcome>

Back-paginate with the given token, if provided.

If no token has been provided, it will back-paginate from the end of the room.

If a token has been provided, but it was unknown to the event cache (i.e. it’s not associated to any gap in the timeline stored by the event cache), then an error result will be returned.

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.