Module event_cache

Source
Expand description

The event cache is an abstraction layer, sitting between the Rust SDK and a final client, that acts as a global observer of all the rooms, gathering and inferring some extra useful information about each room. In particular, this doesn’t require subscribing to a specific room to get access to this information.

It’s intended to be fast, robust and easy to maintain, having learned from previous endeavours at implementing middle to high level features elsewhere in the SDK, notably in the UI’s Timeline object.

See the github issue for more details about the historical reasons that led us to start writing this.

Structs§

BackPaginationOutcome
The result of a single back-pagination request.
EventCache
An event cache, providing lots of useful functionality for clients.
EventCacheDropHandles
Hold handles to the tasks spawn by a EventCache.
RoomEventCache
A subset of an event cache, for a room.
RoomEventCacheGenericUpdate
Represents a timeline update of a room. It hides the details of RoomEventCacheUpdate by being more generic.
RoomEventCacheSubscriber
Thin wrapper for a room event cache subscriber, so as to trigger side-effects when all subscribers are gone.
RoomPagination
An API object to run pagination queries on a super::RoomEventCache.
ThreadEventCacheUpdate
An update coming from a thread event cache.

Enums§

EventCacheError
An error observed in the EventCache.
EventsOrigin
Indicate where events are coming from.
RoomEventCacheUpdate
An update related to events happened in a room.
RoomPaginationStatus
Status for the back-pagination on a room event cache.

Type Aliases§

Result
A result using the EventCacheError.