Struct LatestEvents

pub struct LatestEvents { /* private fields */ }

The entry point to fetch the LatestEventValue for rooms or threads.

Implementations

impl LatestEvents

pub async fn listen_to_room( &self, room_id: &RoomId, ) -> Result<bool, LatestEventsError>

Start listening to updates (if not already) for a particular room.

It returns true if the room exists, false otherwise.

pub async fn listen_and_subscribe_to_room( &self, room_id: &RoomId, ) -> Result<Option<Subscriber<LatestEventValue, AsyncLock>>, LatestEventsError>

Start listening to updates (if not already) for a particular room, and return a Subscriber to get the current and future LatestEventValues.

It returns Some if the room exists, None otherwise.

pub async fn listen_to_thread( &self, room_id: &RoomId, thread_id: &EventId, ) -> Result<bool, LatestEventsError>

Start listening to updates (if not already) for a particular room and a particular thread in this room.

It returns true if the room and the thread exists, false otherwise.

pub async fn listen_and_subscribe_to_thread( &self, room_id: &RoomId, thread_id: &EventId, ) -> Result<Option<Subscriber<LatestEventValue, AsyncLock>>, LatestEventsError>

Start listening to updates (if not already) for a particular room and a particular thread in this room, and return a Subscriber to get the current and future LatestEventValues.

It returns Some if the room and the thread exists, None otherwise.

pub async fn forget_room(&self, room_id: &RoomId)

Forget a room.

It means that LatestEvents will stop listening to updates for the LatestEvents of the room and all its threads.

If LatestEvents is not listening for room_id, nothing happens.

pub async fn forget_thread(&self, room_id: &RoomId, thread_id: &EventId)

Forget a thread.

It means that LatestEvents will stop listening to updates for the LatestEvent of the thread.

If LatestEvents is not listening for room_id or thread_id, nothing happens.

Trait Implementations

impl Clone for LatestEvents

fn clone(&self) -> LatestEvents

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LatestEvents

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

Formats the value using the given formatter.