summaryrefslogtreecommitdiffstats
path: root/openpgp/src/crypto/asymmetric.rs
diff options
context:
space:
mode:
Diffstat (limited to 'openpgp/src/crypto/asymmetric.rs')
-rw-r--r--openpgp/src/crypto/asymmetric.rs6
1 files changed, 6 insertions, 0 deletions
diff --git a/openpgp/src/crypto/asymmetric.rs b/openpgp/src/crypto/asymmetric.rs
index 51d95934..b779176a 100644
--- a/openpgp/src/crypto/asymmetric.rs
+++ b/openpgp/src/crypto/asymmetric.rs
@@ -25,6 +25,12 @@ pub trait Signer {
}
/// A cryptographic key pair.
+///
+/// A `KeyPair` is a combination of public and secret key. If both
+/// are available in memory, a `KeyPair` is a convenient
+/// implementation of [`Signer`].
+///
+/// [`Signer`]: trait.Signer.html
pub struct KeyPair {
public: Key,
secret: mpis::SecretKey,