1 //! # The Rust Core Library
3 //! The Rust Core Library is the dependency-free[^free] foundation of [The
4 //! Rust Standard Library](../std/index.html). It is the portable glue
5 //! between the language and its libraries, defining the intrinsic and
6 //! primitive building blocks of all Rust code. It links to no
7 //! upstream libraries, no system libraries, and no libc.
9 //! [^free]: Strictly speaking, there are some symbols which are needed but
10 //! they aren't always necessary.
12 //! The core library is *minimal*: it isn't even aware of heap allocation,
13 //! nor does it provide concurrency or I/O. These things require
14 //! platform integration, and this library is platform-agnostic.
16 //! # How to use the core library
18 //! Please note that all of these details are currently not considered stable.
20 // FIXME: Fill me in with more detail when the interface settles
21 //! This library is built on the assumption of a few existing symbols:
23 //! * `memcpy`, `memcmp`, `memset` - These are core memory routines which are
24 //! often generated by LLVM. Additionally, this library can make explicit
25 //! calls to these functions. Their signatures are the same as found in C.
26 //! These functions are often provided by the system libc, but can also be
27 //! provided by the [rlibc crate](https://crates.io/crates/rlibc).
29 //! * `rust_begin_panic` - This function takes four arguments, a
30 //! `fmt::Arguments`, a `&'static str`, and two `u32`'s. These four arguments
31 //! dictate the panic message, the file at which panic was invoked, and the
32 //! line and column inside the file. It is up to consumers of this core
33 //! library to define this panic function; it is only required to never
34 //! return. This requires a `lang` attribute named `panic_impl`.
36 //! * `rust_eh_personality` - is used by the failure mechanisms of the
37 //! compiler. This is often mapped to GCC's personality function, but crates
38 //! which do not trigger a panic can be assured that this function is never
39 //! called. The `lang` attribute is called `eh_personality`.
41 // Since libcore defines many fundamental lang items, all tests live in a
42 // separate crate, libcoretest, to avoid bizarre issues.
44 // Here we explicitly #[cfg]-out this whole crate when testing. If we don't do
45 // this, both the generated test artifact and the linked libtest (which
46 // transitively includes libcore) will both define the same set of lang items,
47 // and this will cause the E0152 "duplicate lang item found" error. See
48 // discussion in #50466 for details.
50 // This cfg won't affect doc tests.
53 #![stable(feature = "core", since = "1.6.0")]
54 #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
55 html_favicon_url = "https://doc.rust-lang.org/favicon.ico",
56 html_root_url = "https://doc.rust-lang.org/nightly/",
57 html_playground_url = "https://play.rust-lang.org/",
58 issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/",
59 test(no_crate_inject, attr(deny(warnings))),
60 test(attr(allow(dead_code, deprecated, unused_variables, unused_mut))))]
63 #![deny(missing_docs)]
64 #![deny(intra_doc_link_resolution_failure)]
65 #![deny(missing_debug_implementations)]
67 #![feature(allow_internal_unstable)]
68 #![feature(arbitrary_self_types)]
70 #![feature(associated_type_defaults)]
71 #![feature(cfg_target_has_atomic)]
72 #![feature(concat_idents)]
74 #![cfg_attr(stage0, feature(const_int_ops))]
75 #![feature(const_fn_union)]
76 #![feature(custom_attribute)]
78 #![feature(doc_spotlight)]
79 #![feature(extern_types)]
80 #![feature(fundamental)]
81 #![feature(intrinsics)]
82 #![feature(is_sorted)]
83 #![feature(iter_once_with)]
84 #![feature(lang_items)]
85 #![feature(link_llvm_intrinsics)]
86 #![feature(never_type)]
88 #![feature(bind_by_move_pattern_guards)]
89 #![feature(exhaustive_patterns)]
91 #![feature(on_unimplemented)]
92 #![feature(optin_builtin_traits)]
93 #![feature(prelude_import)]
94 #![feature(repr_simd, platform_intrinsics)]
95 #![feature(rustc_attrs)]
96 #![feature(rustc_const_unstable)]
98 #![feature(specialization)]
99 #![feature(staged_api)]
100 #![feature(stmt_expr_attributes)]
101 #![feature(unboxed_closures)]
102 #![feature(unsized_locals)]
103 #![feature(untagged_unions)]
104 #![feature(unwind_attributes)]
105 #![feature(doc_alias)]
106 #![feature(mmx_target_feature)]
107 #![feature(tbm_target_feature)]
108 #![feature(sse4a_target_feature)]
109 #![feature(arm_target_feature)]
110 #![feature(powerpc_target_feature)]
111 #![feature(mips_target_feature)]
112 #![feature(aarch64_target_feature)]
113 #![feature(wasm_target_feature)]
114 #![feature(avx512_target_feature)]
115 #![cfg_attr(not(stage0), feature(cmpxchg16b_target_feature))]
116 #![feature(const_slice_len)]
117 #![feature(const_str_as_bytes)]
118 #![feature(const_str_len)]
119 #![cfg_attr(stage0, feature(const_let))]
120 #![cfg_attr(stage0, feature(const_int_rotate))]
121 #![feature(const_int_conversion)]
122 #![feature(const_transmute)]
123 #![feature(reverse_bits)]
124 #![feature(non_exhaustive)]
125 #![feature(structural_match)]
126 #![feature(abi_unadjusted)]
127 #![cfg_attr(not(stage0), feature(adx_target_feature))]
139 #[path = "num/int_macros.rs"]
143 #[path = "num/uint_macros.rs"]
147 #[path = "num/isize.rs"] pub mod isize;
148 #[path = "num/i8.rs"] pub mod i8;
149 #[path = "num/i16.rs"] pub mod i16;
150 #[path = "num/i32.rs"] pub mod i32;
151 #[path = "num/i64.rs"] pub mod i64;
152 #[path = "num/i128.rs"] pub mod i128;
154 #[path = "num/usize.rs"] pub mod usize;
155 #[path = "num/u8.rs"] pub mod u8;
156 #[path = "num/u16.rs"] pub mod u16;
157 #[path = "num/u32.rs"] pub mod u32;
158 #[path = "num/u64.rs"] pub mod u64;
159 #[path = "num/u128.rs"] pub mod u128;
161 #[path = "num/f32.rs"] pub mod f32;
162 #[path = "num/f64.rs"] pub mod f64;
167 /* The libcore prelude, not as all-encompassing as the libstd prelude */
171 /* Core modules for ownership management */
178 /* Core language traits */
188 /* Core types and methods on primitives */
217 /* Heap memory allocator trait */
218 #[allow(missing_docs)]
221 // note: does not need to be public
226 // Pull in the `coresimd` crate directly into libcore. This is where all the
227 // architecture-specific (and vendor-specific) intrinsics are defined. AKA
228 // things like SIMD and such. Note that the actual source for all this lies in a
229 // different repository, rust-lang-nursery/stdsimd. That's why the setup here is
231 #[allow(unused_macros)]
232 macro_rules! test_v16 { ($item:item) => {}; }
233 #[allow(unused_macros)]
234 macro_rules! test_v32 { ($item:item) => {}; }
235 #[allow(unused_macros)]
236 macro_rules! test_v64 { ($item:item) => {}; }
237 #[allow(unused_macros)]
238 macro_rules! test_v128 { ($item:item) => {}; }
239 #[allow(unused_macros)]
240 macro_rules! test_v256 { ($item:item) => {}; }
241 #[allow(unused_macros)]
242 macro_rules! test_v512 { ($item:item) => {}; }
243 #[allow(unused_macros)]
244 macro_rules! vector_impl { ($([$f:ident, $($args:tt)*]),*) => { $($f!($($args)*);)* } }
245 #[path = "../stdsimd/coresimd/mod.rs"]
246 #[allow(missing_docs, missing_debug_implementations, dead_code, unused_imports)]
247 #[unstable(feature = "stdsimd", issue = "48556")]
250 #[stable(feature = "simd_arch", since = "1.27.0")]
251 pub use coresimd::arch;