]>
Commit | Line | Data |
---|---|---|
1a4d82fc JJ |
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 | //! | |
92a42be0 | 13 | //! The Rust Core Library is the dependency-free[^free] foundation of [The |
1a4d82fc JJ |
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 | //! | |
92a42be0 SL |
19 | //! [^free]: Strictly speaking, there are some symbols which are needed but |
20 | //! they aren't always necessary. | |
21 | //! | |
1a4d82fc JJ |
22 | //! The core library is *minimal*: it isn't even aware of heap allocation, |
23 | //! nor does it provide concurrency or I/O. These things require | |
24 | //! platform integration, and this library is platform-agnostic. | |
25 | //! | |
1a4d82fc JJ |
26 | //! # How to use the core library |
27 | //! | |
5bcae85e SL |
28 | //! Please note that all of these details are currently not considered stable. |
29 | //! | |
1a4d82fc JJ |
30 | // FIXME: Fill me in with more detail when the interface settles |
31 | //! This library is built on the assumption of a few existing symbols: | |
32 | //! | |
33 | //! * `memcpy`, `memcmp`, `memset` - These are core memory routines which are | |
34 | //! often generated by LLVM. Additionally, this library can make explicit | |
35 | //! calls to these functions. Their signatures are the same as found in C. | |
36 | //! These functions are often provided by the system libc, but can also be | |
c34b1796 | 37 | //! provided by the [rlibc crate](https://crates.io/crates/rlibc). |
1a4d82fc | 38 | //! |
041b39d2 XL |
39 | //! * `rust_begin_panic` - This function takes four arguments, a |
40 | //! `fmt::Arguments`, a `&'static str`, and two `u32`'s. These four arguments | |
5bcae85e | 41 | //! dictate the panic message, the file at which panic was invoked, and the |
041b39d2 XL |
42 | //! line and column inside the file. It is up to consumers of this core |
43 | //! library to define this panic function; it is only required to never | |
94b46f34 | 44 | //! return. This requires a `lang` attribute named `panic_impl`. |
9e0c209e SL |
45 | //! |
46 | //! * `rust_eh_personality` - is used by the failure mechanisms of the | |
47 | //! compiler. This is often mapped to GCC's personality function, but crates | |
48 | //! which do not trigger a panic can be assured that this function is never | |
49 | //! called. The `lang` attribute is called `eh_personality`. | |
1a4d82fc JJ |
50 | |
51 | // Since libcore defines many fundamental lang items, all tests live in a | |
52 | // separate crate, libcoretest, to avoid bizarre issues. | |
83c7162d XL |
53 | // |
54 | // Here we explicitly #[cfg]-out this whole crate when testing. If we don't do | |
55 | // this, both the generated test artifact and the linked libtest (which | |
56 | // transitively includes libcore) will both define the same set of lang items, | |
57 | // and this will cause the E0152 "duplicate lang item found" error. See | |
58 | // discussion in #50466 for details. | |
59 | // | |
60 | // This cfg won't affect doc tests. | |
61 | #![cfg(not(test))] | |
1a4d82fc | 62 | |
92a42be0 | 63 | #![stable(feature = "core", since = "1.6.0")] |
e9174d1e | 64 | #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", |
62682a34 | 65 | html_favicon_url = "https://doc.rust-lang.org/favicon.ico", |
e9174d1e SL |
66 | html_root_url = "https://doc.rust-lang.org/nightly/", |
67 | html_playground_url = "https://play.rust-lang.org/", | |
92a42be0 SL |
68 | issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/", |
69 | test(no_crate_inject, attr(deny(warnings))), | |
70 | test(attr(allow(dead_code, deprecated, unused_variables, unused_mut))))] | |
1a4d82fc | 71 | |
e9174d1e | 72 | #![no_core] |
1a4d82fc | 73 | #![deny(missing_docs)] |
54a0048b | 74 | #![deny(missing_debug_implementations)] |
1a4d82fc | 75 | |
e9174d1e | 76 | #![feature(allow_internal_unstable)] |
94b46f34 | 77 | #![feature(arbitrary_self_types)] |
a7813a04 | 78 | #![feature(asm)] |
62682a34 | 79 | #![feature(associated_type_defaults)] |
0531ce1d | 80 | #![feature(attr_literals)] |
cc61c64b | 81 | #![feature(cfg_target_has_atomic)] |
e9174d1e SL |
82 | #![feature(concat_idents)] |
83 | #![feature(const_fn)] | |
94b46f34 | 84 | #![feature(const_int_ops)] |
83c7162d | 85 | #![feature(core_float)] |
e9174d1e | 86 | #![feature(custom_attribute)] |
0531ce1d XL |
87 | #![feature(doc_cfg)] |
88 | #![feature(doc_spotlight)] | |
83c7162d | 89 | #![feature(extern_types)] |
e9174d1e | 90 | #![feature(fundamental)] |
62682a34 | 91 | #![feature(intrinsics)] |
0531ce1d | 92 | #![feature(iterator_flatten)] |
62682a34 | 93 | #![feature(lang_items)] |
0531ce1d | 94 | #![feature(link_llvm_intrinsics)] |
cc61c64b | 95 | #![feature(never_type)] |
0531ce1d XL |
96 | #![feature(exhaustive_patterns)] |
97 | #![feature(macro_at_most_once_rep)] | |
e9174d1e | 98 | #![feature(no_core)] |
85aaf69f | 99 | #![feature(on_unimplemented)] |
c34b1796 | 100 | #![feature(optin_builtin_traits)] |
cc61c64b | 101 | #![feature(prelude_import)] |
9cc50fc6 | 102 | #![feature(repr_simd, platform_intrinsics)] |
94b46f34 | 103 | #![cfg_attr(stage0, feature(repr_transparent))] |
54a0048b | 104 | #![feature(rustc_attrs)] |
0531ce1d XL |
105 | #![feature(rustc_const_unstable)] |
106 | #![feature(simd_ffi)] | |
83c7162d XL |
107 | #![feature(core_slice_ext)] |
108 | #![feature(core_str_ext)] | |
54a0048b | 109 | #![feature(specialization)] |
e9174d1e | 110 | #![feature(staged_api)] |
0531ce1d | 111 | #![feature(stmt_expr_attributes)] |
e9174d1e | 112 | #![feature(unboxed_closures)] |
cc61c64b XL |
113 | #![feature(untagged_unions)] |
114 | #![feature(unwind_attributes)] | |
83c7162d XL |
115 | #![feature(doc_alias)] |
116 | #![feature(inclusive_range_methods)] | |
94b46f34 XL |
117 | #![feature(mmx_target_feature)] |
118 | #![feature(tbm_target_feature)] | |
119 | #![feature(sse4a_target_feature)] | |
120 | #![feature(arm_target_feature)] | |
121 | #![feature(powerpc_target_feature)] | |
122 | #![feature(mips_target_feature)] | |
123 | #![feature(aarch64_target_feature)] | |
124 | #![feature(const_slice_len)] | |
125 | #![feature(const_str_as_bytes)] | |
126 | #![feature(const_str_len)] | |
ea8adc8c | 127 | |
9e0c209e SL |
128 | #[prelude_import] |
129 | #[allow(unused)] | |
130 | use prelude::v1::*; | |
5bcae85e | 131 | |
1a4d82fc JJ |
132 | #[macro_use] |
133 | mod macros; | |
134 | ||
c30ab7b3 SL |
135 | #[macro_use] |
136 | mod internal_macros; | |
137 | ||
1a4d82fc JJ |
138 | #[path = "num/int_macros.rs"] |
139 | #[macro_use] | |
140 | mod int_macros; | |
141 | ||
142 | #[path = "num/uint_macros.rs"] | |
143 | #[macro_use] | |
144 | mod uint_macros; | |
145 | ||
5bcae85e SL |
146 | #[path = "num/isize.rs"] pub mod isize; |
147 | #[path = "num/i8.rs"] pub mod i8; | |
148 | #[path = "num/i16.rs"] pub mod i16; | |
149 | #[path = "num/i32.rs"] pub mod i32; | |
150 | #[path = "num/i64.rs"] pub mod i64; | |
94b46f34 | 151 | #[path = "num/i128.rs"] pub mod i128; |
32a655c1 | 152 | |
1a4d82fc | 153 | #[path = "num/usize.rs"] pub mod usize; |
5bcae85e SL |
154 | #[path = "num/u8.rs"] pub mod u8; |
155 | #[path = "num/u16.rs"] pub mod u16; | |
156 | #[path = "num/u32.rs"] pub mod u32; | |
157 | #[path = "num/u64.rs"] pub mod u64; | |
94b46f34 | 158 | #[path = "num/u128.rs"] pub mod u128; |
32a655c1 | 159 | |
1a4d82fc JJ |
160 | #[path = "num/f32.rs"] pub mod f32; |
161 | #[path = "num/f64.rs"] pub mod f64; | |
162 | ||
9346a6ac | 163 | #[macro_use] |
1a4d82fc JJ |
164 | pub mod num; |
165 | ||
166 | /* The libcore prelude, not as all-encompassing as the libstd prelude */ | |
167 | ||
168 | pub mod prelude; | |
169 | ||
170 | /* Core modules for ownership management */ | |
171 | ||
172 | pub mod intrinsics; | |
173 | pub mod mem; | |
1a4d82fc | 174 | pub mod ptr; |
83c7162d | 175 | pub mod hint; |
1a4d82fc JJ |
176 | |
177 | /* Core language traits */ | |
178 | ||
179 | pub mod marker; | |
180 | pub mod ops; | |
181 | pub mod cmp; | |
182 | pub mod clone; | |
183 | pub mod default; | |
c34b1796 | 184 | pub mod convert; |
e9174d1e | 185 | pub mod borrow; |
1a4d82fc JJ |
186 | |
187 | /* Core types and methods on primitives */ | |
188 | ||
189 | pub mod any; | |
c34b1796 | 190 | pub mod array; |
0531ce1d | 191 | pub mod ascii; |
e9174d1e | 192 | pub mod sync; |
1a4d82fc JJ |
193 | pub mod cell; |
194 | pub mod char; | |
0531ce1d | 195 | pub mod panic; |
1a4d82fc | 196 | pub mod panicking; |
1a4d82fc JJ |
197 | pub mod iter; |
198 | pub mod option; | |
199 | pub mod raw; | |
200 | pub mod result; | |
e9174d1e | 201 | |
1a4d82fc JJ |
202 | pub mod slice; |
203 | pub mod str; | |
204 | pub mod hash; | |
205 | pub mod fmt; | |
2c00a5a8 | 206 | pub mod time; |
85aaf69f | 207 | |
83c7162d XL |
208 | pub mod unicode; |
209 | ||
94b46f34 XL |
210 | /* Async */ |
211 | pub mod future; | |
212 | pub mod task; | |
213 | ||
0531ce1d XL |
214 | /* Heap memory allocator trait */ |
215 | #[allow(missing_docs)] | |
83c7162d XL |
216 | pub mod alloc; |
217 | ||
1a4d82fc | 218 | // note: does not need to be public |
3157f602 | 219 | mod iter_private; |
94b46f34 | 220 | mod nonzero; |
1a4d82fc | 221 | mod tuple; |
abe05a73 | 222 | mod unit; |
0531ce1d XL |
223 | |
224 | // Pull in the the `coresimd` crate directly into libcore. This is where all the | |
225 | // architecture-specific (and vendor-specific) intrinsics are defined. AKA | |
226 | // things like SIMD and such. Note that the actual source for all this lies in a | |
227 | // different repository, rust-lang-nursery/stdsimd. That's why the setup here is | |
228 | // a bit wonky. | |
83c7162d XL |
229 | #[allow(unused_macros)] |
230 | macro_rules! test_v16 { ($item:item) => {}; } | |
231 | #[allow(unused_macros)] | |
232 | macro_rules! test_v32 { ($item:item) => {}; } | |
233 | #[allow(unused_macros)] | |
234 | macro_rules! test_v64 { ($item:item) => {}; } | |
235 | #[allow(unused_macros)] | |
236 | macro_rules! test_v128 { ($item:item) => {}; } | |
237 | #[allow(unused_macros)] | |
238 | macro_rules! test_v256 { ($item:item) => {}; } | |
239 | #[allow(unused_macros)] | |
240 | macro_rules! test_v512 { ($item:item) => {}; } | |
241 | #[allow(unused_macros)] | |
242 | macro_rules! vector_impl { ($([$f:ident, $($args:tt)*]),*) => { $($f!($($args)*);)* } } | |
0531ce1d | 243 | #[path = "../stdsimd/coresimd/mod.rs"] |
83c7162d | 244 | #[allow(missing_docs, missing_debug_implementations, dead_code, unused_imports)] |
0531ce1d XL |
245 | #[unstable(feature = "stdsimd", issue = "48556")] |
246 | #[cfg(not(stage0))] // allow changes to how stdsimd works in stage0 | |
247 | mod coresimd; | |
248 | ||
249 | #[unstable(feature = "stdsimd", issue = "48556")] | |
250 | #[cfg(not(stage0))] | |
251 | pub use coresimd::simd; | |
83c7162d | 252 | #[stable(feature = "simd_arch", since = "1.27.0")] |
0531ce1d XL |
253 | #[cfg(not(stage0))] |
254 | pub use coresimd::arch; |