summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJustus Winter <justus@sequoia-pgp.org>2019-06-28 17:08:11 +0200
committerJustus Winter <justus@sequoia-pgp.org>2019-06-28 18:26:04 +0200
commit68cbc05fc9a7233a1d1a1e1590e1058a06c5ad3e (patch)
treedb0723be9f09d1d3818514dfd695f08223bbfb59
parent09c8dfc78c278eacbb986c12a189826e94e68c22 (diff)
openpgp: Fix documentation.
-rw-r--r--openpgp/src/crypto/mem.rs5
1 files changed, 3 insertions, 2 deletions
diff --git a/openpgp/src/crypto/mem.rs b/openpgp/src/crypto/mem.rs
index 45447719..23b8f146 100644
--- a/openpgp/src/crypto/mem.rs
+++ b/openpgp/src/crypto/mem.rs
@@ -7,9 +7,10 @@ use std::pin::Pin;
use memsec;
-/// Holds a session key.
+/// Protected memory.
///
-/// The session key is cleared when dropped.
+/// The memory is guaranteed not to be copied around, and is cleared
+/// when the object is dropped.
#[derive(Clone, Eq, Hash)]
pub struct Protected(Pin<Box<[u8]>>);