1b42e890bf
This commit modifies rustdoc to not require these empty modules to be public in the standard library. The modules still remain as a location to attach documentation to, but the modules themselves are now private (don't have to commit to an API). The documentation for the standard library now shows all of the primitive types on the main index page.
98 lines
4.3 KiB
Rust
98 lines
4.3 KiB
Rust
// Copyright 2013 The Rust Project Developers. See the COPYRIGHT
|
|
// file at the top-level directory of this distribution and at
|
|
// http://rust-lang.org/COPYRIGHT.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
|
|
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
|
|
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
|
|
// option. This file may not be copied, modified, or distributed
|
|
// except according to those terms.
|
|
|
|
//! The Rust prelude
|
|
//!
|
|
//! Because `std` is required by most serious Rust software, it is
|
|
//! imported at the topmost level of every crate by default, as if the
|
|
//! first line of each crate was
|
|
//!
|
|
//! ```ignore
|
|
//! extern crate std;
|
|
//! ```
|
|
//!
|
|
//! This means that the contents of std can be accessed from any context
|
|
//! with the `std::` path prefix, as in `use std::vec`, `use std::task::spawn`,
|
|
//! etc.
|
|
//!
|
|
//! Additionally, `std` contains a `prelude` module that reexports many of the
|
|
//! most common traits, types and functions. The contents of the prelude are
|
|
//! imported into every *module* by default. Implicitly, all modules behave as if
|
|
//! they contained the following prologue:
|
|
//!
|
|
//! ```ignore
|
|
//! use std::prelude::*;
|
|
//! ```
|
|
//!
|
|
//! The prelude is primarily concerned with exporting *traits* that are so
|
|
//! pervasive that it would be obnoxious to import for every use, particularly
|
|
//! those that define methods on primitive types. It does include a few
|
|
//! particularly useful standalone functions, like `from_str`, `range`, and
|
|
//! `drop`, `spawn`, and `channel`.
|
|
|
|
#![experimental]
|
|
|
|
// Reexported core operators
|
|
#[doc(no_inline)] pub use kinds::{Copy, Send, Sized, Sync};
|
|
#[doc(no_inline)] pub use ops::{Add, Sub, Mul, Div, Rem, Neg, Not};
|
|
#[doc(no_inline)] pub use ops::{BitAnd, BitOr, BitXor};
|
|
#[doc(no_inline)] pub use ops::{Drop, Deref, DerefMut};
|
|
#[doc(no_inline)] pub use ops::{Shl, Shr};
|
|
#[doc(no_inline)] pub use ops::{Index, IndexMut};
|
|
#[doc(no_inline)] pub use ops::{Slice, SliceMut};
|
|
#[doc(no_inline)] pub use ops::{Fn, FnMut, FnOnce};
|
|
|
|
// Reexported functions
|
|
#[doc(no_inline)] pub use iter::range;
|
|
#[doc(no_inline)] pub use mem::drop;
|
|
#[doc(no_inline)] pub use str::from_str;
|
|
|
|
// Reexported types and traits
|
|
|
|
#[doc(no_inline)] pub use ascii::{Ascii, AsciiCast, OwnedAsciiCast, AsciiStr};
|
|
#[doc(no_inline)] pub use ascii::IntoBytes;
|
|
#[doc(no_inline)] pub use borrow::IntoCow;
|
|
#[doc(no_inline)] pub use c_str::ToCStr;
|
|
#[doc(no_inline)] pub use char::{Char, UnicodeChar};
|
|
#[doc(no_inline)] pub use clone::Clone;
|
|
#[doc(no_inline)] pub use cmp::{PartialEq, PartialOrd, Eq, Ord};
|
|
#[doc(no_inline)] pub use cmp::{Ordering, Equiv};
|
|
#[doc(no_inline)] pub use cmp::Ordering::{Less, Equal, Greater};
|
|
#[doc(no_inline)] pub use iter::{FromIterator, Extend, ExactSizeIterator};
|
|
#[doc(no_inline)] pub use iter::{Iterator, IteratorExt, DoubleEndedIterator};
|
|
#[doc(no_inline)] pub use iter::{DoubleEndedIteratorExt, CloneIteratorExt};
|
|
#[doc(no_inline)] pub use iter::{RandomAccessIterator, IteratorCloneExt};
|
|
#[doc(no_inline)] pub use iter::{IteratorOrdExt, MutableDoubleEndedIterator};
|
|
#[doc(no_inline)] pub use num::{ToPrimitive, FromPrimitive};
|
|
#[doc(no_inline)] pub use boxed::Box;
|
|
#[doc(no_inline)] pub use option::Option;
|
|
#[doc(no_inline)] pub use option::Option::{Some, None};
|
|
#[doc(no_inline)] pub use path::{GenericPath, Path, PosixPath, WindowsPath};
|
|
#[doc(no_inline)] pub use ptr::{RawPtr, RawMutPtr};
|
|
#[doc(no_inline)] pub use result::Result;
|
|
#[doc(no_inline)] pub use result::Result::{Ok, Err};
|
|
#[doc(no_inline)] pub use io::{Buffer, Writer, Reader, Seek, BufferPrelude};
|
|
#[doc(no_inline)] pub use str::{Str, StrVector, StrPrelude};
|
|
#[doc(no_inline)] pub use str::{StrAllocating, UnicodeStrPrelude};
|
|
#[doc(no_inline)] pub use core::prelude::{Tuple1, Tuple2, Tuple3, Tuple4};
|
|
#[doc(no_inline)] pub use core::prelude::{Tuple5, Tuple6, Tuple7, Tuple8};
|
|
#[doc(no_inline)] pub use core::prelude::{Tuple9, Tuple10, Tuple11, Tuple12};
|
|
#[doc(no_inline)] pub use slice::AsSlice;
|
|
#[doc(no_inline)] pub use slice::{VectorVector, PartialEqSliceExt};
|
|
#[doc(no_inline)] pub use slice::{CloneSliceExt, OrdSliceExt, SliceExt};
|
|
#[doc(no_inline)] pub use slice::{BoxedSliceExt};
|
|
#[doc(no_inline)] pub use string::{IntoString, String, ToString};
|
|
#[doc(no_inline)] pub use vec::Vec;
|
|
|
|
// Reexported runtime types
|
|
#[doc(no_inline)] pub use comm::{sync_channel, channel};
|
|
#[doc(no_inline)] pub use comm::{SyncSender, Sender, Receiver};
|
|
#[doc(no_inline)] pub use task::spawn;
|