mirror/matrix-rust-sdk
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-rust-sdk.git synced 2026-05-15 03:25:46 -04:00
Code Issues Packages Projects Releases Wiki Activity

doc(base): Explain purpose of BaseClient#crypto_store

Browse Source
This commit is contained in:
Jonas Platte
2023-01-20 10:03:40 +01:00
committed by Jonas Platte
parent b0c70dc606
commit 1e2fd02478
1 changed files with 4 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
crates/matrix-sdk-base/src/client.rs
View File

@@ -77,7 +77,10 @@ use crate::{
pub struct BaseClient {
/// Database
pub(crate) store: Store,
/// The store used for encryption
/// The store used for encryption.
///
/// This field is only meant to be used for `OlmMachine` initialization.
/// All operations on it happen inside the `OlmMachine`.
#[cfg(feature = "e2e-encryption")]
crypto_store: Arc<dyn CryptoStore>,
/// The olm-machine that is created once the