atagen

matrix-rust-sdk

public
Star0
Watch0
ssh://brewery@pls.lobotomise.me:33/atagen/matrix-rust-sdk.git

Blame: crates/matrix-sdk-indexeddb/README.md

7ff8adafe9e4atagen2026-10-22 12:30 UTC1
# `matrix-sdk-indexedddb`
7ff8adafe9e4atagen2026-10-22 12:30 UTC2
7ff8adafe9e4atagen2026-10-22 12:30 UTC3
This crate implements a storage backend on IndexedDB for web environments using
7ff8adafe9e4atagen2026-10-22 12:30 UTC4
the matrix-sdk-base primitives.
7ff8adafe9e4atagen2026-10-22 12:30 UTC5
7ff8adafe9e4atagen2026-10-22 12:30 UTC6
## Usage
7ff8adafe9e4atagen2026-10-22 12:30 UTC7
7ff8adafe9e4atagen2026-10-22 12:30 UTC8
The most common usage pattern would be to have this included via `matrix-sdk` in
7ff8adafe9e4atagen2026-10-22 12:30 UTC9
your `Cargo.toml` and leave instantiation to it.
7ff8adafe9e4atagen2026-10-22 12:30 UTC10
7ff8adafe9e4atagen2026-10-22 12:30 UTC11
```toml,no_test
7ff8adafe9e4atagen2026-10-22 12:30 UTC12
[target.'cfg(target_family = "wasm")'.dependencies]
7ff8adafe9e4atagen2026-10-22 12:30 UTC13
matrix-sdk = { version = "0.5, default-features = false, features = ["indexeddb", "e2e-encryption"] }
7ff8adafe9e4atagen2026-10-22 12:30 UTC14
```
7ff8adafe9e4atagen2026-10-22 12:30 UTC15
7ff8adafe9e4atagen2026-10-22 12:30 UTC16
## Crate feature flags
7ff8adafe9e4atagen2026-10-22 12:30 UTC17
7ff8adafe9e4atagen2026-10-22 12:30 UTC18
The following crate feature flags are available:
7ff8adafe9e4atagen2026-10-22 12:30 UTC19
7ff8adafe9e4atagen2026-10-22 12:30 UTC20
- `e2e-encryption`: (on by default) Enables the store for end-to-end encrypted
7ff8adafe9e4atagen2026-10-22 12:30 UTC21
  data (`IndexeddbCryptoStore`).
7ff8adafe9e4atagen2026-10-22 12:30 UTC22
- `state-store`: (on by default) Enables the `StateStore` implementation
7ff8adafe9e4atagen2026-10-22 12:30 UTC23
  (`IndexeddbStateStore`).