char
/
matrix-rust-sdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

crypto: Decluter the main doc page a bit.

master
Damir Jelić 2020-08-21 15:06:54 +02:00
parent e38bfc64f4
commit 002531349e
3 changed files with 19 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
matrix_sdk_crypto/src/lib.rs
View File

@ -30,8 +30,8 @@
mod device; mod device;
mod error; mod error;
mod machine; mod machine;
mod memory_stores; pub mod memory_stores;
mod olm; pub mod olm;
mod requests; mod requests;
mod store; mod store;
#[allow(dead_code)] #[allow(dead_code)]
@ -41,10 +41,9 @@ mod verification;
pub use device::{Device, LocalTrust, ReadOnlyDevice, UserDevices}; pub use device::{Device, LocalTrust, ReadOnlyDevice, UserDevices};
pub use error::{MegolmError, OlmError}; pub use error::{MegolmError, OlmError};
pub use machine::OlmMachine; pub use machine::OlmMachine;
pub use memory_stores::{DeviceStore, GroupSessionStore, ReadOnlyUserDevices, SessionStore}; use memory_stores::ReadOnlyUserDevices;
pub use olm::{ pub use olm::EncryptionSettings;
Account, EncryptionSettings, IdentityKeys, InboundGroupSession, OutboundGroupSession, Session, pub(crate) use olm::{Account, IdentityKeys, InboundGroupSession, Session};
};
pub use requests::{IncomingResponse, OutgoingRequest, OutgoingRequests}; pub use requests::{IncomingResponse, OutgoingRequest, OutgoingRequests};
#[cfg(feature = "sqlite_cryptostore")] #[cfg(feature = "sqlite_cryptostore")]
pub use store::sqlite::SqliteStore; pub use store::sqlite::SqliteStore;

5
matrix_sdk_crypto/src/memory_stores.rs
View File

@ -12,6 +12,11 @@
// See the License for the specific language governing permissions and // See the License for the specific language governing permissions and
// limitations under the License. // limitations under the License.
//! Collection of small in-memory stores that can be used to cache Olm objects.
//!
//! Note: You'll only be interested in these if you are implementing a custom
//! `CryptoStore`.
use std::{collections::HashMap, sync::Arc}; use std::{collections::HashMap, sync::Arc};
use dashmap::{DashMap, ReadOnlyView}; use dashmap::{DashMap, ReadOnlyView};

13
matrix_sdk_crypto/src/olm/mod.rs
View File

@ -12,15 +12,20 @@
// See the License for the specific language governing permissions and // See the License for the specific language governing permissions and
// limitations under the License. // limitations under the License.
//! The crypto specific Olm objects.
//!
//! Note: You'll only be interested in these if you are implementing a custom
//! `CryptoStore`.
mod account; mod account;
mod group_sessions; mod group_sessions;
mod session; mod session;
pub use account::{Account, IdentityKeys}; pub use account::{Account, IdentityKeys};
pub use group_sessions::{ pub use group_sessions::{EncryptionSettings, InboundGroupSession};
EncryptionSettings, GroupSessionKey, InboundGroupSession, OutboundGroupSession, pub(crate) use group_sessions::{GroupSessionKey, OutboundGroupSession};
}; pub(crate) use session::OlmMessage;
pub use session::{OlmMessage, Session}; pub use session::Session;
#[cfg(test)] #[cfg(test)]
pub(crate) mod test { pub(crate) mod test {