Skip to content

Commit

Permalink
fixup! docs: Document the Cipher struct
Browse files Browse the repository at this point in the history
  • Loading branch information
poljar committed Sep 20, 2024
1 parent d9e9a70 commit 0d52876
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion src/cipher/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,9 @@ impl Cipher {
Self { keys }
}

/// Creates a new [`Cipher`] from the given 32-byte raw key.
/// Creates a new [`Cipher`] from the given raw key. The key is expected to
/// be 32 bytes in length, but we expect an unsized slice for
/// compatibility with the libolm API.
///
/// The key is deterministically expanded into a 32-byte AES key, a 32-byte
/// MAC key, and a 16-byte initialization vector (IV) using HKDF, with
Expand Down

0 comments on commit 0d52876

Please sign in to comment.