src/libstd/lib.rs

   1 // Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 //! # The Rust Standard Library
  12 //!
  13 //! The Rust Standard Library provides the essential runtime
  14 //! functionality for building portable Rust software.
  15 //! It is linked to all Rust crates by default.
  16 //!
  17 //! ## Intrinsic types and operations
  18 //!
  19 //! The [`ptr`](ptr/index.html) and [`mem`](mem/index.html)
  20 //! modules deal with unsafe pointers and memory manipulation.
  21 //! [`markers`](markers/index.html) defines the special built-in traits,
  22 //! and [`raw`](raw/index.html) the runtime representation of Rust types.
  23 //! These are some of the lowest-level building blocks in Rust.
  24 //!
  25 //! ## Math on primitive types and math traits
  26 //!
  27 //! Although basic operations on primitive types are implemented
  28 //! directly by the compiler, the standard library additionally
  29 //! defines many common operations through traits defined in
  30 //! mod [`num`](num/index.html).
  31 //!
  32 //! ## Pervasive types
  33 //!
  34 //! The [`option`](option/index.html) and [`result`](result/index.html)
  35 //! modules define optional and error-handling types, `Option` and `Result`.
  36 //! [`iter`](iter/index.html) defines Rust's iterator protocol
  37 //! along with a wide variety of iterators.
  38 //! [`Cell` and `RefCell`](cell/index.html) are for creating types that
  39 //! manage their own mutability.
  40 //!
  41 //! ## Vectors, slices and strings
  42 //!
  43 //! The common container type, `Vec`, a growable vector backed by an
  44 //! array, lives in the [`vec`](vec/index.html) module. References to
  45 //! arrays, `&[T]`, more commonly called "slices", are built-in types
  46 //! for which the [`slice`](slice/index.html) module defines many
  47 //! methods.
  48 //!
  49 //! `&str`, a UTF-8 string, is a built-in type, and the standard library
  50 //! defines methods for it on a variety of traits in the
  51 //! [`str`](str/index.html) module. Rust strings are immutable;
  52 //! use the `String` type defined in [`string`](string/index.html)
  53 //! for a mutable string builder.
  54 //!
  55 //! For converting to strings use the [`format!`](fmt/index.html)
  56 //! macro, and for converting from strings use the
  57 //! [`FromStr`](str/trait.FromStr.html) trait.
  58 //!
  59 //! ## Platform abstractions
  60 //!
  61 //! Besides basic data types, the standard library is largely concerned
  62 //! with abstracting over differences in common platforms, most notably
  63 //! Windows and Unix derivatives. The [`os`](os/index.html) module
  64 //! provides a number of basic functions for interacting with the
  65 //! operating environment, including program arguments, environment
  66 //! variables, and directory navigation. The [`path`](path/index.html)
  67 //! module encapsulates the platform-specific rules for dealing
  68 //! with file paths.
  69 //!
  70 //! `std` also includes modules for interoperating with the
  71 //! C language: [`c_str`](c_str/index.html) and
  72 //! [`c_vec`](c_vec/index.html).
  73 //!
  74 //! ## Concurrency, I/O, and the runtime
  75 //!
  76 //! The [`task`](task/index.html) module contains Rust's threading abstractions,
  77 //! while [`comm`](comm/index.html) contains the channel types for message
  78 //! passing. [`sync`](sync/index.html) contains further, primitive, shared
  79 //! memory types, including [`atomic`](sync/atomic/index.html).
  80 //!
  81 //! Common types of I/O, including files, TCP, UDP, pipes, Unix domain sockets,
  82 //! timers, and process spawning, are defined in the [`io`](io/index.html) module.
  83 //!
  84 //! Rust's I/O and concurrency depends on a small runtime interface
  85 //! that lives, along with its support code, in mod [`rt`](rt/index.html).
  86 //! While a notable part of the standard library's architecture, this
  87 //! module is not intended for public use.
  88 //!
  89 //! ## The Rust prelude and macros
  90 //!
  91 //! Finally, the [`prelude`](prelude/index.html) defines a
  92 //! common set of traits, types, and functions that are made available
  93 //! to all code by default. [`macros`](macros/index.html) contains
  94 //! all the standard macros, such as `assert!`, `panic!`, `println!`,
  95 //! and `format!`, also available to all Rust code.
  96
  97 #![crate_name = "std"]
  98 #![stable]
  99 #![crate_type = "rlib"]
 100 #![crate_type = "dylib"]
 101 #![doc(html_logo_url = "http://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
 102        html_favicon_url = "http://www.rust-lang.org/favicon.ico",
 103        html_root_url = "http://doc.rust-lang.org/nightly/",
 104        html_playground_url = "http://play.rust-lang.org/")]
 105
 106 #![allow(unknown_features)]
 107 #![feature(linkage, thread_local, asm)]
 108 #![feature(lang_items, unsafe_destructor)]
 109 #![feature(slicing_syntax, unboxed_closures)]
 110 #![feature(old_impl_check)]
 111
 112 // Don't link to std. We are std.
 113 #![no_std]
 114
 115 #![deny(missing_docs)]
 116
 117 #[cfg(test)]
 118 #[macro_use]
 119 extern crate log;
 120
 121 #[macro_use]
 122 #[macro_reexport(assert, assert_eq, debug_assert, debug_assert_eq,
 123                  unreachable, unimplemented, write, writeln)]
 124 extern crate core;
 125
 126 #[macro_use]
 127 #[macro_reexport(vec)]
 128 extern crate "collections" as core_collections;
 129
 130 extern crate "rand" as core_rand;
 131 extern crate alloc;
 132 extern crate unicode;
 133 extern crate libc;
 134
 135 // Make std testable by not duplicating lang items. See #2912
 136 #[cfg(test)] extern crate "std" as realstd;
 137 #[cfg(test)] pub use realstd::marker;
 138 #[cfg(test)] pub use realstd::ops;
 139 #[cfg(test)] pub use realstd::cmp;
 140 #[cfg(test)] pub use realstd::boxed;
 141
 142
 143 // NB: These reexports are in the order they should be listed in rustdoc
 144
 145 pub use core::any;
 146 pub use core::borrow;
 147 pub use core::cell;
 148 pub use core::clone;
 149 #[cfg(not(test))] pub use core::cmp;
 150 pub use core::default;
 151 pub use core::finally;
 152 pub use core::intrinsics;
 153 pub use core::iter;
 154 #[cfg(not(test))] pub use core::marker;
 155 pub use core::mem;
 156 #[cfg(not(test))] pub use core::ops;
 157 pub use core::ptr;
 158 pub use core::raw;
 159 pub use core::simd;
 160 pub use core::result;
 161 pub use core::option;
 162
 163 #[cfg(not(test))] pub use alloc::boxed;
 164 pub use alloc::rc;
 165
 166 pub use core_collections::slice;
 167 pub use core_collections::str;
 168 pub use core_collections::string;
 169 #[stable]
 170 pub use core_collections::vec;
 171
 172 pub use unicode::char;
 173
 174 /* Exported macros */
 175
 176 #[macro_use]
 177 pub mod macros;
 178
 179 #[macro_use]
 180 pub mod bitflags;
 181
 182 mod rtdeps;
 183
 184 /* The Prelude. */
 185
 186 pub mod prelude;
 187
 188
 189 /* Primitive types */
 190
 191 #[path = "num/float_macros.rs"]
 192 #[macro_use]
 193 mod float_macros;
 194
 195 #[path = "num/int_macros.rs"]
 196 #[macro_use]
 197 mod int_macros;
 198
 199 #[path = "num/uint_macros.rs"]
 200 #[macro_use]
 201 mod uint_macros;
 202
 203 #[path = "num/int.rs"]  pub mod int;
 204 #[path = "num/i8.rs"]   pub mod i8;
 205 #[path = "num/i16.rs"]  pub mod i16;
 206 #[path = "num/i32.rs"]  pub mod i32;
 207 #[path = "num/i64.rs"]  pub mod i64;
 208
 209 #[path = "num/uint.rs"] pub mod uint;
 210 #[path = "num/u8.rs"]   pub mod u8;
 211 #[path = "num/u16.rs"]  pub mod u16;
 212 #[path = "num/u32.rs"]  pub mod u32;
 213 #[path = "num/u64.rs"]  pub mod u64;
 214
 215 #[path = "num/f32.rs"]   pub mod f32;
 216 #[path = "num/f64.rs"]   pub mod f64;
 217
 218 pub mod ascii;
 219 pub mod thunk;
 220
 221 /* Common traits */
 222
 223 pub mod error;
 224 pub mod num;
 225
 226 /* Runtime and platform support */
 227
 228 #[macro_use]
 229 pub mod thread_local;
 230
 231 pub mod dynamic_lib;
 232 pub mod ffi;
 233 pub mod fmt;
 234 pub mod io;
 235 pub mod os;
 236 pub mod path;
 237 pub mod rand;
 238 pub mod time;
 239
 240 /* Common data structures */
 241
 242 pub mod collections;
 243 pub mod hash;
 244
 245 /* Threads and communication */
 246
 247 pub mod thread;
 248 pub mod sync;
 249
 250 #[cfg(unix)]
 251 #[path = "sys/unix/mod.rs"] mod sys;
 252 #[cfg(windows)]
 253 #[path = "sys/windows/mod.rs"] mod sys;
 254
 255 #[path = "sys/common/mod.rs"] mod sys_common;
 256
 257 pub mod rt;
 258 mod failure;
 259
 260 // Documentation for primitive types
 261
 262 mod bool;
 263 mod unit;
 264 mod tuple;
 265
 266 // A curious inner-module that's not exported that contains the binding
 267 // 'std' so that macro-expanded references to std::error and such
 268 // can be resolved within libstd.
 269 #[doc(hidden)]
 270 mod std {
 271     // mods used for deriving
 272     pub use clone;
 273     pub use cmp;
 274     pub use hash;
 275
 276     pub use sync; // used for select!()
 277     pub use error; // used for try!()
 278     pub use fmt; // used for any formatting strings
 279     pub use io; // used for println!()
 280     pub use option; // used for bitflags!{}
 281     pub use rt; // used for panic!()
 282     pub use vec; // used for vec![]
 283     pub use cell; // used for tls!
 284     pub use thread_local; // used for thread_local!
 285     pub use marker;  // used for tls!
 286     pub use ops; // used for bitflags!
 287
 288     // The test runner calls ::std::os::args() but really wants realstd
 289     #[cfg(test)] pub use realstd::os as os;
 290     // The test runner requires std::slice::Vector, so re-export std::slice just for it.
 291     //
 292     // It is also used in vec![]
 293     pub use slice;
 294
 295     pub use boxed; // used for vec![]
 296
 297 }