Struct matrix_sdk_base::store::MemoryStore

pub struct MemoryStore { /* private fields */ }

In-Memory, non-persistent implementation of the StateStore

Default if no other is configured at startup.

Implementations

impl MemoryStore

pub fn new() -> Self

Create a new empty MemoryStore

Trait Implementations

impl Clone for MemoryStore

fn clone(&self) -> MemoryStore

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MemoryStore

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

Formats the value using the given formatter.

impl Default for MemoryStore

fn default() -> Self

Returns the “default value” for a type.

impl StateStore for MemoryStore

fn save_filter<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    filter_name: &'life1 str,
    filter_id: &'life2 str
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: '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 = Result<()>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: '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 = Result<Option<String>>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: '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 = Result<Option<String>>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    Self: '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 = Result<Option<Raw<PresenceEvent>>>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: '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 = Result<Option<Raw<AnySyncStateEvent>>>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: '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 = Result<Vec<Raw<AnySyncStateEvent>>>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: '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 = Result<Option<MinimalRoomMemberEvent>>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: '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 = Result<Option<MemberEvent>>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: '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 = Result<Vec<OwnedUserId>>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: '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 = Result<Vec<OwnedUserId>>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: '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 = Result<Vec<OwnedUserId>>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: '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 = Result<Vec<RoomInfo>>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    Self: '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 = Result<Vec<RoomInfo>>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    Self: '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 = Result<BTreeSet<OwnedUserId>>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: '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 = Result<Option<Raw<AnyGlobalAccountDataEvent>>>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    Self: '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 = Result<Option<Raw<AnyRoomAccountDataEvent>>>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: '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 = Result<Option<(OwnedEventId, Receipt)>>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: '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 = Result<Vec<(OwnedUserId, Receipt)>>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: '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 = Result<Option<Vec<u8>>>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: '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 = Result<Option<Vec<u8>>>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: '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 = Result<()>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: '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 = Result<Option<Vec<u8>>>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: '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 = Result<()>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: '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 = Result<()>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: '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 = Result<()>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: '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 = Result<Option<(BoxStream<Result<SyncTimelineEvent>>, Option<String>)>>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait,

Available on crate feature experimental-timeline only.

Get a stream of the stored timeline