Struct SledStateStore 

pub struct SledStateStore { /* private fields */ }

Implementations

impl SledStateStore

pub fn builder() -> SledStateStoreBuilder

Generate a SledStateStoreBuilder with default parameters

pub fn open() -> StoreResult<Self>

👎Deprecated: Use SledStateStoreBuilder instead.

pub fn open_with_passphrase( path: impl AsRef<Path>, passphrase: &str, ) -> StoreResult<Self>

👎Deprecated: Use SledStateStoreBuilder instead.

pub fn open_with_path(path: impl AsRef<Path>) -> StoreResult<Self>

👎Deprecated: Use SledStateStoreBuilder instead.

pub fn open_crypto_store(&self) -> Result<SledCryptoStore, OpenStoreError>

Open a SledCryptoStore that uses the same database as this store.

The given passphrase will be used to encrypt private data.

pub async fn save_filter( &self, filter_name: &str, filter_id: &str, ) -> Result<(), SledStoreError>

pub async fn get_filter( &self, filter_name: &str, ) -> Result<Option<String>, SledStoreError>

pub async fn get_sync_token(&self) -> Result<Option<String>, SledStoreError>

pub async fn save_changes( &self, changes: &StateChanges, ) -> Result<(), SledStoreError>

pub async fn get_presence_event( &self, user_id: &UserId, ) -> Result<Option<Raw<PresenceEvent>>, SledStoreError>

pub async fn get_state_event( &self, room_id: &RoomId, event_type: StateEventType, state_key: &str, ) -> Result<Option<Raw<AnySyncStateEvent>>, SledStoreError>

pub async fn get_state_events( &self, room_id: &RoomId, event_type: StateEventType, ) -> Result<Vec<Raw<AnySyncStateEvent>>, SledStoreError>

pub async fn get_profile( &self, room_id: &RoomId, user_id: &UserId, ) -> Result<Option<MinimalStateEvent<RoomMemberEventContent>>, SledStoreError>

pub async fn get_member_event( &self, room_id: &RoomId, state_key: &UserId, ) -> Result<Option<MemberEvent>, SledStoreError>

pub async fn get_user_ids_stream( &self, room_id: &RoomId, ) -> StoreResult<impl Stream<Item = StoreResult<OwnedUserId>>>

pub async fn get_stripped_user_ids_stream( &self, room_id: &RoomId, ) -> StoreResult<impl Stream<Item = StoreResult<OwnedUserId>>>

pub async fn get_invited_user_ids( &self, room_id: &RoomId, ) -> StoreResult<impl Stream<Item = StoreResult<OwnedUserId>>>

pub async fn get_joined_user_ids( &self, room_id: &RoomId, ) -> StoreResult<impl Stream<Item = StoreResult<OwnedUserId>>>

pub async fn get_stripped_invited_user_ids( &self, room_id: &RoomId, ) -> StoreResult<impl Stream<Item = StoreResult<OwnedUserId>>>

pub async fn get_stripped_joined_user_ids( &self, room_id: &RoomId, ) -> StoreResult<impl Stream<Item = StoreResult<OwnedUserId>>>

pub async fn get_room_infos( &self, ) -> Result<impl Stream<Item = Result<RoomInfo, SledStoreError>>, SledStoreError>

pub async fn get_stripped_room_infos( &self, ) -> Result<impl Stream<Item = Result<RoomInfo, SledStoreError>>, SledStoreError>

pub async fn get_users_with_display_name( &self, room_id: &RoomId, display_name: &str, ) -> Result<BTreeSet<OwnedUserId>, SledStoreError>

pub async fn get_account_data_event( &self, event_type: GlobalAccountDataEventType, ) -> Result<Option<Raw<AnyGlobalAccountDataEvent>>, SledStoreError>

pub async fn get_room_account_data_event( &self, room_id: &RoomId, event_type: RoomAccountDataEventType, ) -> Result<Option<Raw<AnyRoomAccountDataEvent>>, SledStoreError>

Trait Implementations

impl Clone for SledStateStore

fn clone(&self) -> SledStateStore

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SledStateStore

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

Formats the value using the given formatter.

impl StateStore for SledStateStore

fn save_filter<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, filter_name: &'life1 str, filter_id: &'life2 str, ) -> Pin<Box<dyn Future<Output = StoreResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Save the given filter id under the given name.

fn save_changes<'life0, 'life1, 'async_trait>( &'life0 self, changes: &'life1 StateChanges, ) -> Pin<Box<dyn Future<Output = StoreResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Save the set of state changes in the store.

fn get_filter<'life0, 'life1, 'async_trait>( &'life0 self, filter_id: &'life1 str, ) -> Pin<Box<dyn Future<Output = StoreResult<Option<String>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get the filter id that was stored under the given filter name.

fn get_sync_token<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = StoreResult<Option<String>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get the last stored sync token.

fn get_presence_event<'life0, 'life1, 'async_trait>( &'life0 self, user_id: &'life1 UserId, ) -> Pin<Box<dyn Future<Output = StoreResult<Option<Raw<PresenceEvent>>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get the stored presence event for the given user.

