Struct matrix_sdk::SqliteCryptoStore

source · 
pub struct SqliteCryptoStore { /* private fields */ }
Available on crate features e2e-encryption and sqlite only.
Expand description

A sqlite based cryptostore.

Implementations§

source§

impl SqliteCryptoStore

source

pub async fn open( path: impl AsRef<Path>, passphrase: Option<&str>, ) -> Result<SqliteCryptoStore, OpenStoreError>

Open the sqlite-based crypto store at the given path using the given passphrase to encrypt private data.

source

pub async fn open_with_pool( pool: Pool<Manager>, passphrase: Option<&str>, ) -> Result<SqliteCryptoStore, OpenStoreError>

Create a sqlite-based crypto store using the given sqlite database pool. The given passphrase will be used to encrypt private data.

Trait Implementations§

source§

impl Clone for SqliteCryptoStore

source§

fn clone(&self) -> SqliteCryptoStore

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl CryptoStore for SqliteCryptoStore

§

type Error = Error

The error type used by this crypto store.
source§

fn load_account<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Option<Account>, Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, SqliteCryptoStore: 'async_trait,

Load an account that was previously stored.
source§

fn load_identity<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Option<PrivateCrossSigningIdentity>, Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, SqliteCryptoStore: 'async_trait,

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

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

Save the set of changes to the store. Read more
source§

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

Save the set of changes to the store. Read more
source§

fn save_inbound_group_sessions<'life0, 'life1, 'async_trait>( &'life0 self, sessions: Vec<InboundGroupSession>, backed_up_to_version: Option<&'life1 str>, ) -> Pin<Box<dyn Future<Output = Result<(), <SqliteCryptoStore as CryptoStore>::Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, SqliteCryptoStore: 'async_trait,

Save a list of inbound group sessions to the store. Read more
source§

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

Get all the sessions that belong to the given sender key. Read more
source§

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>, Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, SqliteCryptoStore: 'async_trait,

Get the inbound group session from our store. Read more
source§

fn get_inbound_group_sessions<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<InboundGroupSession>, Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, SqliteCryptoStore: 'async_trait,

Get all the inbound group sessions we have stored.
source§

