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 [compiler-builtins crate](https://crates.io/crates/compiler_builtins).
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 "found duplicate lang item" error. See
48 // discussion in #50466 for details.
50 // This cfg won't affect doc tests.
52 // To run libcore tests without x.py without ending up with two copies of libcore, Miri needs to be
53 // able to "empty" this crate. See <https://github.com/rust-lang/miri-test-libstd/issues/4>.
54 // rustc itself never sets the feature, so this line has no affect there.
55 #![cfg(any(not(feature = "miri-test-libstd"), test, doctest))]
56 #![stable(feature = "core", since = "1.6.0")]
58 html_playground_url = "https://play.rust-lang.org/",
59 issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/",
60 test(no_crate_inject, attr(deny(warnings))),
61 test(attr(allow(dead_code, deprecated, unused_variables, unused_mut)))
67 any(not(feature = "miri-test-libstd"), test, doctest),
69 target_pointer_width = "16",
70 target_pointer_width = "32",
71 target_pointer_width = "64",
72 target_has_atomic = "8",
73 target_has_atomic = "16",
74 target_has_atomic = "32",
75 target_has_atomic = "64",
76 target_has_atomic = "ptr",
77 target_has_atomic_equal_alignment = "8",
78 target_has_atomic_equal_alignment = "16",
79 target_has_atomic_equal_alignment = "32",
80 target_has_atomic_equal_alignment = "64",
81 target_has_atomic_equal_alignment = "ptr",
82 target_has_atomic_load_store = "8",
83 target_has_atomic_load_store = "16",
84 target_has_atomic_load_store = "32",
85 target_has_atomic_load_store = "64",
86 target_has_atomic_load_store = "ptr",
92 #![deny(rust_2021_incompatible_or_patterns)]
93 #![deny(unsafe_op_in_unsafe_fn)]
94 #![warn(deprecated_in_future)]
95 #![warn(missing_debug_implementations)]
96 #![warn(missing_docs)]
97 #![allow(explicit_outlives_requirements)]
99 // Library features for const fns:
100 #![feature(const_align_of_val)]
101 #![feature(const_alloc_layout)]
102 #![feature(const_arguments_as_str)]
103 #![feature(const_assert_type)]
104 #![feature(const_bigint_helper_methods)]
105 #![feature(const_caller_location)]
106 #![feature(const_cell_into_inner)]
107 #![feature(const_discriminant)]
108 #![feature(const_float_bits_conv)]
109 #![feature(const_float_classify)]
110 #![feature(const_heap)]
111 #![feature(const_inherent_unchecked_arith)]
112 #![feature(const_int_unchecked_arith)]
113 #![feature(const_intrinsic_copy)]
114 #![feature(const_intrinsic_forget)]
115 #![feature(const_likely)]
116 #![feature(const_maybe_uninit_as_ptr)]
117 #![feature(const_maybe_uninit_assume_init)]
118 #![feature(const_option)]
119 #![feature(const_pin)]
120 #![feature(const_replace)]
121 #![feature(const_ptr_offset)]
122 #![feature(const_ptr_offset_from)]
123 #![feature(const_ptr_read)]
124 #![feature(const_ptr_write)]
125 #![feature(const_raw_ptr_comparison)]
126 #![feature(const_size_of_val)]
127 #![feature(const_slice_from_raw_parts)]
128 #![feature(const_slice_ptr_len)]
129 #![feature(const_swap)]
130 #![feature(const_trait_impl)]
131 #![feature(const_type_id)]
132 #![feature(const_type_name)]
133 #![feature(const_unreachable_unchecked)]
134 #![feature(const_default_impls)]
135 #![feature(duration_consts_2)]
136 #![feature(ptr_metadata)]
137 #![feature(slice_ptr_get)]
138 #![feature(variant_count)]
140 // Language features:
141 #![feature(abi_unadjusted)]
142 #![feature(allow_internal_unsafe)]
143 #![feature(allow_internal_unstable)]
145 #![feature(associated_type_bounds)]
146 #![feature(auto_traits)]
147 #![feature(cfg_target_has_atomic)]
148 #![feature(const_fn_floating_point_arithmetic)]
149 #![feature(const_fn_fn_ptr_basics)]
150 #![feature(const_fn_trait_bound)]
151 #![feature(const_impl_trait)]
152 #![feature(const_mut_refs)]
153 #![cfg_attr(bootstrap, feature(const_panic))]
154 #![feature(const_precise_live_drops)]
155 #![feature(const_raw_ptr_deref)]
156 #![feature(const_refs_to_cell)]
157 #![feature(decl_macro)]
159 #![feature(doc_notable_trait)]
160 #![feature(doc_primitive)]
161 #![feature(exhaustive_patterns)]
162 #![cfg_attr(not(bootstrap), feature(doc_cfg_hide))]
163 #![feature(extern_types)]
164 #![feature(fundamental)]
165 #![feature(if_let_guard)]
166 #![feature(intra_doc_pointers)]
167 #![feature(intrinsics)]
168 #![feature(lang_items)]
169 #![feature(link_llvm_intrinsics)]
170 #![feature(llvm_asm)]
171 #![feature(min_specialization)]
172 #![feature(mixed_integer_ops)]
173 #![cfg_attr(not(bootstrap), feature(must_not_suspend))]
174 #![feature(negative_impls)]
175 #![feature(never_type)]
177 #![feature(no_coverage)] // rust-lang/rust#84605
178 #![feature(no_niche)] // rust-lang/rust#68303
179 #![feature(platform_intrinsics)]
180 #![feature(prelude_import)]
181 #![feature(repr_simd)]
182 #![feature(rustc_allow_const_fn_unstable)]
183 #![feature(rustc_attrs)]
184 #![feature(simd_ffi)]
185 #![feature(staged_api)]
186 #![feature(stmt_expr_attributes)]
187 #![feature(trait_alias)]
188 #![feature(transparent_unions)]
189 #![feature(try_blocks)]
190 #![feature(unboxed_closures)]
191 #![feature(unsized_fn_params)]
194 #![feature(aarch64_target_feature)]
195 #![feature(adx_target_feature)]
196 #![feature(arm_target_feature)]
197 #![feature(avx512_target_feature)]
198 #![feature(cmpxchg16b_target_feature)]
199 #![feature(f16c_target_feature)]
200 #![feature(hexagon_target_feature)]
201 #![feature(mips_target_feature)]
202 #![feature(powerpc_target_feature)]
203 #![feature(rtm_target_feature)]
204 #![feature(sse4a_target_feature)]
205 #![feature(tbm_target_feature)]
206 #![feature(wasm_target_feature)]
208 // allow using `core::` in intra-doc links
209 #[allow(unused_extern_crates)]
210 extern crate self as core;
216 #[cfg(not(test))] // See #65860
220 // We don't export this through #[macro_export] for now, to avoid breakage.
221 // See https://github.com/rust-lang/rust/issues/82913
223 #[unstable(feature = "assert_matches", issue = "82775")]
224 /// Unstable module containing the unstable `assert_matches` macro.
225 pub mod assert_matches {
226 #[unstable(feature = "assert_matches", issue = "82775")]
227 pub use crate::macros::{assert_matches, debug_assert_matches};
233 #[path = "num/shells/int_macros.rs"]
237 #[path = "num/shells/i128.rs"]
239 #[path = "num/shells/i16.rs"]
241 #[path = "num/shells/i32.rs"]
243 #[path = "num/shells/i64.rs"]
245 #[path = "num/shells/i8.rs"]
247 #[path = "num/shells/isize.rs"]
250 #[path = "num/shells/u128.rs"]
252 #[path = "num/shells/u16.rs"]
254 #[path = "num/shells/u32.rs"]
256 #[path = "num/shells/u64.rs"]
258 #[path = "num/shells/u8.rs"]
260 #[path = "num/shells/usize.rs"]
263 #[path = "num/f32.rs"]
265 #[path = "num/f64.rs"]
271 /* The libcore prelude, not as all-encompassing as the libstd prelude */
275 /* Core modules for ownership management */
282 /* Core language traits */
292 /* Core types and methods on primitives */
301 #[unstable(feature = "once_cell", issue = "74465")]
308 #[unstable(feature = "async_stream", issue = "79024")]
324 /* Heap memory allocator trait */
325 #[allow(missing_docs)]
328 // note: does not need to be public
333 #[stable(feature = "core_primitive", since = "1.43.0")]
336 // Pull in the `core_arch` crate directly into libcore. The contents of
337 // `core_arch` are in a different repository: rust-lang/stdarch.
339 // `core_arch` depends on libcore, but the contents of this module are
340 // set up in such a way that directly pulling it here works such that the
341 // crate uses the this crate as its libcore.
342 #[path = "../../stdarch/crates/core_arch/src/mod.rs"]
345 missing_debug_implementations,
348 unsafe_op_in_unsafe_fn
350 #[allow(rustdoc::bare_urls)]
351 // FIXME: This annotation should be moved into rust-lang/stdarch after clashing_extern_declarations is
352 // merged. It currently cannot because bootstrap fails as the lint hasn't been defined yet.
353 #[allow(clashing_extern_declarations)]
354 #[unstable(feature = "stdsimd", issue = "48556")]
357 #[doc = include_str!("../../stdarch/crates/core_arch/src/core_arch_docs.md")]
358 #[stable(feature = "simd_arch", since = "1.27.0")]
360 #[stable(feature = "simd_arch", since = "1.27.0")]
361 pub use crate::core_arch::arch::*;
365 /// Read the [unstable book] for the usage.
367 /// [unstable book]: ../../unstable-book/library-features/asm.html
371 reason = "inline assembly is not stable enough for use and is subject to change"
373 #[rustc_builtin_macro]
374 pub macro asm("assembly template", $(operands,)* $(options($(option),*))?) {
375 /* compiler built-in */
378 /// Module-level inline assembly.
380 feature = "global_asm",
382 reason = "`global_asm!` is not stable enough for use and is subject to change"
384 #[rustc_builtin_macro]
385 pub macro global_asm("assembly template", $(operands,)* $(options($(option),*))?) {
386 /* compiler built-in */
390 include!("primitive_docs.rs");