From 39dd9280cb204e0fe493830c7cc826e86d79ae52 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Damir=20Jeli=C4=87?= Date: Thu, 19 Mar 2020 13:55:58 +0100 Subject: [PATCH] rust-sdk: Document our feature flags. --- src/lib.rs | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/src/lib.rs b/src/lib.rs index 756eaf66..84b40335 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -14,6 +14,16 @@ // limitations under the License. //! This crate implements a [Matrix](https://matrix.org/) client library. +//! +//! ## Crate Feature Flags +//! +//! The following crate feature flags are available: +//! +//! * `encryption`: Enables end-to-end encryption support in the library. +//! * `sqlite-cryptostore`: Enables a SQLite based store for the encryption +//! keys. If this is disabled and `encryption` support is enabled the keys will +//! by default be stored only in memory and thus lost after the client is +//! destroyed. #![deny(missing_docs)] pub use crate::{error::Error, error::Result, session::Session};