matrix-rust-sdk/crates/matrix-sdk-indexeddb
Kegan Dougal 3a99d52e84
Apply suggestions from code review
Co-authored-by: Ivan Enderlin <ivan@mnt.io>
Signed-off-by: Kegan Dougal <7190048+kegsay@users.noreply.github.com>
2024-04-18 10:34:54 +01:00
..
src Apply suggestions from code review 2024-04-18 10:34:54 +01:00
CHANGELOG.md
Cargo.toml
README.md

README.md

matrix-sdk-indexedddb

This crate implements a storage backend on IndexedDB for web environments using the matrix-sdk-base primitives.

Usage

The most common usage pattern would be to have this included via matrix-sdk in your Cargo.toml and leave instantiation to it.

[target.'cfg(target_arch = "wasm32")'.dependencies]
matrix-sdk = { version = "0.5, default-features = false, features = ["indexeddb", "e2e-encryption"] }

Crate Feature Flags

The following crate feature flags are available:

  • e2e-encryption: (on by default) Enables the store for end-to-end encrypted data (IndexeddbCryptoStore).
  • state-store: (on by default) Enables the StateStore implementation (IndexeddbStateStore).