src/libcore/lib.rs

   1 // Copyright 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 Core Library
  12 //!
  13 //! The Rust Core Library is the dependency-free foundation of [The
  14 //! Rust Standard Library](../std/index.html). It is the portable glue
  15 //! between the language and its libraries, defining the intrinsic and
  16 //! primitive building blocks of all Rust code. It links to no
  17 //! upstream libraries, no system libraries, and no libc.
  18 //!
  19 //! The core library is *minimal*: it isn't even aware of heap allocation,
  20 //! nor does it provide concurrency or I/O. These things require
  21 //! platform integration, and this library is platform-agnostic.
  22 //!
  23 //! *It is not recommended to use the core library*. The stable
  24 //! functionality of libcore is reexported from the
  25 //! [standard library](../std/index.html). The composition of this library is
  26 //! subject to change over time; only the interface exposed through libstd is
  27 //! intended to be stable.
  28 //!
  29 //! # How to use the core library
  30 //!
  31 // FIXME: Fill me in with more detail when the interface settles
  32 //! This library is built on the assumption of a few existing symbols:
  33 //!
  34 //! * `memcpy`, `memcmp`, `memset` - These are core memory routines which are
  35 //!   often generated by LLVM. Additionally, this library can make explicit
  36 //!   calls to these functions. Their signatures are the same as found in C.
  37 //!   These functions are often provided by the system libc, but can also be
  38 //!   provided by the [rlibc crate](https://crates.io/crates/rlibc).
  39 //!
  40 //! * `rust_begin_unwind` - This function takes three arguments, a
  41 //!   `fmt::Arguments`, a `&str`, and a `u32`. These three arguments dictate
  42 //!   the panic message, the file at which panic was invoked, and the line.
  43 //!   It is up to consumers of this core library to define this panic
  44 //!   function; it is only required to never return.
  45
  46 // Since libcore defines many fundamental lang items, all tests live in a
  47 // separate crate, libcoretest, to avoid bizarre issues.
  48
  49 // Do not remove on snapshot creation. Needed for bootstrap. (Issue #22364)
  50 #![cfg_attr(stage0, feature(custom_attribute))]
  51 #![crate_name = "core"]
  52 #![unstable(feature = "core",
  53             reason = "the libcore library has not yet been scrutinized for \
  54                       stabilization in terms of structure and naming")]
  55 #![staged_api]
  56 #![crate_type = "rlib"]
  57 #![doc(html_logo_url = "http://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
  58        html_favicon_url = "https://doc.rust-lang.org/favicon.ico",
  59        html_root_url = "http://doc.rust-lang.org/nightly/",
  60        html_playground_url = "http://play.rust-lang.org/")]
  61 #![doc(test(no_crate_inject))]
  62
  63 #![feature(no_std)]
  64 #![no_std]
  65 #![allow(raw_pointer_derive)]
  66 #![deny(missing_docs)]
  67
  68 #![feature(intrinsics)]
  69 #![feature(lang_items)]
  70 #![feature(on_unimplemented)]
  71 #![feature(simd)]
  72 #![feature(staged_api)]
  73 #![feature(unboxed_closures)]
  74 #![feature(rustc_attrs)]
  75 #![feature(optin_builtin_traits)]
  76 #![feature(fundamental)]
  77 #![feature(concat_idents)]
  78 #![feature(reflect)]
  79 #![feature(custom_attribute)]
  80 #![feature(const_fn)]
  81 #![feature(allow_internal_unstable)]
  82
  83 #[macro_use]
  84 mod macros;
  85
  86 #[macro_use]
  87 mod cmp_macros;
  88
  89 #[path = "num/float_macros.rs"]
  90 #[macro_use]
  91 mod float_macros;
  92
  93 #[path = "num/int_macros.rs"]
  94 #[macro_use]
  95 mod int_macros;
  96
  97 #[path = "num/uint_macros.rs"]
  98 #[macro_use]
  99 mod uint_macros;
 100
 101 #[path = "num/isize.rs"]  pub mod isize;
 102 #[path = "num/i8.rs"]   pub mod i8;
 103 #[path = "num/i16.rs"]  pub mod i16;
 104 #[path = "num/i32.rs"]  pub mod i32;
 105 #[path = "num/i64.rs"]  pub mod i64;
 106
 107 #[path = "num/usize.rs"] pub mod usize;
 108 #[path = "num/u8.rs"]   pub mod u8;
 109 #[path = "num/u16.rs"]  pub mod u16;
 110 #[path = "num/u32.rs"]  pub mod u32;
 111 #[path = "num/u64.rs"]  pub mod u64;
 112
 113 #[path = "num/f32.rs"]   pub mod f32;
 114 #[path = "num/f64.rs"]   pub mod f64;
 115
 116 #[macro_use]
 117 pub mod num;
 118
 119 /* The libcore prelude, not as all-encompassing as the libstd prelude */
 120
 121 pub mod prelude;
 122
 123 /* Core modules for ownership management */
 124
 125 pub mod intrinsics;
 126 pub mod mem;
 127 pub mod nonzero;
 128 pub mod ptr;
 129
 130 /* Core language traits */
 131
 132 pub mod marker;
 133 pub mod ops;
 134 pub mod cmp;
 135 pub mod clone;
 136 pub mod default;
 137 pub mod convert;
 138
 139 /* Core types and methods on primitives */
 140
 141 pub mod any;
 142 pub mod array;
 143 pub mod atomic;
 144 pub mod cell;
 145 pub mod char;
 146 pub mod panicking;
 147 pub mod iter;
 148 pub mod option;
 149 pub mod raw;
 150 pub mod result;
 151 pub mod simd;
 152 pub mod slice;
 153 pub mod str;
 154 pub mod hash;
 155 pub mod fmt;
 156
 157 #[doc(primitive = "bool")]
 158 mod bool {
 159 }
 160
 161 // note: does not need to be public
 162 mod tuple;
 163
 164 #[doc(hidden)]
 165 mod core {
 166     pub use intrinsics;
 167     pub use panicking;
 168     pub use fmt;
 169     pub use clone;
 170     pub use cmp;
 171     pub use hash;
 172     pub use marker;
 173     pub use option;
 174     pub use iter;
 175 }
 176
 177 #[doc(hidden)]
 178 mod std {
 179     // range syntax
 180     pub use ops;
 181 }