1 // Copyright 2013-2014 The Rust Project Developers.
2 // Copyright 2018 The Uuid Project Developers.
3 //
4 // See the COPYRIGHT file at the top-level directory of this distribution.
5 //
6 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
7 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
8 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
9 // option. This file may not be copied, modified, or distributed
10 // except according to those terms.
11 
12 //! The [`uuid`] prelude.
13 //!
14 //! This module contains the most important items of the [`uuid`] crate.
15 //!
16 //! To use the prelude, include the following in your crate root:
17 //!
18 //! ```rust
19 //! extern crate uuid;
20 //! ```
21 //!
22 //! and the following in every module:
23 //!
24 //! ```rust
25 //! use uuid::prelude::*;
26 //! ```
27 //!
28 //! # Prelude Contents
29 //!
30 //! Currently the prelude reexports the following:
31 //!
32 //! [`uuid`]`::{`[`Error`], [`Uuid`], [`Variant`], [`Version`],
33 //! builder::[`Builder`]`}`: The fundamental types used in [`uuid`] crate.
34 //!
35 //! [`uuid`]: ../index.html
36 //! [`Error`]: ../enum.Error.html
37 //! [`Uuid`]: ../struct.Uuid.html
38 //! [`Variant`]: ../enum.Variant.html
39 //! [`Version`]: ../enum.Version.html
40 //! [`Builder`]: ../builder/struct.Builder.html
41 //!
42 #![cfg_attr(feature = "v1",
43 doc = "
44 [`uuid::v1`]`::{`[`ClockSequence`],[`Context`]`}`: The types useful for
45 handling uuid version 1. Requires feature `v1`.
46 
47 [`uuid::v1`]: ../v1/index.html
48 [`Context`]: ../v1/struct.Context.html
49 [`ClockSequence`]: ../v1/trait.ClockSequence.html")]
50 
51 pub use super::{Builder, Bytes, Error, Uuid, Variant, Version};
52 #[cfg(feature = "v1")]
53 pub use v1::{ClockSequence, Context};
54