fn get_state_event<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, room_id: &'life1 RoomId, event_type: StateEventType, state_key: &'life2 str, ) -> Pin<Box<dyn Future<Output = StoreResult<Option<Raw<AnySyncStateEvent>>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Get a state event out of the state store.

fn get_state_events<'life0, 'life1, 'async_trait>( &'life0 self, room_id: &'life1 RoomId, event_type: StateEventType, ) -> Pin<Box<dyn Future<Output = StoreResult<Vec<Raw<AnySyncStateEvent>>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get a list of state events for a given room and StateEventType.

fn get_profile<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, room_id: &'life1 RoomId, user_id: &'life2 UserId, ) -> Pin<Box<dyn Future<Output = StoreResult<Option<MinimalStateEvent<RoomMemberEventContent>>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Get the current profile for the given user in the given room.

fn get_member_event<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, room_id: &'life1 RoomId, state_key: &'life2 UserId, ) -> Pin<Box<dyn Future<Output = StoreResult<Option<MemberEvent>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Get the MemberEvent for the given state key in the given room id.

fn get_user_ids<'life0, 'life1, 'async_trait>( &'life0 self, room_id: &'life1 RoomId, ) -> Pin<Box<dyn Future<Output = StoreResult<Vec<OwnedUserId>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get all the user ids of members for a given room, for stripped and regular rooms alike.

fn get_invited_user_ids<'life0, 'life1, 'async_trait>( &'life0 self, room_id: &'life1 RoomId, ) -> Pin<Box<dyn Future<Output = StoreResult<Vec<OwnedUserId>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get all the user ids of members that are in the invited state for a given room, for stripped and regular rooms alike.

fn get_joined_user_ids<'life0, 'life1, 'async_trait>( &'life0 self, room_id: &'life1 RoomId, ) -> Pin<Box<dyn Future<Output = StoreResult<Vec<OwnedUserId>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get all the user ids of members that are in the joined state for a given room, for stripped and regular rooms alike.

fn get_room_infos<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = StoreResult<Vec<RoomInfo>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get all the pure RoomInfos the store knows about.

fn get_stripped_room_infos<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = StoreResult<Vec<RoomInfo>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get all the pure RoomInfos the store knows about.

fn get_users_with_display_name<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, room_id: &'life1 RoomId, display_name: &'life2 str, ) -> Pin<Box<dyn Future<Output = StoreResult<BTreeSet<OwnedUserId>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Get all the users that use the given display name in the given room.

fn get_account_data_event<'life0, 'async_trait>( &'life0 self, event_type: GlobalAccountDataEventType, ) -> Pin<Box<dyn Future<Output = StoreResult<Option<Raw<AnyGlobalAccountDataEvent>>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get an event out of the account data store.

fn get_room_account_data_event<'life0, 'life1, 'async_trait>( &'life0 self, room_id: &'life1 RoomId, event_type: RoomAccountDataEventType, ) -> Pin<Box<dyn Future<Output = StoreResult<Option<Raw<AnyRoomAccountDataEvent>>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get an event out of the room account data store.

fn get_user_room_receipt_event<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, room_id: &'life1 RoomId, receipt_type: ReceiptType, user_id: &'life2 UserId, ) -> Pin<Box<dyn Future<Output = StoreResult<Option<(OwnedEventId, Receipt)>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Get an event out of the user room receipt store.

fn get_event_room_receipt_events<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, room_id: &'life1 RoomId, receipt_type: ReceiptType, event_id: &'life2 EventId, ) -> Pin<Box<dyn Future<Output = StoreResult<Vec<(OwnedUserId, Receipt)>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Get events out of the event room receipt store.

fn get_custom_value<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 [u8], ) -> Pin<Box<dyn Future<Output = StoreResult<Option<Vec<u8>>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get arbitrary data from the custom store

fn set_custom_value<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 [u8], value: Vec<u8>, ) -> Pin<Box<dyn Future<Output = StoreResult<Option<Vec<u8>>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Put arbitrary data into the custom store

fn add_media_content<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 MediaRequest, data: Vec<u8>, ) -> Pin<Box<dyn Future<Output = StoreResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Add a media file’s content in the media store.

fn get_media_content<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 MediaRequest, ) -> Pin<Box<dyn Future<Output = StoreResult<Option<Vec<u8>>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get a media file’s content out of the media store.

fn remove_media_content<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 MediaRequest, ) -> Pin<Box<dyn Future<Output = StoreResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Removes a media file’s content from the media store.

fn remove_media_content_for_uri<'life0, 'life1, 'async_trait>( &'life0 self, uri: &'life1 MxcUri, ) -> Pin<Box<dyn Future<Output = StoreResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Removes all the media files’ content associated to an MxcUri from the media store.

fn remove_room<'life0, 'life1, 'async_trait>( &'life0 self, room_id: &'life1 RoomId, ) -> Pin<Box<dyn Future<Output = StoreResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Removes a room and all elements associated from the state store.

fn room_timeline<'life0, 'life1, 'async_trait>( &'life0 self, room_id: &'life1 RoomId, ) -> Pin<Box<dyn Future<Output = StoreResult<Option<(BoxStream<StoreResult<SyncTimelineEvent>>, Option<String>)>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get a stream of the stored timeline