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_
tests testing - Trait and macro of integration tests for StateStore implementations.
- migration_
helpers - Data migration helpers for StateStore implementations.
Structs§
- Child
Transaction Id - A transaction id identifying a
DependentQueuedRequestrather than its parentQueuedRequest. - Composer
Draft - Current draft of the composer for the room.
- Dependent
Queued Request - A request to be sent, depending on a
QueuedRequestto be sent first. - Finish
Upload Thumbnail Info - Detailed record about a thumbnail used when finishing a media upload.
- Memory
Store - In-memory, non-persistent implementation of the
StateStore. - Queued
Request - A request to be sent with a send queue.
- Sent
Media Info - Information about a media (and its thumbnail) that have been sent to an homeserver.
- Serializable
Event Content - A thin wrapper to serialize a
AnyMessageLikeEventContent. - Server
Capabilities - Server capabilities returned by the /client/versions endpoint.
- State
Changes - Store state changes and pass them to the StateStore.
- Store
Config - Configuration for the various stores.
Enums§
- Composer
Draft Type - The type of draft of the composer.
- Dependent
Queued Request Kind - The specific user intent that characterizes a
DependentQueuedRequestKind. - Queue
Wedge Error - Represents a failed to send unrecoverable error of an event sent via the send queue.
- Queued
Request Kind - The kind of a send queue request.
- Sent
Request Key - A unique key (identifier) indicating that a transaction has been successfully sent to the server.
- State
Store Data Key - A key for key-value data.
- State
Store Data Value - A value for key-value data that should be persisted into the store.
- Store
Encryption Error - Error type for the
StoreCipheroperations. - Store
Error - State store specific error type.
Traits§
- Into
State Store - A type that can be type-erased into
Arc<dyn StateStore>. - State
Store - An abstract state store trait that can be used to implement different stores for the SDK.
- State
Store Ext - Convenience functionality for state stores.
- State
Store Integration Tests StateStoreintegration tests.
Type Aliases§
- DynState
Store - A type-erased
StateStore. - Result
- A
StateStorespecific result type.