Module store

Expand description

The state store holds the overall state for rooms, users and their profiles and their timelines. It is an overall cache for faster access and convenience- accessible through Store.

Implementing the StateStore trait, you can plug any storage backend into the store for the actual storage. By default this brings an in-memory store.

Modules§

integration_teststesting: Trait and macro of integration tests for StateStore implementations.
migration_helpers: Data migration helpers for StateStore implementations.

Structs§

AccumulatedSentMediaInfounstable-msc4274: Accumulated information about a media (and its thumbnail) that have been sent to a homeserver.
ChildTransactionId: A transaction id identifying a DependentQueuedRequest rather than its parent QueuedRequest.
ComposerDraft: Current draft of the composer for the room.
DependentQueuedRequest: A request to be sent, depending on a QueuedRequest to be sent first.
FinishGalleryItemInfounstable-msc4274: Detailed record about a file and thumbnail. When finishing a gallery upload, one FinishGalleryItemInfo will be used for each media in the gallery.
FinishUploadThumbnailInfo: Detailed record about a thumbnail used when finishing a media upload.
MemoryStore: In-memory, non-persistent implementation of the StateStore.
QueuedRequest: A request to be sent with a send queue.
SentMediaInfo: Information about a media (and its thumbnail) that have been sent to a homeserver.
SerializableEventContent: A thin wrapper to serialize a AnyMessageLikeEventContent.
ServerInfo: Useful server info such as data returned by the /client/versions and .well-known/client/matrix endpoints.
StateChanges: Store state changes and pass them to the StateStore.
StoreConfig: Configuration for the various stores.
WellKnownResponse: A serialisable representation of discover_homeserver::Response.

Enums§

ComposerDraftType: The type of draft of the composer.
DependentQueuedRequestKind: The specific user intent that characterizes a DependentQueuedRequestKind.
QueueWedgeError: Represents a failed to send unrecoverable error of an event sent via the send queue.
QueuedRequestKind: The kind of a send queue request.
RoomLoadSettings: Configure how many rooms will be restored when restoring the session with BaseStateStore::load_rooms.
SentRequestKey: A unique key (identifier) indicating that a transaction has been successfully sent to the server.
StateStoreDataKey: A key for key-value data.
StateStoreDataValue: A value for key-value data that should be persisted into the store.
StoreEncryptionError: Error type for the StoreCipher operations.
StoreError: State store specific error type.

Traits§

IntoStateStore: A type that can be type-erased into Arc<dyn StateStore>.
StateStore: An abstract state store trait that can be used to implement different stores for the SDK.
StateStoreExt: Convenience functionality for state stores.
StateStoreIntegrationTests: StateStore integration tests.

Type Aliases§