Skip to content

Commit

Permalink
Doc: add note about no gen_rand_key and default API in no_std
Browse files Browse the repository at this point in the history
  • Loading branch information
brycx committed Aug 30, 2018
1 parent f2b5640 commit a8226a3
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 1 deletion.
2 changes: 1 addition & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ extern crate tiny_keccak;
pub mod utilities;

#[cfg(feature="safe_api")]
/// High-level API with safer defaults. Includes HMAC, HKDF, PBKDF2 and cSHAKE.
/// High-level API with safer defaults. Not available in `no_std` context.
pub mod default;

/// Low-level API.
Expand Down
1 change: 1 addition & 0 deletions src/utilities/util.rs
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ use utilities::errors;
#[cfg(feature="safe_api")]
/// Fill `dst` with random bytes. This uses rand's
/// [OsRng](https://docs.rs/rand/0.5.1/rand/rngs/struct.OsRng.html). Length of `dst` must be >= 1.
/// Not available in `no_std` context.
pub fn gen_rand_key(dst: &mut [u8]) -> Result<(), errors::UnknownCryptoError> {
if dst.is_empty() {
return Err(errors::UnknownCryptoError);
Expand Down

0 comments on commit a8226a3

Please sign in to comment.