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             issue = "27701")]
  56 #![staged_api]
  57 #![crate_type = "rlib"]
  58 #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
  59        html_favicon_url = "https://doc.rust-lang.org/favicon.ico",
  60        html_root_url = "https://doc.rust-lang.org/nightly/",
  61        html_playground_url = "https://play.rust-lang.org/",
  62        issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")]
  63 #![doc(test(no_crate_inject))]
  64
  65 #![no_core]
  66 #![allow(raw_pointer_derive)]
  67 #![deny(missing_docs)]
  68
  69 #![feature(allow_internal_unstable)]
  70 #![feature(associated_type_defaults)]
  71 #![feature(concat_idents)]
  72 #![feature(const_fn)]
  73 #![feature(custom_attribute)]
  74 #![feature(fundamental)]
  75 #![feature(intrinsics)]
  76 #![feature(lang_items)]
  77 #![feature(no_core)]
  78 #![feature(on_unimplemented)]
  79 #![feature(optin_builtin_traits)]
  80 #![feature(reflect)]
  81 #![feature(rustc_attrs)]
  82 #![cfg_attr(stage0, feature(simd))]
  83 #![cfg_attr(not(stage0), feature(repr_simd, platform_intrinsics))]
  84 #![feature(staged_api)]
  85 #![feature(unboxed_closures)]
  86
  87 #[macro_use]
  88 mod macros;
  89
  90 #[macro_use]
  91 mod cmp_macros;
  92
  93 #[path = "num/float_macros.rs"]
  94 #[macro_use]
  95 mod float_macros;
  96
  97 #[path = "num/int_macros.rs"]
  98 #[macro_use]
  99 mod int_macros;
 100
 101 #[path = "num/uint_macros.rs"]
 102 #[macro_use]
 103 mod uint_macros;
 104
 105 #[path = "num/isize.rs"]  pub mod isize;
 106 #[path = "num/i8.rs"]   pub mod i8;
 107 #[path = "num/i16.rs"]  pub mod i16;
 108 #[path = "num/i32.rs"]  pub mod i32;
 109 #[path = "num/i64.rs"]  pub mod i64;
 110
 111 #[path = "num/usize.rs"] pub mod usize;
 112 #[path = "num/u8.rs"]   pub mod u8;
 113 #[path = "num/u16.rs"]  pub mod u16;
 114 #[path = "num/u32.rs"]  pub mod u32;
 115 #[path = "num/u64.rs"]  pub mod u64;
 116
 117 #[path = "num/f32.rs"]   pub mod f32;
 118 #[path = "num/f64.rs"]   pub mod f64;
 119
 120 #[macro_use]
 121 pub mod num;
 122
 123 /* The libcore prelude, not as all-encompassing as the libstd prelude */
 124
 125 pub mod prelude;
 126
 127 /* Core modules for ownership management */
 128
 129 pub mod intrinsics;
 130 pub mod mem;
 131 pub mod nonzero;
 132 pub mod ptr;
 133
 134 /* Core language traits */
 135
 136 pub mod marker;
 137 pub mod ops;
 138 pub mod cmp;
 139 pub mod clone;
 140 pub mod default;
 141 pub mod convert;
 142
 143 /* Core types and methods on primitives */
 144
 145 pub mod any;
 146 pub mod array;
 147 pub mod sync;
 148 pub mod cell;
 149 pub mod char;
 150 pub mod panicking;
 151 pub mod iter;
 152 pub mod option;
 153 pub mod raw;
 154 pub mod result;
 155
 156 #[cfg(stage0)]
 157 #[path = "simd_old.rs"]
 158 pub mod simd;
 159 #[cfg(not(stage0))]
 160 pub mod simd;
 161
 162 pub mod slice;
 163 pub mod str;
 164 pub mod hash;
 165 pub mod fmt;
 166
 167 // note: does not need to be public
 168 mod tuple;