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 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 //! The core library is *minimal*: it isn't even aware of heap allocation,
20 //! nor does it provide concurrency or I/O. These things require
21 //! platform integration, and this library is platform-agnostic.
23 //! *It is not recommended to use the core library*. The stable
24 //! functionality of libcore is reexported from the
25 //! [standard library](../std/index.html). The composition of this library is
26 //! subject to change over time; only the interface exposed through libstd is
27 //! intended to be stable.
29 //! # How to use the core library
31 // FIXME: Fill me in with more detail when the interface settles
32 //! This library is built on the assumption of a few existing symbols:
34 //! * `memcpy`, `memcmp`, `memset` - These are core memory routines which are
35 //! often generated by LLVM. Additionally, this library can make explicit
36 //! calls to these functions. Their signatures are the same as found in C.
37 //! These functions are often provided by the system libc, but can also be
38 //! provided by `librlibc` which is distributed with the standard rust
41 //! * `rust_begin_unwind` - This function takes three arguments, a
42 //! `&fmt::Arguments`, a `&str`, and a `uint`. These three arguments dictate
43 //! the failure message, the file at which failure was invoked, and the line.
44 //! It is up to consumers of this core library to define this failure
45 //! function; it is only required to never return.
47 // Since libcore defines many fundamental lang items, all tests live in a
48 // separate crate, libcoretest, to avoid bizarre issues.
50 #![crate_name = "core"]
52 #![license = "MIT/ASL2"]
53 #![crate_type = "rlib"]
54 #![doc(html_logo_url = "http://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
55 html_favicon_url = "http://www.rust-lang.org/favicon.ico",
56 html_root_url = "http://doc.rust-lang.org/master/",
57 html_playground_url = "http://play.rust-lang.org/")]
60 #![feature(globs, intrinsics, lang_items, macro_rules, managed_boxes, phase)]
61 #![feature(simd, unsafe_destructor)]
66 #[path = "num/float_macros.rs"] mod float_macros;
67 #[path = "num/int_macros.rs"] mod int_macros;
68 #[path = "num/uint_macros.rs"] mod uint_macros;
70 #[path = "num/int.rs"] pub mod int;
71 #[path = "num/i8.rs"] pub mod i8;
72 #[path = "num/i16.rs"] pub mod i16;
73 #[path = "num/i32.rs"] pub mod i32;
74 #[path = "num/i64.rs"] pub mod i64;
76 #[path = "num/uint.rs"] pub mod uint;
77 #[path = "num/u8.rs"] pub mod u8;
78 #[path = "num/u16.rs"] pub mod u16;
79 #[path = "num/u32.rs"] pub mod u32;
80 #[path = "num/u64.rs"] pub mod u64;
82 #[path = "num/f32.rs"] pub mod f32;
83 #[path = "num/f64.rs"] pub mod f64;
87 /* The libcore prelude, not as all-encompassing as the libstd prelude */
91 /* Core modules for ownership management */
97 /* Core language traits */
107 /* Core types and methods on primitives */
124 // FIXME #15320: primitive documentation needs top-level modules, this
125 // should be `core::tuple::unit`.
126 #[path = "tuple/unit.rs"]