library/core/src/lib.rs

   1 //! # The Rust Core Library
   2 //!
   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.
   8 //!
   9 //! [^free]: Strictly speaking, there are some symbols which are needed but
  10 //!          they aren't always necessary.
  11 //!
  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.
  15 //!
  16 //! # How to use the core library
  17 //!
  18 //! Please note that all of these details are currently not considered stable.
  19 //!
  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:
  22 //!
  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).
  28 //!
  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`.
  35 //!
  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`.
  40
  41 // Since libcore defines many fundamental lang items, all tests live in a
  42 // separate crate, libcoretest, to avoid bizarre issues.
  43 //
  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.
  49 //
  50 // This cfg won't affect doc tests.
  51 #![cfg(not(test))]
  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")]
  57 #![doc(
  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)))
  62 )]
  63 #![cfg_attr(
  64     not(bootstrap),
  65     doc(cfg_hide(
  66         not(test),
  67         any(not(feature = "miri-test-libstd"), test, doctest),
  68         no_fp_fmt_parse,
  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",
  87     ))
  88 )]
  89 #![no_core]
  90 //
  91 // Lints:
  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)]
  98 //
  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_num_from_num)]
 119 #![feature(const_option)]
 120 #![feature(const_pin)]
 121 #![feature(const_replace)]
 122 #![feature(const_ptr_offset)]
 123 #![feature(const_ptr_offset_from)]
 124 #![feature(const_ptr_read)]
 125 #![feature(const_ptr_write)]
 126 #![feature(const_raw_ptr_comparison)]
 127 #![feature(const_size_of_val)]
 128 #![feature(const_slice_from_raw_parts)]
 129 #![feature(const_slice_ptr_len)]
 130 #![feature(const_swap)]
 131 #![feature(const_trait_impl)]
 132 #![feature(const_type_id)]
 133 #![feature(const_type_name)]
 134 #![feature(const_default_impls)]
 135 #![feature(duration_consts_2)]
 136 #![feature(ptr_metadata)]
 137 #![feature(slice_ptr_get)]
 138 #![feature(variant_count)]
 139 #![feature(const_array_from_ref)]
 140 #![feature(const_slice_from_ref)]
 141 //
 142 // Language features:
 143 #![feature(abi_unadjusted)]
 144 #![feature(allow_internal_unsafe)]
 145 #![feature(allow_internal_unstable)]
 146 #![feature(asm)]
 147 #![feature(associated_type_bounds)]
 148 #![feature(auto_traits)]
 149 #![feature(cfg_target_has_atomic)]
 150 #![feature(const_fn_floating_point_arithmetic)]
 151 #![feature(const_fn_fn_ptr_basics)]
 152 #![feature(const_fn_trait_bound)]
 153 #![feature(const_impl_trait)]
 154 #![feature(const_mut_refs)]
 155 #![cfg_attr(bootstrap, feature(const_panic))]
 156 #![feature(const_precise_live_drops)]
 157 #![feature(const_raw_ptr_deref)]
 158 #![feature(const_refs_to_cell)]
 159 #![feature(decl_macro)]
 160 #![feature(doc_cfg)]
 161 #![feature(doc_notable_trait)]
 162 #![feature(doc_primitive)]
 163 #![feature(exhaustive_patterns)]
 164 #![cfg_attr(not(bootstrap), feature(doc_cfg_hide))]
 165 #![feature(extern_types)]
 166 #![feature(fundamental)]
 167 #![feature(if_let_guard)]
 168 #![feature(intra_doc_pointers)]
 169 #![feature(intrinsics)]
 170 #![feature(lang_items)]
 171 #![feature(link_llvm_intrinsics)]
 172 #![feature(llvm_asm)]
 173 #![feature(min_specialization)]
 174 #![feature(mixed_integer_ops)]
 175 #![cfg_attr(not(bootstrap), feature(must_not_suspend))]
 176 #![feature(negative_impls)]
 177 #![feature(never_type)]
 178 #![feature(no_core)]
 179 #![feature(no_coverage)] // rust-lang/rust#84605
 180 #![feature(no_niche)] // rust-lang/rust#68303
 181 #![feature(platform_intrinsics)]
 182 #![feature(prelude_import)]
 183 #![feature(repr_simd)]
 184 #![feature(rustc_allow_const_fn_unstable)]
 185 #![feature(rustc_attrs)]
 186 #![feature(simd_ffi)]
 187 #![feature(staged_api)]
 188 #![feature(stmt_expr_attributes)]
 189 #![feature(trait_alias)]
 190 #![feature(transparent_unions)]
 191 #![feature(try_blocks)]
 192 #![feature(unboxed_closures)]
 193 #![feature(unsized_fn_params)]
 194 //
 195 // Target features:
 196 #![feature(aarch64_target_feature)]
 197 #![feature(adx_target_feature)]
 198 #![feature(arm_target_feature)]
 199 #![feature(avx512_target_feature)]
 200 #![feature(cmpxchg16b_target_feature)]
 201 #![feature(f16c_target_feature)]
 202 #![feature(hexagon_target_feature)]
 203 #![feature(mips_target_feature)]
 204 #![feature(powerpc_target_feature)]
 205 #![feature(rtm_target_feature)]
 206 #![feature(sse4a_target_feature)]
 207 #![feature(tbm_target_feature)]
 208 #![feature(wasm_target_feature)]
 209
 210 // allow using `core::` in intra-doc links
 211 #[allow(unused_extern_crates)]
 212 extern crate self as core;
 213
 214 #[prelude_import]
 215 #[allow(unused)]
 216 use prelude::v1::*;
 217
 218 #[cfg(not(test))] // See #65860
 219 #[macro_use]
 220 mod macros;
 221
 222 // We don't export this through #[macro_export] for now, to avoid breakage.
 223 // See https://github.com/rust-lang/rust/issues/82913
 224 #[cfg(not(test))]
 225 #[unstable(feature = "assert_matches", issue = "82775")]
 226 /// Unstable module containing the unstable `assert_matches` macro.
 227 pub mod assert_matches {
 228     #[unstable(feature = "assert_matches", issue = "82775")]
 229     pub use crate::macros::{assert_matches, debug_assert_matches};
 230 }
 231
 232 #[macro_use]
 233 mod internal_macros;
 234
 235 #[path = "num/shells/int_macros.rs"]
 236 #[macro_use]
 237 mod int_macros;
 238
 239 #[path = "num/shells/i128.rs"]
 240 pub mod i128;
 241 #[path = "num/shells/i16.rs"]
 242 pub mod i16;
 243 #[path = "num/shells/i32.rs"]
 244 pub mod i32;
 245 #[path = "num/shells/i64.rs"]
 246 pub mod i64;
 247 #[path = "num/shells/i8.rs"]
 248 pub mod i8;
 249 #[path = "num/shells/isize.rs"]
 250 pub mod isize;
 251
 252 #[path = "num/shells/u128.rs"]
 253 pub mod u128;
 254 #[path = "num/shells/u16.rs"]
 255 pub mod u16;
 256 #[path = "num/shells/u32.rs"]
 257 pub mod u32;
 258 #[path = "num/shells/u64.rs"]
 259 pub mod u64;
 260 #[path = "num/shells/u8.rs"]
 261 pub mod u8;
 262 #[path = "num/shells/usize.rs"]
 263 pub mod usize;
 264
 265 #[path = "num/f32.rs"]
 266 pub mod f32;
 267 #[path = "num/f64.rs"]
 268 pub mod f64;
 269
 270 #[macro_use]
 271 pub mod num;
 272
 273 /* The libcore prelude, not as all-encompassing as the libstd prelude */
 274
 275 pub mod prelude;
 276
 277 /* Core modules for ownership management */
 278
 279 pub mod hint;
 280 pub mod intrinsics;
 281 pub mod mem;
 282 pub mod ptr;
 283
 284 /* Core language traits */
 285
 286 pub mod borrow;
 287 pub mod clone;
 288 pub mod cmp;
 289 pub mod convert;
 290 pub mod default;
 291 pub mod marker;
 292 pub mod ops;
 293
 294 /* Core types and methods on primitives */
 295
 296 pub mod any;
 297 pub mod array;
 298 pub mod ascii;
 299 pub mod cell;
 300 pub mod char;
 301 pub mod ffi;
 302 pub mod iter;
 303 #[unstable(feature = "once_cell", issue = "74465")]
 304 pub mod lazy;
 305 pub mod option;
 306 pub mod panic;
 307 pub mod panicking;
 308 pub mod pin;
 309 pub mod result;
 310 #[unstable(feature = "async_stream", issue = "79024")]
 311 pub mod stream;
 312 pub mod sync;
 313
 314 pub mod fmt;
 315 pub mod hash;
 316 pub mod slice;
 317 pub mod str;
 318 pub mod time;
 319
 320 pub mod unicode;
 321
 322 /* Async */
 323 pub mod future;
 324 pub mod task;
 325
 326 /* Heap memory allocator trait */
 327 #[allow(missing_docs)]
 328 pub mod alloc;
 329
 330 // note: does not need to be public
 331 mod bool;
 332 mod tuple;
 333 mod unit;
 334
 335 #[stable(feature = "core_primitive", since = "1.43.0")]
 336 pub mod primitive;
 337
 338 // Pull in the `core_arch` crate directly into libcore. The contents of
 339 // `core_arch` are in a different repository: rust-lang/stdarch.
 340 //
 341 // `core_arch` depends on libcore, but the contents of this module are
 342 // set up in such a way that directly pulling it here works such that the
 343 // crate uses the this crate as its libcore.
 344 #[path = "../../stdarch/crates/core_arch/src/mod.rs"]
 345 #[allow(
 346     missing_docs,
 347     missing_debug_implementations,
 348     dead_code,
 349     unused_imports,
 350     unsafe_op_in_unsafe_fn
 351 )]
 352 #[allow(rustdoc::bare_urls)]
 353 // FIXME: This annotation should be moved into rust-lang/stdarch after clashing_extern_declarations is
 354 // merged. It currently cannot because bootstrap fails as the lint hasn't been defined yet.
 355 #[allow(clashing_extern_declarations)]
 356 #[unstable(feature = "stdsimd", issue = "48556")]
 357 mod core_arch;
 358
 359 #[doc = include_str!("../../stdarch/crates/core_arch/src/core_arch_docs.md")]
 360 #[stable(feature = "simd_arch", since = "1.27.0")]
 361 pub mod arch {
 362     #[stable(feature = "simd_arch", since = "1.27.0")]
 363     pub use crate::core_arch::arch::*;
 364
 365     /// Inline assembly.
 366     ///
 367     /// Read the [unstable book] for the usage.
 368     ///
 369     /// [unstable book]: ../../unstable-book/library-features/asm.html
 370     #[unstable(
 371         feature = "asm",
 372         issue = "72016",
 373         reason = "inline assembly is not stable enough for use and is subject to change"
 374     )]
 375     #[rustc_builtin_macro]
 376     pub macro asm("assembly template", $(operands,)* $(options($(option),*))?) {
 377         /* compiler built-in */
 378     }
 379
 380     /// Module-level inline assembly.
 381     #[unstable(
 382         feature = "global_asm",
 383         issue = "35119",
 384         reason = "`global_asm!` is not stable enough for use and is subject to change"
 385     )]
 386     #[rustc_builtin_macro]
 387     pub macro global_asm("assembly template", $(operands,)* $(options($(option),*))?) {
 388         /* compiler built-in */
 389     }
 390 }
 391
 392 include!("primitive_docs.rs");