diff options
| -rw-r--r-- | openpgp/src/crypto/mod.rs | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/openpgp/src/crypto/mod.rs b/openpgp/src/crypto/mod.rs index 856fc6a7..c4ea6ab8 100644 --- a/openpgp/src/crypto/mod.rs +++ b/openpgp/src/crypto/mod.rs @@ -1,4 +1,21 @@ //! Cryptographic primitives. +//! +//! This module contains cryptographic primitives as defined and used +//! by OpenPGP. It abstracts over the cryptographic library chosen at +//! compile time. Most of the time, it will not be necessary to +//! explicitly use types from this module directly, but they are used +//! in the API (e.g. [`Password`]). Advanced users may use these +//! primitives to provide custom extensions to OpenPGP. +//! +//! [`Password`]: struct.Password.html +//! +//! # Common Operations +//! +//! - *Converting a string to a `Password`*: Use [`Password::from`]. +//! - *Create a session key*: Use [`SessionKey::new`]. +//! +//! [`Password::from`]: https://doc.rust-lang.org/std/convert/trait.From.html +//! [`SessionKey::new`]: struct.SessionKey.html#method.new use std::io::Read; use std::ops::{Deref, DerefMut}; |