Clean up public exports in documentation

Mostly just hide, to avoid API breakage.

Author: pitdicker

benches/generators.rs

@@ -10,10 +10,10 @@ use std::mem::size_of;
 use test::{black_box, Bencher};
 
 use rand::{RngCore, Rng, SeedableRng, NewRng};
-use rand::{StdRng, SmallRng, OsRng, JitterRng, EntropyRng};
-use rand::{XorShiftRng, Hc128Rng, IsaacRng, Isaac64Rng, ChaChaRng};
-use rand::reseeding::ReseedingRng;
+use rand::{StdRng, SmallRng, OsRng, EntropyRng, ReseedingRng};
+use rand::prng::{XorShiftRng, Hc128Rng, IsaacRng, Isaac64Rng, ChaChaRng};
 use rand::prng::hc128::Hc128Core;
+use rand::jitter::JitterRng;
 use rand::thread_rng;
 
 macro_rules! gen_bytes {

src/entropy_rng.rs

@@ -11,7 +11,8 @@
 //! Entropy generator, or wrapper around external generators
 
 use rand_core::{RngCore, CryptoRng, Error, impls};
-use {OsRng, JitterRng};
+use os::OsRng;
+use jitter::JitterRng;
 
 /// A generator provided specifically for securely seeding algorithmic
 /// generators (PRNGs).

src/jitter.rs

@@ -203,7 +203,7 @@ impl JitterRng {
     ///
     /// ```rust
     /// # use rand::{Rng, Error};
-    /// use rand::JitterRng;
+    /// use rand::jitter::JitterRng;
     ///
     /// # fn try_inner() -> Result<(), Error> {
     /// fn get_nstime() -> u64 {
@@ -682,7 +682,7 @@ impl JitterRng {
     /// for the available entropy.
     ///
     /// ```rust,no_run
-    /// use rand::JitterRng;
+    /// use rand::jitter::JitterRng;
     /// #
     /// # use std::error::Error;
     /// # use std::fs::File;
@@ -816,7 +816,7 @@ impl CryptoRng for JitterRng {}
 
 #[cfg(test)]
 mod test_jitter_init {
-    use JitterRng;
+    use jitter::JitterRng;
 
     #[cfg(feature="std")]
     #[test]

src/lib.rs

@@ -213,53 +213,55 @@ extern crate rand_core;
 #[cfg(all(feature="std", not(feature = "log")))] macro_rules! error { ($($x:tt)*) => () }
 
 
-use core::{marker, mem, slice};
-
-// re-exports from rand_core
+// Re-exports from rand_core
 pub use rand_core::{RngCore, BlockRngCore, CryptoRng, SeedableRng};
 pub use rand_core::{ErrorKind, Error};
 
-// external rngs
-#[doc(inline)] pub use jitter::JitterRng;
-#[cfg(feature="std")] #[doc(inline)] pub use os::OsRng;
-
-// pseudo rngs
-pub mod prng;
-#[doc(no_inline)]
-pub use prng::{ChaChaRng, Hc128Rng, IsaacRng, Isaac64Rng, XorShiftRng};
-
-// convenience and derived rngs
+// Public exports
 #[cfg(feature="std")] pub use entropy_rng::EntropyRng;
+#[cfg(feature="std")] pub use os::OsRng;
+#[cfg(feature="std")] pub use read::ReadRng;
+pub use reseeding::ReseedingRng;
 #[cfg(feature="std")] pub use thread_rng::{ThreadRng, thread_rng};
 #[cfg(feature="std")] #[allow(deprecated)] pub use thread_rng::random;
 
-use distributions::{Distribution, Uniform, Range};
-use distributions::range::SampleRange;
-
-// public modules
+// Public modules
 pub mod distributions;
-pub mod jitter;
-pub mod mock;
-#[cfg(feature="std")] pub mod os;
-#[cfg(feature="std")] pub mod read;
-pub mod reseeding;
+pub mod jitter; // Public because of the error type.
+pub mod mock;   // Public so we don't export `StepRng` directly, making it a bit
+                // more clear it is intended for testing.
+pub mod prng;
 #[cfg(feature = "alloc")] pub mod seq;
 
-// These tiny modules are here to avoid API breakage, probably only temporarily
+// These modules are public to avoid API breakage, probably only temporarily.
+// Hidden in the documentation.
+#[cfg(feature="std")] #[doc(hidden)] pub mod os;
+#[cfg(feature="std")] #[doc(hidden)] pub mod read;
+#[doc(hidden)] pub use prng::{ChaChaRng, IsaacRng, Isaac64Rng, XorShiftRng};
+#[doc(hidden)]
 pub mod chacha {
     //! The ChaCha random number generator.
     pub use prng::ChaChaRng;
 }
+#[doc(hidden)]
 pub mod isaac {
     //! The ISAAC random number generator.
     pub use prng::{IsaacRng, Isaac64Rng};
 }
 
 // private modules
 #[cfg(feature="std")] mod entropy_rng;
+mod reseeding;
 #[cfg(feature="std")] mod thread_rng;
 
 
+// Normal imports just for this file
+use core::{marker, mem, slice};
+use distributions::{Distribution, Uniform, Range};
+use distributions::range::SampleRange;
+use prng::hc128::Hc128Rng;
+
+
 /// A type that can be randomly generated using an [`Rng`].
 /// 
 /// This is merely an adaptor around the [`Uniform`] distribution for

src/prng/mod.rs

@@ -49,8 +49,8 @@ mod xorshift;
 #[cfg(feature="serde-1")]
 mod isaac_serde;
 
-pub use self::chacha::ChaChaRng;
-pub use self::hc128::Hc128Rng;
+#[doc(inline)] pub use self::chacha::ChaChaRng;
+#[doc(inline)] pub use self::hc128::Hc128Rng;
 pub use self::isaac::IsaacRng;
 pub use self::isaac64::Isaac64Rng;
 pub use self::xorshift::XorShiftRng;

src/read.rs

@@ -15,8 +15,9 @@ use std::io::Read;
 use rand_core::{RngCore, Error, ErrorKind, impls};
 
 
-/// An RNG that reads random bytes straight from a `Read`. This will
-/// work best with an infinite reader, but that is not required.
+/// An RNG that reads random bytes straight from a `Read`.
+///
+/// This will work best with an infinite reader, but that is not required.
 ///
 /// # Panics
 ///