Merge branch 'master' into m2b-merger

src/lib.rs

@@ -8,7 +8,7 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
-//! Generate and parse UUIDs
+//! Generate and parse UUIDs.
 //!
 //! Provides support for Universally Unique Identifiers (UUIDs). A UUID is a
 //! unique 128-bit number, stored as 16 octets.  UUIDs are used to  assign
@@ -168,6 +168,8 @@ cfg_if! {
     }
 }
 
+pub mod prelude;
+
 cfg_if! {
     if #[cfg(feature = "serde")] {
         mod serde_support;

src/prelude.rs

@@ -0,0 +1,32 @@
+//! The [`uuid`] prelude.
+//!
+//! This module contains the most important items of the [`uuid`] crate.
+//!
+//! To use the prelude, include the following in your crate root:
+//!
+//! ```rust
+//! extern crate uuid;
+//! ```
+//!
+//! and the following in every module:
+//!
+//! ```rust
+//! use uuid::prelude::*;
+//! ```
+//!
+//! # Prelude Contents
+//!
+//! Currently the prelude reexports the following:
+//!
+//! ## The core types
+//!
+//! [`uuid`]`::{`[`ParseError`], [`Uuid`], [`UuidVariant`]`}`: The fundamental
+//! types used in [`uuid`] crate.
+//!
+//! [`uuid`]: ../index.html
+//! [`ParseError`]: ../enum.ParseError.html
+//! [`Uuid`]: ../struct.Uuid.html
+//! [`UuidVariant`]: enum.UuidVariant.html
+
+#[doc(inline)]
+pub use super::{ParseError, Uuid, UuidVariant};