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[^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 //! [^free]: Strictly speaking, there are some symbols which are needed but
  20 //!          they aren't always necessary.
  21 //!
  22 //! The core library is *minimal*: it isn't even aware of heap allocation,
  23 //! nor does it provide concurrency or I/O. These things require
  24 //! platform integration, and this library is platform-agnostic.
  25 //!
  26 //! # How to use the core library
  27 //!
  28 //! Please note that all of these details are currently not considered stable.
  29 //!
  30 // FIXME: Fill me in with more detail when the interface settles
  31 //! This library is built on the assumption of a few existing symbols:
  32 //!
  33 //! * `memcpy`, `memcmp`, `memset` - These are core memory routines which are
  34 //!   often generated by LLVM. Additionally, this library can make explicit
  35 //!   calls to these functions. Their signatures are the same as found in C.
  36 //!   These functions are often provided by the system libc, but can also be
  37 //!   provided by the [rlibc crate](https://crates.io/crates/rlibc).
  38 //!
  39 //! * `rust_begin_panic` - This function takes four arguments, a
  40 //!   `fmt::Arguments`, a `&'static str`, and two `u32`'s. These four arguments
  41 //!   dictate the panic message, the file at which panic was invoked, and the
  42 //!   line and column inside the file. It is up to consumers of this core
  43 //!   library to define this panic function; it is only required to never
  44 //!   return. This requires a `lang` attribute named `panic_fmt`.
  45 //!
  46 //! * `rust_eh_personality` - is used by the failure mechanisms of the
  47 //!    compiler. This is often mapped to GCC's personality function, but crates
  48 //!    which do not trigger a panic can be assured that this function is never
  49 //!    called. The `lang` attribute is called `eh_personality`.
  50
  51 // Since libcore defines many fundamental lang items, all tests live in a
  52 // separate crate, libcoretest, to avoid bizarre issues.
  53 //
  54 // Here we explicitly #[cfg]-out this whole crate when testing. If we don't do
  55 // this, both the generated test artifact and the linked libtest (which
  56 // transitively includes libcore) will both define the same set of lang items,
  57 // and this will cause the E0152 "duplicate lang item found" error. See
  58 // discussion in #50466 for details.
  59 //
  60 // This cfg won't affect doc tests.
  61 #![cfg(not(test))]
  62
  63 #![stable(feature = "core", since = "1.6.0")]
  64 #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
  65        html_favicon_url = "https://doc.rust-lang.org/favicon.ico",
  66        html_root_url = "https://doc.rust-lang.org/nightly/",
  67        html_playground_url = "https://play.rust-lang.org/",
  68        issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/",
  69        test(no_crate_inject, attr(deny(warnings))),
  70        test(attr(allow(dead_code, deprecated, unused_variables, unused_mut))))]
  71
  72 #![no_core]
  73 #![deny(missing_docs)]
  74 #![deny(missing_debug_implementations)]
  75
  76 #![feature(allow_internal_unstable)]
  77 #![feature(asm)]
  78 #![feature(associated_type_defaults)]
  79 #![feature(attr_literals)]
  80 #![feature(cfg_target_has_atomic)]
  81 #![feature(concat_idents)]
  82 #![feature(const_fn)]
  83 #![feature(core_float)]
  84 #![feature(custom_attribute)]
  85 #![feature(doc_cfg)]
  86 #![feature(doc_spotlight)]
  87 #![feature(extern_types)]
  88 #![feature(fundamental)]
  89 #![feature(intrinsics)]
  90 #![feature(iterator_flatten)]
  91 #![feature(iterator_repeat_with)]
  92 #![feature(lang_items)]
  93 #![feature(link_llvm_intrinsics)]
  94 #![feature(never_type)]
  95 #![feature(exhaustive_patterns)]
  96 #![feature(macro_at_most_once_rep)]
  97 #![feature(no_core)]
  98 #![feature(on_unimplemented)]
  99 #![feature(optin_builtin_traits)]
 100 #![feature(prelude_import)]
 101 #![feature(repr_simd, platform_intrinsics)]
 102 #![feature(rustc_attrs)]
 103 #![feature(rustc_const_unstable)]
 104 #![feature(simd_ffi)]
 105 #![feature(core_slice_ext)]
 106 #![feature(core_str_ext)]
 107 #![feature(specialization)]
 108 #![feature(staged_api)]
 109 #![feature(stmt_expr_attributes)]
 110 #![feature(unboxed_closures)]
 111 #![feature(untagged_unions)]
 112 #![feature(unwind_attributes)]
 113 #![feature(doc_alias)]
 114 #![feature(inclusive_range_methods)]
 115
 116 #![cfg_attr(not(stage0), feature(mmx_target_feature))]
 117 #![cfg_attr(not(stage0), feature(tbm_target_feature))]
 118 #![cfg_attr(not(stage0), feature(sse4a_target_feature))]
 119 #![cfg_attr(not(stage0), feature(arm_target_feature))]
 120 #![cfg_attr(not(stage0), feature(powerpc_target_feature))]
 121 #![cfg_attr(not(stage0), feature(mips_target_feature))]
 122 #![cfg_attr(not(stage0), feature(aarch64_target_feature))]
 123
 124 #![cfg_attr(stage0, feature(target_feature))]
 125 #![cfg_attr(stage0, feature(cfg_target_feature))]
 126 #![cfg_attr(stage0, feature(fn_must_use))]
 127
 128 #[prelude_import]
 129 #[allow(unused)]
 130 use prelude::v1::*;
 131
 132 #[macro_use]
 133 mod macros;
 134
 135 #[macro_use]
 136 mod internal_macros;
 137
 138 #[path = "num/int_macros.rs"]
 139 #[macro_use]
 140 mod int_macros;
 141
 142 #[path = "num/uint_macros.rs"]
 143 #[macro_use]
 144 mod uint_macros;
 145
 146 #[path = "num/isize.rs"] pub mod isize;
 147 #[path = "num/i8.rs"]    pub mod i8;
 148 #[path = "num/i16.rs"]   pub mod i16;
 149 #[path = "num/i32.rs"]   pub mod i32;
 150 #[path = "num/i64.rs"]   pub mod i64;
 151 #[path = "num/i128.rs"]   pub mod i128;
 152
 153 #[path = "num/usize.rs"] pub mod usize;
 154 #[path = "num/u8.rs"]    pub mod u8;
 155 #[path = "num/u16.rs"]   pub mod u16;
 156 #[path = "num/u32.rs"]   pub mod u32;
 157 #[path = "num/u64.rs"]   pub mod u64;
 158 #[path = "num/u128.rs"]   pub mod u128;
 159
 160 #[path = "num/f32.rs"]   pub mod f32;
 161 #[path = "num/f64.rs"]   pub mod f64;
 162
 163 #[macro_use]
 164 pub mod num;
 165
 166 /* The libcore prelude, not as all-encompassing as the libstd prelude */
 167
 168 pub mod prelude;
 169
 170 /* Core modules for ownership management */
 171
 172 pub mod intrinsics;
 173 pub mod mem;
 174 pub mod nonzero;
 175 pub mod ptr;
 176 pub mod hint;
 177
 178 /* Core language traits */
 179
 180 pub mod marker;
 181 pub mod ops;
 182 pub mod cmp;
 183 pub mod clone;
 184 pub mod default;
 185 pub mod convert;
 186 pub mod borrow;
 187
 188 /* Core types and methods on primitives */
 189
 190 pub mod any;
 191 pub mod array;
 192 pub mod ascii;
 193 pub mod sync;
 194 pub mod cell;
 195 pub mod char;
 196 pub mod panic;
 197 pub mod panicking;
 198 pub mod iter;
 199 pub mod option;
 200 pub mod raw;
 201 pub mod result;
 202
 203 pub mod slice;
 204 pub mod str;
 205 pub mod hash;
 206 pub mod fmt;
 207 pub mod time;
 208
 209 pub mod unicode;
 210
 211 /* Heap memory allocator trait */
 212 #[allow(missing_docs)]
 213 pub mod alloc;
 214
 215 #[unstable(feature = "allocator_api", issue = "32838")]
 216 #[rustc_deprecated(since = "1.27.0", reason = "module renamed to `alloc`")]
 217 /// Use the `alloc` module instead.
 218 pub mod heap {
 219     pub use alloc::*;
 220 }
 221
 222 // note: does not need to be public
 223 mod iter_private;
 224 mod tuple;
 225 mod unit;
 226
 227 // Pull in the the `coresimd` crate directly into libcore. This is where all the
 228 // architecture-specific (and vendor-specific) intrinsics are defined. AKA
 229 // things like SIMD and such. Note that the actual source for all this lies in a
 230 // different repository, rust-lang-nursery/stdsimd. That's why the setup here is
 231 // a bit wonky.
 232 #[allow(unused_macros)]
 233 macro_rules! test_v16 { ($item:item) => {}; }
 234 #[allow(unused_macros)]
 235 macro_rules! test_v32 { ($item:item) => {}; }
 236 #[allow(unused_macros)]
 237 macro_rules! test_v64 { ($item:item) => {}; }
 238 #[allow(unused_macros)]
 239 macro_rules! test_v128 { ($item:item) => {}; }
 240 #[allow(unused_macros)]
 241 macro_rules! test_v256 { ($item:item) => {}; }
 242 #[allow(unused_macros)]
 243 macro_rules! test_v512 { ($item:item) => {}; }
 244 #[allow(unused_macros)]
 245 macro_rules! vector_impl { ($([$f:ident, $($args:tt)*]),*) => { $($f!($($args)*);)* } }
 246 #[path = "../stdsimd/coresimd/mod.rs"]
 247 #[allow(missing_docs, missing_debug_implementations, dead_code, unused_imports)]
 248 #[unstable(feature = "stdsimd", issue = "48556")]
 249 #[cfg(not(stage0))] // allow changes to how stdsimd works in stage0
 250 mod coresimd;
 251
 252 #[unstable(feature = "stdsimd", issue = "48556")]
 253 #[cfg(not(stage0))]
 254 pub use coresimd::simd;
 255 #[stable(feature = "simd_arch", since = "1.27.0")]
 256 #[cfg(not(stage0))]
 257 pub use coresimd::arch;