Struct matrix_sdk_indexeddb::IndexeddbCryptoStore

pub struct IndexeddbCryptoStore { /* private fields */ }

An implementation of CryptoStore that uses IndexedDB for persistent storage.

Implementations

impl IndexeddbCryptoStore

pub async fn open() -> Result<Self, IndexeddbCryptoStoreError>

Open a new IndexeddbCryptoStore with default name and no passphrase

pub async fn open_with_passphrase( prefix: &str, passphrase: &str ) -> Result<Self, IndexeddbCryptoStoreError>

Open a new IndexeddbCryptoStore with given name and passphrase

pub async fn open_with_name( name: &str ) -> Result<Self, IndexeddbCryptoStoreError>

Open a new IndexeddbCryptoStore with given name and no passphrase

Trait Implementations

impl CryptoStore for IndexeddbCryptoStore

type Error = IndexeddbCryptoStoreError

The error type used by this crypto store.

fn save_pending_changes<'life0, 'async_trait>( &'life0 self, changes: PendingChanges ) -> Pin<Box<dyn Future<Output = Result<(), IndexeddbCryptoStoreError>> + 'async_trait>>

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

Save the set of changes to the store.

fn save_changes<'life0, 'async_trait>( &'life0 self, changes: Changes ) -> Pin<Box<dyn Future<Output = Result<(), IndexeddbCryptoStoreError>> + 'async_trait>>

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

Save the set of changes to the store.

fn load_tracked_users<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = Result<Vec<TrackedUser>, IndexeddbCryptoStoreError>> + 'async_trait>>

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

Load the list of users whose devices we are keeping track of.

fn get_outbound_group_session<'life0, 'life1, 'async_trait>( &'life0 self, room_id: &'life1 RoomId ) -> Pin<Box<dyn Future<Output = Result<Option<OutboundGroupSession>, IndexeddbCryptoStoreError>> + 'async_trait>>

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

Get the outbound group session we have stored that is used for the given room.

fn get_outgoing_secret_requests<'life0, 'life1, 'async_trait>( &'life0 self, request_id: &'life1 TransactionId ) -> Pin<Box<dyn Future<Output = Result<Option<GossipRequest>, IndexeddbCryptoStoreError>> + 'async_trait>>

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

Get an outgoing secret request that we created that matches the given request id.

fn load_account<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = Result<Option<Account>, IndexeddbCryptoStoreError>> + 'async_trait>>

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

Load an account that was previously stored.

fn next_batch_token<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = Result<Option<String>, IndexeddbCryptoStoreError>> + 'async_trait>>

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

Load the next-batch token for a to-device query, if any.

fn load_identity<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = Result<Option<PrivateCrossSigningIdentity>, IndexeddbCryptoStoreError>> + 'async_trait>>

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

Try to load a private cross signing identity, if one is stored.

fn get_sessions<'life0, 'life1, 'async_trait>( &'life0 self, sender_key: &'life1 str ) -> Pin<Box<dyn Future<Output = Result<Option<Arc<Mutex<Vec<Session>>>>, IndexeddbCryptoStoreError>> + 'async_trait>>

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

Get all the sessions that belong to the given sender key.

fn get_inbound_group_session<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, room_id: &'life1 RoomId, session_id: &'life2 str ) -> Pin<Box<dyn Future<Output = Result<Option<InboundGroupSession>, IndexeddbCryptoStoreError>> + 'async_trait>>

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

Get the inbound group session from our store.

fn get_inbound_group_sessions<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = Result<Vec<InboundGroupSession>, IndexeddbCryptoStoreError>> + 'async_trait>>

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

Get all the inbound group sessions we have stored.

fn inbound_group_session_counts<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = Result<RoomKeyCounts, IndexeddbCryptoStoreError>> + 'async_trait>>

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

Get the number inbound group sessions we have and how many of them are backed up.

fn inbound_group_sessions_for_backup<'life0, 'async_trait>( &'life0 self, limit: usize ) -> Pin<Box<dyn Future<Output = Result<Vec<InboundGroupSession>, IndexeddbCryptoStoreError>> + 'async_trait>>

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

Get all the inbound group sessions we have not backed up yet.

fn mark_inbound_group_sessions_as_backed_up<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, room_and_session_ids: &'life1 [(&'life2 RoomId, &'life3 str)] ) -> Pin<Box<dyn Future<Output = Result<(), IndexeddbCryptoStoreError>> + 'async_trait>>

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

Mark the inbound group sessions with the supplied room and session IDs as backed up

fn reset_backup_state<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = Result<(), IndexeddbCryptoStoreError>> + 'async_trait>>

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

Reset the backup state of all the stored inbound group sessions.

fn save_tracked_users<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, users: &'life1 [(&'life2 UserId, bool)] ) -> Pin<Box<dyn Future<Output = Result<(), IndexeddbCryptoStoreError>> + 'async_trait>>

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

