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