]>
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 | //! | |
28 | // FIXME: Fill me in with more detail when the interface settles | |
29 | //! This library is built on the assumption of a few existing symbols: | |
30 | //! | |
31 | //! * `memcpy`, `memcmp`, `memset` - These are core memory routines which are | |
32 | //! often generated by LLVM. Additionally, this library can make explicit | |
33 | //! calls to these functions. Their signatures are the same as found in C. | |
34 | //! These functions are often provided by the system libc, but can also be | |
c34b1796 | 35 | //! provided by the [rlibc crate](https://crates.io/crates/rlibc). |
1a4d82fc JJ |
36 | //! |
37 | //! * `rust_begin_unwind` - This function takes three arguments, a | |
9346a6ac | 38 | //! `fmt::Arguments`, a `&str`, and a `u32`. These three arguments dictate |
1a4d82fc JJ |
39 | //! the panic message, the file at which panic was invoked, and the line. |
40 | //! It is up to consumers of this core library to define this panic | |
41 | //! function; it is only required to never return. | |
42 | ||
43 | // Since libcore defines many fundamental lang items, all tests live in a | |
44 | // separate crate, libcoretest, to avoid bizarre issues. | |
45 | ||
46 | #![crate_name = "core"] | |
92a42be0 | 47 | #![stable(feature = "core", since = "1.6.0")] |
1a4d82fc | 48 | #![crate_type = "rlib"] |
e9174d1e | 49 | #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", |
62682a34 | 50 | html_favicon_url = "https://doc.rust-lang.org/favicon.ico", |
e9174d1e SL |
51 | html_root_url = "https://doc.rust-lang.org/nightly/", |
52 | html_playground_url = "https://play.rust-lang.org/", | |
92a42be0 SL |
53 | issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/", |
54 | test(no_crate_inject, attr(deny(warnings))), | |
55 | test(attr(allow(dead_code, deprecated, unused_variables, unused_mut))))] | |
1a4d82fc | 56 | |
e9174d1e | 57 | #![no_core] |
1a4d82fc | 58 | #![deny(missing_docs)] |
7453a54e | 59 | #![cfg_attr(not(stage0), deny(warnings))] |
1a4d82fc | 60 | |
e9174d1e | 61 | #![feature(allow_internal_unstable)] |
62682a34 | 62 | #![feature(associated_type_defaults)] |
e9174d1e SL |
63 | #![feature(concat_idents)] |
64 | #![feature(const_fn)] | |
65 | #![feature(custom_attribute)] | |
66 | #![feature(fundamental)] | |
62682a34 SL |
67 | #![feature(intrinsics)] |
68 | #![feature(lang_items)] | |
e9174d1e | 69 | #![feature(no_core)] |
85aaf69f | 70 | #![feature(on_unimplemented)] |
c34b1796 | 71 | #![feature(optin_builtin_traits)] |
c34b1796 | 72 | #![feature(reflect)] |
e9174d1e | 73 | #![feature(unwind_attributes)] |
9cc50fc6 | 74 | #![feature(repr_simd, platform_intrinsics)] |
e9174d1e SL |
75 | #![feature(staged_api)] |
76 | #![feature(unboxed_closures)] | |
85aaf69f | 77 | |
1a4d82fc JJ |
78 | #[macro_use] |
79 | mod macros; | |
80 | ||
81 | #[path = "num/float_macros.rs"] | |
82 | #[macro_use] | |
83 | mod float_macros; | |
84 | ||
85 | #[path = "num/int_macros.rs"] | |
86 | #[macro_use] | |
87 | mod int_macros; | |
88 | ||
89 | #[path = "num/uint_macros.rs"] | |
90 | #[macro_use] | |
91 | mod uint_macros; | |
92 | ||
1a4d82fc JJ |
93 | #[path = "num/isize.rs"] pub mod isize; |
94 | #[path = "num/i8.rs"] pub mod i8; | |
95 | #[path = "num/i16.rs"] pub mod i16; | |
96 | #[path = "num/i32.rs"] pub mod i32; | |
97 | #[path = "num/i64.rs"] pub mod i64; | |
98 | ||
1a4d82fc JJ |
99 | #[path = "num/usize.rs"] pub mod usize; |
100 | #[path = "num/u8.rs"] pub mod u8; | |
101 | #[path = "num/u16.rs"] pub mod u16; | |
102 | #[path = "num/u32.rs"] pub mod u32; | |
103 | #[path = "num/u64.rs"] pub mod u64; | |
104 | ||
105 | #[path = "num/f32.rs"] pub mod f32; | |
106 | #[path = "num/f64.rs"] pub mod f64; | |
107 | ||
9346a6ac | 108 | #[macro_use] |
1a4d82fc JJ |
109 | pub mod num; |
110 | ||
111 | /* The libcore prelude, not as all-encompassing as the libstd prelude */ | |
112 | ||
113 | pub mod prelude; | |
114 | ||
115 | /* Core modules for ownership management */ | |
116 | ||
117 | pub mod intrinsics; | |
118 | pub mod mem; | |
119 | pub mod nonzero; | |
120 | pub mod ptr; | |
121 | ||
122 | /* Core language traits */ | |
123 | ||
124 | pub mod marker; | |
125 | pub mod ops; | |
126 | pub mod cmp; | |
127 | pub mod clone; | |
128 | pub mod default; | |
c34b1796 | 129 | pub mod convert; |
e9174d1e | 130 | pub mod borrow; |
1a4d82fc JJ |
131 | |
132 | /* Core types and methods on primitives */ | |
133 | ||
134 | pub mod any; | |
c34b1796 | 135 | pub mod array; |
e9174d1e | 136 | pub mod sync; |
1a4d82fc JJ |
137 | pub mod cell; |
138 | pub mod char; | |
139 | pub mod panicking; | |
1a4d82fc JJ |
140 | pub mod iter; |
141 | pub mod option; | |
142 | pub mod raw; | |
143 | pub mod result; | |
e9174d1e | 144 | |
1a4d82fc JJ |
145 | pub mod slice; |
146 | pub mod str; | |
147 | pub mod hash; | |
148 | pub mod fmt; | |
85aaf69f | 149 | |
1a4d82fc JJ |
150 | // note: does not need to be public |
151 | mod tuple; |