Text of rust.docs.kernel.org › next › src › core › lib.rs.html as Styx crawled it on Nov 20, 2026. The page may have changed since. Only its words are kept, without pictures or layout, and only the first part of a long page.

Open the live page

lib.rs - source

Skip to main content core/ 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`, `memmove`, `memset`, `memcmp`, `bcmp`, `strlen` - These are core memory routines 24 //! which are generated by Rust codegen backends. Additionally, this library can make explicit 25 //! calls to `strlen`. Their signatures are the same as found in C, but there are extra 26 //! assumptions about their semantics: For `memcpy`, `memmove`, `memset`, `memcmp`, and `bcmp`, if 27 //! the `n` parameter is 0, the function is assumed to not be UB, even if the pointers are NULL or 28 //! dangling. (Note that making extra assumptions about these functions is common among compilers: 29 //! [clang](https://reviews.llvm.org/D86993) and [GCC](https://gcc.gnu.org/onlinedocs/gcc/Standards.html#C-Language) do the same.) 30 //!

These functions are often provided by the system libc, but can also be provided by the 31 //! [compiler-builtins crate](https://crates.io/crates/compiler_builtins). 32 //! Note that the library does not guarantee that it will always make these assumptions, so Rust 33 //! user code directly calling the C functions should follow the C specification! The advice for 34 //! Rust user code is to call the functions provided by this library instead (such as 35 //! `ptr::copy`).

36 //! 37 //! * Panic handler - This function takes one argument, a `&panic::PanicInfo`. It is up to consumers of this core 38 //! library to define this panic function; it is only required to never 39 //! return. You should mark your implementation using `#[panic_handler]`. 40 //! 41 //! * `rust_eh_personality` - is used by the failure mechanisms of the 42 //! compiler. This is often mapped to GCC's personality function, but crates 43 //! which do not trigger a panic can be assured that this function is never 44 //! called.

