Additional notes on Crypter

This commit is contained in:
Chiu Yue Chun 2017-10-04 00:28:32 +08:00
parent 76ecc13cec
commit ff53750cab
1 changed files with 4 additions and 2 deletions

View File

@ -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,