fn get_inbound_group_sessions_for_device_batch<'life0, 'async_trait>( &'life0 self, sender_key: Curve25519PublicKey, sender_data_type: SenderDataType, after_session_id: Option<String>, limit: usize, ) -> Pin<Box<dyn Future<Output = Result<Vec<InboundGroupSession>, <SqliteCryptoStore as CryptoStore>::Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, SqliteCryptoStore: 'async_trait,

Get a batch of inbound group sessions for the device with the supplied curve key, whose sender data is of the supplied type. Read more
source§

fn inbound_group_session_counts<'life0, 'life1, 'async_trait>( &'life0 self, backup_version: Option<&'life1 str>, ) -> Pin<Box<dyn Future<Output = Result<RoomKeyCounts, Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, SqliteCryptoStore: 'async_trait,

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

fn inbound_group_sessions_for_backup<'life0, 'life1, 'async_trait>( &'life0 self, _backup_version: &'life1 str, limit: usize, ) -> Pin<Box<dyn Future<Output = Result<Vec<InboundGroupSession>, Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, SqliteCryptoStore: 'async_trait,

Return a batch of [‘InboundGroupSession’] (“room keys”) that have not yet been backed up in the supplied backup version. Read more
source§

fn mark_inbound_group_sessions_as_backed_up<'life0, 'life1, 'life2, 'life3, 'life4, 'async_trait>( &'life0 self, _backup_version: &'life1 str, session_ids: &'life2 [(&'life3 RoomId, &'life4 str)], ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, 'life4: 'async_trait, SqliteCryptoStore: 'async_trait,

Store the fact that the supplied sessions were backed up into the backup with version backup_version. Read more
source§

fn reset_backup_state<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, SqliteCryptoStore: 'async_trait,

Reset the backup state of all the stored inbound group sessions. Read more
source§

fn load_backup_keys<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<BackupKeys, Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, SqliteCryptoStore: 'async_trait,

Get the backup keys we have stored.
source§

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

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

fn load_tracked_users<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<TrackedUser>, Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, SqliteCryptoStore: 'async_trait,

Provide the list of users whose devices we are keeping track of, and whether they are considered dirty/outdated.
source§

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

Update the list of users whose devices we are keeping track of, and whether they are considered dirty/outdated. Read more
source§

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<DeviceData>, Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, SqliteCryptoStore: 'async_trait,

Get the device for the given user with the given device ID. Read more
source§

fn get_user_devices<'life0, 'life1, 'async_trait>( &'life0 self, user_id: &'life1 UserId, ) -> Pin<Box<dyn Future<Output = Result<HashMap<OwnedDeviceId, DeviceData>, Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, SqliteCryptoStore: 'async_trait,

Get all the devices of the given user. Read more
source§

fn get_own_device<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<DeviceData, Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, SqliteCryptoStore: 'async_trait,

Get the device for the current client. Read more
source§

fn get_user_identity<'life0, 'life1, 'async_trait>( &'life0 self, user_id: &'life1 UserId, ) -> Pin<Box<dyn Future<Output = Result<Option<UserIdentityData>, Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, SqliteCryptoStore: 'async_trait,

Get the user identity that is attached to the given user id. Read more
source§

fn is_message_known<'life0, 'life1, 'async_trait>( &'life0 self, message_hash: &'life1 OlmMessageHash, ) -> Pin<Box<dyn Future<Output = Result<bool, Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, SqliteCryptoStore: 'async_trait,

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

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

Get an outgoing secret request that we created that matches the given request id. Read more
source§

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

Get an outgoing key request that we created that matches the given requested key info. Read more
source§

fn get_unsent_secret_requests<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<GossipRequest>, Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, SqliteCryptoStore: 'async_trait,

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

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

Delete an outgoing key request that we created that matches the given request id. Read more
source§

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

Get all the secrets with the given SecretName we have currently stored.
source§

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

Delete all the secrets with the given SecretName we have currently stored.
source§

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<ToDeviceEvent<RoomKeyWithheldContent>>, Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, SqliteCryptoStore: '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.
source§

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

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

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

Get arbitrary data from the store Read more
source§

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

Put arbitrary data into the store Read more
source§

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

Remove arbitrary data into the store Read more
source§

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, Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, SqliteCryptoStore: 'async_trait,

Try to take a leased lock. Read more
source§

fn next_batch_token<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Option<String>, <SqliteCryptoStore as CryptoStore>::Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, SqliteCryptoStore: 'async_trait,

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

impl Debug for SqliteCryptoStore

Available on non-tarpaulin_include only.
source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
§

impl<T> CompatExt for T

§

fn compat(self) -> Compat<T>

Applies the [Compat] adapter by value. Read more
§

fn compat_ref(&self) -> Compat<&T>

Applies the [Compat] adapter by shared reference. Read more
§

fn compat_mut(&mut self) -> Compat<&mut T>

Applies the [Compat] adapter by mutable reference. Read more
source§

impl<T> DynClone for T
where T: Clone,

source§

fn __clone_box(&self, _: Private) -> *mut ()

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> FromRef<T> for T
where T: Clone,

source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
source§

impl<T> FutureExt for T

source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
source§

impl<T, UT> HandleAlloc<UT> for T
where T: Send + Sync,

source§

fn new_handle(value: Arc<T>) -> Handle

Create a new handle for an Arc value Read more
source§

fn clone_handle(handle: Handle) -> Handle

Clone a handle Read more
source§

fn consume_handle(handle: Handle) -> Arc<T>

Consume a handle, getting back the initial Arc<>
source§

fn get_arc(handle: Handle) -> Arc<Self>

Get a clone of the Arc<> using a “borrowed” handle. Read more
source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

source§

const WITNESS: W = W::MAKE

A constant of the type witness
source§

impl<T> Identity for T
where T: ?Sized,

§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoCryptoStore for T
where T: CryptoStore + 'static,

source§

fn into_crypto_store(self) -> Arc<dyn CryptoStore<Error = CryptoStoreError>>

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
source§

impl<T> Any for T
where T: Any,

source§

impl<T> AsyncTraitDeps for T
where T: Debug + SendOutsideWasm + SyncOutsideWasm,

source§

impl<T> CloneAny for T
where T: Any + Clone,

source§

impl<T> CloneAnySend for T
where T: Any + Send + Clone,

source§

impl<T> CloneAnySendSync for T
where T: Any + Send + Sync + Clone,

source§

impl<T> CloneAnySync for T
where T: Any + Sync + Clone,

source§

impl<T> SendOutsideWasm for T
where T: Send,

source§

impl<T> SyncOutsideWasm for T
where T: Sync,