The `lang` attribute is called `eh_personality`. 45 46 #![stable(feature = "core" , since = "1.6.0" )] 47 #![doc( 48 html_playground_url = "https://play.rust-lang.org/" , 49 issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/" , 50 test(no_crate_inject, attr(deny(warnings))), 51 test(attr(allow(dead_code, deprecated, unused_variables, unused_mut, duplicate_features))) 52 )] 53 #![doc(rust_logo)] 54 #![doc(auto_cfg( 55 hide(no_fp_fmt_parse), 56 hide(target_pointer_width, values( "16" , "32" , "64" )), 57 hide( 58 target_has_atomic, 59 target_has_atomic_primitive_alignment, 60 target_has_atomic_load_store, 61 values( "8" , "16" , "32" , "64" , "ptr" ), 62 ), 63 ))] 64 #![no_core] 65 #![rustc_coherence_is_core] 66 #![rustc_preserve_ub_checks] 67 // 68 // Lints: 69 #![deny(rust_2021_incompatible_or_patterns)] 70 #![deny(unsafe_op_in_unsafe_fn)] 71 #![deny(implicit_provenance_casts)] 72 #![warn(deprecated_in_future)] 73 #![warn(missing_debug_implementations)] 74 #![warn(missing_docs)] 75 #![allow(explicit_outlives_requirements)] 76 #![allow(incomplete_features)] 77 #![warn(multiple_supertrait_upcastable)] 78 #![allow(internal_features)] 79 #![allow(unused_features)] 80 #![deny(ffi_unwind_calls)] 81 #![warn(unreachable_pub)] 82 // Do not check link redundancy on bootstrapping phase 83 #![allow(rustdoc::redundant_explicit_links)] 84 #![warn(rustdoc::unescaped_backticks)] 85 // 86 // Library features: 87 // tidy-alphabetical-start 88 #![feature(asm_experimental_arch)] 89 #![feature(byte_str_internals)] 90 #![feature(cfg_target_has_reliable_f16_f128)] 91 #![feature(cfg_target_has_reliable_f16b)] 92 #![feature(const_cmp)] 93 #![feature(const_destruct)] 94 #![feature(const_eval_select)] 95 #![feature(const_select_unpredictable)] 96 #![feature(core_intrinsics)] 97 #![feature(coverage_attribute)] 98 #![feature(disjoint_bitor)] 99 #![feature(io_const_error)] 100 #![feature(offset_of_enum)] 101 #![feature(panic_internals)] 102 #![feature(pattern_types)] 103 #![feature(ub_checks)] 104 // tidy-alphabetical-end 105 // 106 // Language features: 107 // tidy-alphabetical-start 108 #![feature(adt_const_params)] 109 #![feature(allow_internal_unsafe)] 110 #![feature(allow_internal_unstable)] 111 #![feature(arbitrary_self_types_pointers)] 112 #![feature(auto_traits)] 113 #![feature(cfg_sanitize)] 114 #![feature(cfg_target_has_atomic)] 115 #![feature(cfg_ub_checks)] 116 #![feature(const_closures)] 117 #![feature(const_precise_live_drops)] 118 #![feature(const_trait_impl)] 119 #![feature(decl_macro)] 120 #![feature(deprecated_suggestion)] 121 #![feature(derive_const)] 122 #![feature(diagnostic_on_const)] 123 #![feature(diagnostic_on_unmatched_args)] 124 #![feature(diagnostic_opaque)] 125 #![feature(doc_cfg)] 126 #![feature(doc_notable_trait)] 127 #![feature(extern_types)] 128 #![feature(f16)] 129 #![feature(f128)] 130 #![feature(field_projections)] 131 #![feature(final_associated_functions)] 132 #![feature(forced_keywords)] 133 #![feature(freeze_impls)] 134 #![feature(fundamental)] 135 #![feature(impl_restriction)] 136 #![feature(intra_doc_pointers)] 137 #![feature(intrinsics)] 138 #![feature(lang_items)] 139 #![feature(link_cfg)] 140 #![feature(link_llvm_intrinsics)] 141 #![feature(macro_metavar_expr)] 142 #![feature(macro_metavar_expr_concat)] 143 #![feature(marker_trait_attr)] 144 #![feature(min_specialization)] 145 #![feature(move_trait)] 146 #![feature(multiple_supertrait_upcastable)] 147 #![feature(must_not_suspend)] 148 #![feature(negative_impls)] 149 #![feature(no_core)] 150 #![feature(pin_macro_internals)] 151 #![feature(prelude_import)] 152 #![feature(register_tool)] 153 #![feature(repr_simd)] 154 #![feature(rustc_attrs)] 155 #![feature(rustdoc_internals)] 156 #![feature(simd_ffi)] 157 #![feature(splat)] 158 #![feature(staged_api)] 159 #![feature(stmt_expr_attributes)] 160 #![feature(strict_provenance_lints)] 161 #![feature(trait_alias)] 162 #![feature(transparent_unions)] 163 #![feature(try_blocks)] 164 #![feature(uint_carryless_mul)] 165 #![feature(unboxed_closures)] 166 #![feature(unsized_fn_params)] 167 #![feature(with_negative_coherence)] 168 // tidy-alphabetical-end 169 // 170 // Target features: 171 // tidy-alphabetical-start 172 #![feature(aarch64_unstable_target_feature)] 173 #![feature(arm_target_feature)] 174 #![feature(avx10_target_feature)] 175 #![feature(clflushopt_target_feature)] 176 #![feature(hexagon_target_feature)] 177 #![feature(loongarch_target_feature)] 178 #![feature(mips_target_feature)] 179 #![feature(movrs_target_feature)] 180 #![feature(nvptx_target_feature)] 181 #![feature(powerpc_target_feature)] 182 #![feature(riscv_target_feature)] 183 #![feature(rtm_target_feature)] 184 #![feature(s390x_target_feature)] 185 #![feature(wasm_target_feature)] 186 #![feature(x86_amx_intrinsics)] 187 // tidy-alphabetical-end 188 189 // tidy-alphabetical-start 190 #![register_tool(lint)] 191 // tidy-alphabetical-end 192 193 // tidy-alphabetical-start 194 #![expect(clippy::partialeq_ne_impl, reason = "we need to implement ne for a lot of core types" )] 195 // tidy-alphabetical-end 196 197 // allow using `core::` in intra-doc links 198 #[allow(unused_extern_crates)] 199 extern crate self as core; 200 201

The rest of this page is on the live site.