aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChiu Yue Chun <[email protected]>2017-10-04 00:28:32 +0800
committerChiu Yue Chun <[email protected]>2017-10-04 00:28:32 +0800
commitff53750cab6b6e20a3e681c3bf5ce0883d7102c9 (patch)
treea5998c62b93a165269fdc509504313fd933a5f83
parentCopy example to module level (diff)
downloadrust-openssl-ff53750cab6b6e20a3e681c3bf5ce0883d7102c9.tar.xz
rust-openssl-ff53750cab6b6e20a3e681c3bf5ce0883d7102c9.zip
Additional notes on Crypter
-rw-r--r--openssl/src/symm.rs6
1 files changed, 4 insertions, 2 deletions
diff --git a/openssl/src/symm.rs b/openssl/src/symm.rs
index ee1b0621..14ee392b 100644
--- a/openssl/src/symm.rs
+++ b/openssl/src/symm.rs
@@ -244,11 +244,13 @@ pub struct Crypter {
}
impl Crypter {
- /// Creates a new `Crypter`.
+ /// Creates a new `Crypter`. The initialisation vector, `iv`, is not necesarry for certain
+ /// types of `Cipher`.
///
/// # Panics
///
- /// Panics if an IV is required by the cipher but not provided.
+ /// Panics if an IV is required by the cipher but not provided. Also make sure that the key
+ /// and IV size are appropriate for your cipher.
pub fn new(
t: Cipher,
mode: Mode,