Struct ThreadEventCache 

pub struct ThreadEventCache { /* private fields */ }

All the information related to a single thread.

Cloning is shallow, and thus is cheap to do.

Implementations

impl ThreadEventCache

pub fn room_id(&self) -> &RoomId

Get the room ID for this room.

pub fn thread_id(&self) -> &EventId

Get the thread ID for this thread.

pub async fn num_unread_messages(&self) -> Result<u64>

Get the number of unread messages.

To get multiple information about the read receipts, use Self::read_receipts as it involves a single lock.

pub async fn num_unread_notifications(&self) -> Result<u64>

Get the number of unread notifications.

To get multiple information about the read receipts, use Self::read_receipts as it involves a single lock.

pub async fn num_unread_mentions(&self) -> Result<u64>

Get the number of unread mentions, that is, messages causing a highlight in a room.

To get multiple information about the read receipts, use Self::read_receipts as it involves a single lock.

pub async fn read_receipts(&self) -> Result<ReadReceipts>

Get the detailed information about read receipts for this thread.

pub async fn subscribe_to_thread_info( &self, ) -> Result<Subscriber<ThreadInfo, AsyncLock>>

Subscribe to update of the ThreadInfo.

pub async fn subscribe( &self, ) -> Result<(Vec<Event>, Subscriber<ThreadEventCacheUpdate>)>

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

Creating, and especially dropping, a Subscriber isn’t free, as it triggers side-effects.

pub fn pagination(&self) -> ThreadPagination

Return a ThreadPagination useful for running back-pagination queries in this thread.

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

Try to find an event by ID in this thread, 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.

Trait Implementations

impl Clone for ThreadEventCache

fn clone(&self) -> ThreadEventCache

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ThreadEventCache

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

Formats the value using the given formatter.