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.
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.
11 //! # The Rust Core Library
13 //! The Rust Core Library is the dependency-free[^free] foundation of [The
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.
19 //! [^free]: Strictly speaking, there are some symbols which are needed but
20 //! they aren't always necessary.
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.
26 //! # How to use the core library
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:
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
35 //! provided by the [rlibc crate](https://crates.io/crates/rlibc).
37 //! * `rust_begin_unwind` - This function takes three arguments, a
38 //! `fmt::Arguments`, a `&str`, and a `u32`. These three arguments dictate
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.
43 // Since libcore defines many fundamental lang items, all tests live in a
44 // separate crate, libcoretest, to avoid bizarre issues.
46 // Do not remove on snapshot creation. Needed for bootstrap. (Issue #22364)
47 #![cfg_attr(stage0, feature(custom_attribute))]
48 #![crate_name = "core"]
49 #![stable(feature = "core", since = "1.6.0")]
50 #![cfg_attr(stage0, staged_api)]
51 #![crate_type = "rlib"]
52 #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
53 html_favicon_url = "https://doc.rust-lang.org/favicon.ico",
54 html_root_url = "https://doc.rust-lang.org/nightly/",
55 html_playground_url = "https://play.rust-lang.org/",
56 issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/",
57 test(no_crate_inject, attr(deny(warnings))),
58 test(attr(allow(dead_code, deprecated, unused_variables, unused_mut))))]
61 #![deny(missing_docs)]
63 #![cfg_attr(stage0, feature(rustc_attrs))]
64 #![cfg_attr(stage0, allow(unused_attributes))]
65 #![feature(allow_internal_unstable)]
66 #![feature(associated_type_defaults)]
67 #![feature(concat_idents)]
69 #![feature(custom_attribute)]
70 #![feature(fundamental)]
71 #![feature(intrinsics)]
72 #![feature(lang_items)]
74 #![feature(on_unimplemented)]
75 #![feature(optin_builtin_traits)]
77 #![feature(unwind_attributes)]
78 #![cfg_attr(stage0, feature(simd))]
79 #![cfg_attr(not(stage0), feature(repr_simd, platform_intrinsics))]
80 #![feature(staged_api)]
81 #![feature(unboxed_closures)]
86 #[path = "num/float_macros.rs"]
90 #[path = "num/int_macros.rs"]
94 #[path = "num/uint_macros.rs"]
98 #[path = "num/isize.rs"] pub mod isize;
99 #[path = "num/i8.rs"] pub mod i8;
100 #[path = "num/i16.rs"] pub mod i16;
101 #[path = "num/i32.rs"] pub mod i32;
102 #[path = "num/i64.rs"] pub mod i64;
104 #[path = "num/usize.rs"] pub mod usize;
105 #[path = "num/u8.rs"] pub mod u8;
106 #[path = "num/u16.rs"] pub mod u16;
107 #[path = "num/u32.rs"] pub mod u32;
108 #[path = "num/u64.rs"] pub mod u64;
110 #[path = "num/f32.rs"] pub mod f32;
111 #[path = "num/f64.rs"] pub mod f64;
116 /* The libcore prelude, not as all-encompassing as the libstd prelude */
120 /* Core modules for ownership management */
127 /* Core language traits */
137 /* Core types and methods on primitives */
155 // note: does not need to be public