From 15e8997052668453083108c7aa33f4ad28ccb1fd Mon Sep 17 00:00:00 2001
From: Steven Fackler <sfackler@gmail.com>
Date: Mon, 8 Aug 2016 23:31:25 -0700
Subject: [PATCH] Docs for Crypter::new

---
 openssl/src/crypto/symm.rs | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/openssl/src/crypto/symm.rs b/openssl/src/crypto/symm.rs
index ecb643f7..93764e4d 100644
--- a/openssl/src/crypto/symm.rs
+++ b/openssl/src/crypto/symm.rs
@@ -117,6 +117,12 @@ pub struct Crypter {
 }
 
 impl Crypter {
+    /// Creates a new `Crypter`.
+    ///
+    /// # Panics
+    ///
+    /// Panics if an IV is required by the cipher but not provided, or if the
+    /// IV's length does not match the expected length (see `Type::iv_len`).
     pub fn new(t: Type, mode: Mode, key: &[u8], iv: Option<&[u8]>) -> Result<Crypter, ErrorStack> {
         ffi::init();