Save a list of users and their respective dirty/outdated flags to the store.

fn get_device<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, user_id: &'life1 UserId, device_id: &'life2 DeviceId ) -> Pin<Box<dyn Future<Output = Result<Option<ReadOnlyDevice>, IndexeddbCryptoStoreError>> + 'async_trait>>

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

Get the device for the given user with the given device ID.

fn get_user_devices<'life0, 'life1, 'async_trait>( &'life0 self, user_id: &'life1 UserId ) -> Pin<Box<dyn Future<Output = Result<HashMap<OwnedDeviceId, ReadOnlyDevice>, IndexeddbCryptoStoreError>> + 'async_trait>>

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

Get all the devices of the given user.

fn get_user_identity<'life0, 'life1, 'async_trait>( &'life0 self, user_id: &'life1 UserId ) -> Pin<Box<dyn Future<Output = Result<Option<ReadOnlyUserIdentities>, IndexeddbCryptoStoreError>> + 'async_trait>>

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

Get the user identity that is attached to the given user id.

fn is_message_known<'life0, 'life1, 'async_trait>( &'life0 self, hash: &'life1 OlmMessageHash ) -> Pin<Box<dyn Future<Output = Result<bool, IndexeddbCryptoStoreError>> + 'async_trait>>

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

Check if a hash for an Olm message stored in the database.

fn get_secrets_from_inbox<'life0, 'life1, 'async_trait>( &'life0 self, secret_name: &'life1 SecretName ) -> Pin<Box<dyn Future<Output = Result<Vec<GossippedSecret>, IndexeddbCryptoStoreError>> + 'async_trait>>

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

Get all the secrets with the given [SecretName] we have currently stored.

fn delete_secrets_from_inbox<'life0, 'life1, 'async_trait>( &'life0 self, secret_name: &'life1 SecretName ) -> Pin<Box<dyn Future<Output = Result<(), IndexeddbCryptoStoreError>> + 'async_trait>>

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

Delete all the secrets with the given [SecretName] we have currently stored.

fn get_secret_request_by_info<'life0, 'life1, 'async_trait>( &'life0 self, key_info: &'life1 SecretInfo ) -> Pin<Box<dyn Future<Output = Result<Option<GossipRequest>, IndexeddbCryptoStoreError>> + 'async_trait>>

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

Get an outgoing key request that we created that matches the given requested key info.

fn get_unsent_secret_requests<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = Result<Vec<GossipRequest>, IndexeddbCryptoStoreError>> + 'async_trait>>

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

Get all outgoing secret requests that we have in the store.

fn delete_outgoing_secret_requests<'life0, 'life1, 'async_trait>( &'life0 self, request_id: &'life1 TransactionId ) -> Pin<Box<dyn Future<Output = Result<(), IndexeddbCryptoStoreError>> + 'async_trait>>

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

Delete an outgoing key request that we created that matches the given request id.

fn load_backup_keys<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = Result<BackupKeys, IndexeddbCryptoStoreError>> + 'async_trait>>

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

Get the backup keys we have stored.

fn get_withheld_info<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, room_id: &'life1 RoomId, session_id: &'life2 str ) -> Pin<Box<dyn Future<Output = Result<Option<RoomKeyWithheldEvent>, IndexeddbCryptoStoreError>> + 'async_trait>>

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

Get withheld info for this key. Allows to know if the session was not sent on purpose. This only returns withheld info sent by the owner of the group session, not the one you can get from a response to a key request from another of your device.

fn get_room_settings<'life0, 'life1, 'async_trait>( &'life0 self, room_id: &'life1 RoomId ) -> Pin<Box<dyn Future<Output = Result<Option<RoomSettings>, IndexeddbCryptoStoreError>> + 'async_trait>>

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

Get the room settings, such as the encryption algorithm or whether to encrypt only for trusted devices.

fn get_custom_value<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 str ) -> Pin<Box<dyn Future<Output = Result<Option<Vec<u8>>, IndexeddbCryptoStoreError>> + 'async_trait>>

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

Get arbitrary data from the store

fn set_custom_value<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 str, value: Vec<u8> ) -> Pin<Box<dyn Future<Output = Result<(), IndexeddbCryptoStoreError>> + 'async_trait>>

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

Put arbitrary data into the store

fn remove_custom_value<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 str ) -> Pin<Box<dyn Future<Output = Result<(), IndexeddbCryptoStoreError>> + 'async_trait>>

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

Remove arbitrary data into the store

fn try_take_leased_lock<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, lease_duration_ms: u32, key: &'life1 str, holder: &'life2 str ) -> Pin<Box<dyn Future<Output = Result<bool, IndexeddbCryptoStoreError>> + 'async_trait>>

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

Try to take a leased lock.

impl Debug for IndexeddbCryptoStore

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

Formats the value using the given formatter.

impl Drop for IndexeddbCryptoStore

fn drop(&mut self)

Executes the destructor for this type.