📝 Add feature flags for docs.rs in documentation

Author: Absolucy

Cargo.toml

@@ -36,12 +36,12 @@ getrandom = { version = "0.2", optional = true, features = ["rdrand"] }
 [target.'cfg(not(any(target_arch = "wasm32", target_arch = "x86", target_arch = "x86_64")))'.dependencies]
 getrandom = { version = "0.2", optional = true }
 
-
 [dev-dependencies]
 hex = "0.4.3"
 
 [package.metadata.docs.rs]
 all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
 default-target = "x86_64-unknown-linux-gnu"
 targets = ["x86_64-pc-windows-msvc"]
 

src/buffer.rs

@@ -72,6 +72,7 @@ impl<InternalGenerator: Rng<OUTPUT>, const OUTPUT: usize> Rng<OUTPUT>
 }
 
 #[cfg(feature = "std")]
+#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
 impl<InternalGenerator: Rng<OUTPUT>, const OUTPUT: usize> std::io::Read
 	for BufferedRng<InternalGenerator, OUTPUT>
 {

src/entropy.rs

@@ -1,4 +1,5 @@
 #[cfg(feature = "getrandom_custom")]
+#[cfg_attr(docsrs, doc(cfg(feature = "getrandom_custom")))]
 pub use getrandom::register_custom_getrandom;
 
 #[cfg(all(target_vendor = "apple", not(feature = "getrandom")))]

src/lib.rs

@@ -1,4 +1,5 @@
 #![cfg_attr(not(feature = "std"), no_std)]
+#![cfg_attr(docsrs, feature(doc_cfg))]
 #![forbid(missing_docs)]
 #![warn(
 	clippy::perf,
@@ -107,6 +108,7 @@ pub use rand::*;
 pub use tls::tls_rng;
 
 #[cfg(feature = "alloc")]
+#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
 /// Provides a buffered wrapper for RNGs, preventing bits from being wasted.
 pub mod buffer;
 /// Implementation of cryptography, for CSPRNGs.
@@ -118,5 +120,6 @@ pub mod gen;
 /// RNG algorithms.
 pub mod rand;
 #[cfg(feature = "tls")]
+#[cfg_attr(docsrs, doc(cfg(feature = "tls")))]
 /// Provides a thread-local [`WyRand`] RNG.
 pub mod tls;

src/rand.rs

@@ -11,16 +11,19 @@ use core::ops::RangeBounds;
 /// Implementation of the wyrand PRNG algorithm.
 /// More details can be seen at <https://github.com/wangyi-fudan/wyhash>
 #[cfg(feature = "wyrand")]
+#[cfg_attr(docsrs, doc(cfg(feature = "wyrand")))]
 pub mod wyrand;
 
 /// Implementation of the Pcg64 PRNG algorithm.
 /// More details can be seen at <https://www.pcg-random.org/index.html>
 #[cfg(feature = "pcg64")]
+#[cfg_attr(docsrs, doc(cfg(feature = "pcg64")))]
 pub mod pcg64;
 
 /// Implementation of the ChaCha CSPRNG algorithm.
 /// More details can be seen at <https://en.wikipedia.org/wiki/Salsa20>
 #[cfg(feature = "chacha")]
+#[cfg_attr(docsrs, doc(cfg(feature = "chacha")))]
 pub mod chacha;
 
 /// A trait that represents a random number generator.

src/rand/chacha.rs

@@ -20,6 +20,7 @@ pub type ChaCha20 = ChaCha<20>;
 /// **This generator _is theoretically_ cryptographically secure.**
 #[cfg_attr(feature = "zeroize", derive(Zeroize))]
 #[cfg_attr(feature = "zeroize", zeroize(drop))]
+#[cfg_attr(docsrs, doc(cfg(feature = "chacha")))]
 pub struct ChaCha<const ROUNDS: u8> {
 	state: [u32; 16],
 }

src/rand/pcg64.rs

@@ -12,6 +12,7 @@ const PCG_DEFAULT_MULTIPLIER_128: u128 = 47026247687942121848144207491837523525;
 /// **This generator is _NOT_ cryptographically secure.**
 #[cfg_attr(feature = "zeroize", derive(Zeroize))]
 #[cfg_attr(feature = "zeroize", zeroize(drop))]
+#[cfg_attr(docsrs, doc(cfg(feature = "pcg64")))]
 pub struct Pcg64 {
 	seed: u128,
 	state: u128,

src/rand/wyrand.rs

@@ -10,6 +10,7 @@ use zeroize::Zeroize;
 /// **This generator is _NOT_ cryptographically secure.**
 #[cfg_attr(feature = "zeroize", derive(Zeroize))]
 #[cfg_attr(feature = "zeroize", zeroize(drop))]
+#[cfg_attr(docsrs, doc(cfg(feature = "wyrand")))]
 pub struct WyRand {
 	seed: u64,
 }

src/tls.rs

@@ -37,6 +37,7 @@ impl SeedableRng<8, 8> for TlsWyRand {
 ///     println!("Random number: {}", rng.generate::<u64>());
 /// });
 /// ```
+#[cfg_attr(docsrs, doc(cfg(feature = "tls")))]
 pub fn tls_rng() -> TlsWyRand {
 	WYRAND.with(|tls| TlsWyRand(tls.clone()))
 }