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 //! [`marker`](marker/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 [`thread`](thread/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
  83 //! [`old_io`](old_io/index.html) module.
  84 //!
  85 //! Rust's I/O and concurrency depends on a small runtime interface
  86 //! that lives, along with its support code, in mod [`rt`](rt/index.html).
  87 //! While a notable part of the standard library's architecture, this
  88 //! module is not intended for public use.
  89 //!
  90 //! ## The Rust prelude and macros
  91 //!
  92 //! Finally, the [`prelude`](prelude/index.html) defines a
  93 //! common set of traits, types, and functions that are made available
  94 //! to all code by default. [`macros`](macros/index.html) contains
  95 //! all the standard macros, such as `assert!`, `panic!`, `println!`,
  96 //! and `format!`, also available to all Rust code.
  97
  98 #![crate_name = "std"]
  99 #![stable(feature = "rust1", since = "1.0.0")]
 100 #![staged_api]
 101 #![crate_type = "rlib"]
 102 #![crate_type = "dylib"]
 103 #![doc(html_logo_url = "http://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
 104        html_favicon_url = "http://www.rust-lang.org/favicon.ico",
 105        html_root_url = "http://doc.rust-lang.org/nightly/",
 106        html_playground_url = "http://play.rust-lang.org/")]
 107
 108 #![feature(alloc)]
 109 #![feature(box_syntax)]
 110 #![feature(collections)]
 111 #![feature(core)]
 112 #![feature(hash)]
 113 #![feature(int_uint)]
 114 #![feature(lang_items, unsafe_destructor)]
 115 #![feature(libc)]
 116 #![feature(linkage, thread_local, asm)]
 117 #![feature(old_impl_check)]
 118 #![feature(optin_builtin_traits)]
 119 #![feature(rand)]
 120 #![feature(staged_api)]
 121 #![feature(unboxed_closures)]
 122 #![feature(unicode)]
 123 #![feature(macro_reexport)]
 124 #![cfg_attr(test, feature(test))]
 125
 126 // Don't link to std. We are std.
 127 #![no_std]
 128
 129 #![deny(missing_docs)]
 130
 131 #[cfg(test)]
 132 #[macro_use]
 133 extern crate log;
 134
 135 #[macro_use]
 136 #[macro_reexport(assert, assert_eq, debug_assert, debug_assert_eq,
 137     unreachable, unimplemented, write, writeln)]
 138 extern crate core;
 139
 140 #[macro_use]
 141 #[macro_reexport(vec)]
 142 extern crate "collections" as core_collections;
 143
 144 extern crate "rand" as core_rand;
 145 extern crate alloc;
 146 extern crate unicode;
 147 extern crate libc;
 148
 149 #[macro_use] #[no_link] extern crate rustc_bitflags;
 150
 151 // Make std testable by not duplicating lang items. See #2912
 152 #[cfg(test)] extern crate "std" as realstd;
 153 #[cfg(test)] pub use realstd::marker;
 154 #[cfg(test)] pub use realstd::ops;
 155 #[cfg(test)] pub use realstd::cmp;
 156 #[cfg(test)] pub use realstd::boxed;
 157
 158
 159 // NB: These reexports are in the order they should be listed in rustdoc
 160
 161 pub use core::any;
 162 pub use core::borrow;
 163 pub use core::cell;
 164 pub use core::clone;
 165 #[cfg(not(test))] pub use core::cmp;
 166 pub use core::default;
 167 pub use core::finally;
 168 pub use core::hash;
 169 pub use core::intrinsics;
 170 pub use core::iter;
 171 #[cfg(not(test))] pub use core::marker;
 172 pub use core::mem;
 173 #[cfg(not(test))] pub use core::ops;
 174 pub use core::ptr;
 175 pub use core::raw;
 176 pub use core::simd;
 177 pub use core::result;
 178 pub use core::option;
 179 pub use core::error;
 180
 181 #[cfg(not(test))] pub use alloc::boxed;
 182 pub use alloc::rc;
 183
 184 pub use core_collections::slice;
 185 pub use core_collections::str;
 186 pub use core_collections::string;
 187 #[stable(feature = "rust1", since = "1.0.0")]
 188 pub use core_collections::vec;
 189
 190 pub use unicode::char;
 191
 192 /* Exported macros */
 193
 194 #[macro_use]
 195 mod macros;
 196
 197 mod rtdeps;
 198
 199 /* The Prelude. */
 200
 201 pub mod prelude;
 202
 203
 204 /* Primitive types */
 205
 206 #[path = "num/float_macros.rs"]
 207 #[macro_use]
 208 mod float_macros;
 209
 210 #[path = "num/int_macros.rs"]
 211 #[macro_use]
 212 mod int_macros;
 213
 214 #[path = "num/uint_macros.rs"]
 215 #[macro_use]
 216 mod uint_macros;
 217
 218 #[path = "num/int.rs"]  pub mod int;
 219 #[path = "num/isize.rs"]  pub mod isize;
 220 #[path = "num/i8.rs"]   pub mod i8;
 221 #[path = "num/i16.rs"]  pub mod i16;
 222 #[path = "num/i32.rs"]  pub mod i32;
 223 #[path = "num/i64.rs"]  pub mod i64;
 224
 225 #[path = "num/uint.rs"] pub mod uint;
 226 #[path = "num/usize.rs"] pub mod usize;
 227 #[path = "num/u8.rs"]   pub mod u8;
 228 #[path = "num/u16.rs"]  pub mod u16;
 229 #[path = "num/u32.rs"]  pub mod u32;
 230 #[path = "num/u64.rs"]  pub mod u64;
 231
 232 #[path = "num/f32.rs"]   pub mod f32;
 233 #[path = "num/f64.rs"]   pub mod f64;
 234
 235 pub mod ascii;
 236 pub mod thunk;
 237
 238 /* Common traits */
 239
 240 pub mod num;
 241
 242 /* Runtime and platform support */
 243
 244 #[macro_use]
 245 pub mod thread_local;
 246
 247 pub mod dynamic_lib;
 248 pub mod ffi;
 249 pub mod fmt;
 250 pub mod old_io;
 251 pub mod os;
 252 pub mod env;
 253 pub mod path;
 254 pub mod rand;
 255 pub mod time;
 256
 257 /* Common data structures */
 258
 259 pub mod collections;
 260
 261 /* Threads and communication */
 262
 263 pub mod thread;
 264 pub mod sync;
 265
 266 #[cfg(unix)]
 267 #[path = "sys/unix/mod.rs"] mod sys;
 268 #[cfg(windows)]
 269 #[path = "sys/windows/mod.rs"] mod sys;
 270
 271 #[path = "sys/common/mod.rs"] mod sys_common;
 272
 273 pub mod rt;
 274 mod failure;
 275
 276 // Documentation for primitive types
 277
 278 mod bool;
 279 mod unit;
 280 mod tuple;
 281
 282 // A curious inner-module that's not exported that contains the binding
 283 // 'std' so that macro-expanded references to std::error and such
 284 // can be resolved within libstd.
 285 #[doc(hidden)]
 286 mod std {
 287     // mods used for deriving
 288     pub use clone;
 289     pub use cmp;
 290     pub use hash;
 291     pub use default;
 292
 293     pub use sync; // used for select!()
 294     pub use error; // used for try!()
 295     pub use fmt; // used for any formatting strings
 296     pub use old_io; // used for println!()
 297     pub use option; // used for bitflags!{}
 298     pub use rt; // used for panic!()
 299     pub use vec; // used for vec![]
 300     pub use cell; // used for tls!
 301     pub use thread_local; // used for thread_local!
 302     pub use marker;  // used for tls!
 303     pub use ops; // used for bitflags!
 304
 305     // The test runner calls ::std::os::args() but really wants realstd
 306     #[cfg(test)] pub use realstd::os as os;
 307     // The test runner requires std::slice::Vector, so re-export std::slice just for it.
 308     //
 309     // It is also used in vec![]
 310     pub use slice;
 311
 312     pub use boxed; // used for vec![]
 313     // for-loops
 314     pub use iter;
 315 }