zec
/
librustzcash
mirror of https://github.com/zcash/librustzcash.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

f4jumble: Document APIs that require feature flags

This commit is contained in:
Jack Grigg 2022-04-25 16:53:27 +00:00
parent b02d64a6ef
commit 32d6b57d71
2 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
components/f4jumble/Cargo.toml
View File

@ -13,6 +13,10 @@ readme = "README.md"
license = "MIT OR Apache-2.0"
edition = "2018"
[package.metadata.docs.rs]
all-features = true
rustdoc-args = ["--cfg", "docsrs"]
[dependencies]
blake2b_simd = { version = "1", default-features = false }

3
components/f4jumble/src/lib.rs
View File

@ -44,6 +44,7 @@
//! states.
#![no_std]
#![cfg_attr(docsrs, feature(doc_cfg))]
use blake2b_simd::{Params as Blake2bParams, OUTBYTES};
@ -264,6 +265,7 @@ pub fn f4jumble_inv_mut(message: &mut [u8]) -> Result<(), Error> {
/// );
/// ```
#[cfg(feature = "std")]
#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
pub fn f4jumble(message: &[u8]) -> Result<Vec<u8>, Error> {
let mut result = message.to_vec();
f4jumble_mut(&mut result).map(|()| result)
@ -290,6 +292,7 @@ pub fn f4jumble(message: &[u8]) -> Result<Vec<u8>, Error> {
/// assert_eq!(message_b, b"The package from Sarah arrives tomorrow morning.");
/// ```
#[cfg(feature = "std")]
#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
pub fn f4jumble_inv(message: &[u8]) -> Result<Vec<u8>, Error> {
let mut result = message.to_vec();
f4jumble_inv_mut(&mut result).map(|()| result)