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

Merge branch 'dkasak/docs-improvements'

Browse Source
This commit is contained in:
Damir Jelić
2022-05-20 07:26:00 +02:00
parent 9e6e76e5ed c3f2003eb7
commit 552de33dbc
8 changed files with 30 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
crates/matrix-sdk-crypto-ffi/src/machine.rs
View File

@@ -1330,7 +1330,7 @@ impl OlmMachine {
Ok(self.runtime.block_on(self.inner.backup_machine().room_key_counts())?.into())
}
/// Store the recovery key in the cryptostore.
/// Store the recovery key in the crypto store.
///
/// This is useful if the client wants to support gossiping of the backup
/// key.

2
crates/matrix-sdk-crypto/src/backups/mod.rs
View File

@@ -220,7 +220,7 @@ impl BackupMachine {
Ok(())
}
/// Store the recovery key in the cryptostore.
/// Store the recovery key in the crypto store.
///
/// This is useful if the client wants to support gossiping of the backup
/// key.

4
crates/matrix-sdk-crypto/src/identities/device.rs
View File

@@ -456,8 +456,8 @@ impl ReadOnlyDevice {
/// Set the trust state of the device to the given state.
///
/// Note: This should only done in the cryptostore where the trust state can
/// be stored.
/// Note: This should only done in the crypto store where the trust state
/// can be stored.
pub(crate) fn set_trust_state(&self, state: LocalTrust) {
self.trust_state.store(state, Ordering::Relaxed)
}

4
crates/matrix-sdk-crypto/src/store/mod.rs
View File

@@ -639,8 +639,8 @@ impl CryptoStoreError {
}
}
/// Trait abstracting a store that the `OlmMachine` uses to store cryptographic
/// keys.
/// Represents a store that the `OlmMachine` uses to store E2EE data (such as
/// cryptographic keys).
#[cfg_attr(target_arch = "wasm32", async_trait(?Send))]
#[cfg_attr(not(target_arch = "wasm32"), async_trait)]
pub trait CryptoStore: AsyncTraitDeps {

4
crates/matrix-sdk-sled/src/cryptostore.rs
View File

@@ -205,7 +205,7 @@ impl std::fmt::Debug for SledStore {
}
impl SledStore {
/// Open the sled based cryptostore at the given path using the given
/// Open the sled-based crypto store at the given path using the given
/// passphrase to encrypt private data.
pub fn open_with_passphrase(
path: impl AsRef<Path>,
@@ -224,7 +224,7 @@ impl SledStore {
SledStore::open_helper(db, Some(path), store_cipher)
}
/// Create a sled based cryptostore using the given sled database.
/// Create a sled-based crypto store using the given sled database.
/// The given passphrase will be used to encrypt private data.
pub fn open_with_database(
db: Db,

26
crates/matrix-sdk/README.md
View File

@@ -59,19 +59,19 @@ More examples can be found in the [examples] directory.
The following crate feature flags are available:
| Feature | Default | Description |
| ------------------- | :-----: | --------------------------------------------------------------------- |
| `anyhow` | No | Better logging for event handlers that return `anyhow::Result` |
| `e2e-encryption` | Yes | Enable End-to-end encryption support |
| `eyre` | No | Better logging for event handlers that return `eyre::Result` |
| `image-proc` | No | Enables image processing to generate thumbnails |
| `image-rayon` | No | Enables faster image processing |
| `markdown` | No | Support to send Markdown-formatted messages |
| `qrcode` | Yes | QR code verification support |
| `sled` | Yes | Persistent storage of state and E2EE-Data using sled (if `e2e-encryption` is activated)
| `indexeddb` | No | Persistent storage of state and E2EE-Data for browsers using indexeddb (if `e2e-encryption` is activated)
| `socks` | No | Enables SOCKS support in the default HTTP client, [`reqwest`] |
| `sso-login` | No | Enables SSO login with a local HTTP server |
| Feature | Default | Description |
| ------------------- | :-----: | -------------------------------------------------------------------------------------------------------------------------- |
| `anyhow` | No | Better logging for event handlers that return `anyhow::Result` |
| `e2e-encryption` | Yes | End-to-end encryption (E2EE) support |
| `eyre` | No | Better logging for event handlers that return `eyre::Result` |
| `image-proc` | No | Image processing for generating thumbnails |
| `image-rayon` | No | Enables faster image processing |
| `markdown` | No | Support for sending Markdown-formatted messages |
| `qrcode` | Yes | QR code verification support |
| `sled` | Yes | Persistent storage of state and E2EE data (optionally, if feature `e2e-encryption` is enabled), via Sled |
| `indexeddb` | No | Persistent storage of state and E2EE data (optionally, if feature `e2e-encryption` is enabled) for browsers, via IndexedDB |
| `socks` | No | SOCKS support in the default HTTP client, [`reqwest`] |
| `sso-login` | No | Support for SSO login with a local HTTP server |
[`reqwest`]: https://docs.rs/reqwest/0.11.5/reqwest/index.html

6
crates/matrix-sdk/src/error.rs
View File

@@ -198,9 +198,9 @@ pub enum RoomKeyImportError {
#[error(transparent)]
SerdeJson(#[from] JsonError),
/// The cryptostore isn't yet open, logging in is required to open the
/// cryptostore.
#[error("The cryptostore hasn't been yet opened, can't import yet.")]
/// The crypto store isn't yet open. Logging in is required to open the
/// crypto store.
#[error("The crypto store hasn't been yet opened, can't import yet.")]
StoreClosed,
/// An IO error happened.

12
crates/matrix-sdk/src/store.rs
View File

@@ -16,12 +16,12 @@
//! The re-exports present here depend on the store-related features that are
//! enabled:
//!
//! 1. `sled` provides a `StateStore`, and a `CryptoStore` for encryption data
//! if `e2e-encryption` is enabled. This is the default persistent store
//! implementation for non-WebAssembly targets.
//! 2. `indexeddb`, too, provides a `StateStore` and a `CryptoStore` if
//! `encryption` is also enabled. This is the default persistent store
//! implementation for WebAssembly targets.
//! 1. The `sled` feature provides a `StateStore` for storing state and
//! a `CryptoStore` for E2EE data (if `e2e-encryption` is enabled). This is
//! the default persistent store implementation for non-WebAssembly targets.
//! 2. The `indexeddb` feature also provides a `StateStore` for storing state
//! and a `CryptoStore` (if `e2e-encryption` is enabled). This is the default
//! persistent store implementation for WebAssembly targets.
//!
//! Both options provide a `make_store_config` convenience method to create a
//! [`StoreConfig`] for [`ClientBuilder::store_config()`].