src/libcore/lib.rs

   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 //!
  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.
  18 //!
  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.
  22 //!
  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.
  28 //!
  29 //! # How to use the core library
  30 //!
  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:
  33 //!
  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
  39 //!   distribution.
  40 //!
  41 //! * `rust_begin_unwind` - This function takes three arguments, a
  42 //!   `fmt::Arguments`, a `&str`, and a `uint`. These three arguments dictate
  43 //!   the panic message, the file at which panic was invoked, and the line.
  44 //!   It is up to consumers of this core library to define this panic
  45 //!   function; it is only required to never return.
  46
  47 // Since libcore defines many fundamental lang items, all tests live in a
  48 // separate crate, libcoretest, to avoid bizarre issues.
  49
  50 #![crate_name = "core"]
  51 #![experimental]
  52 #![staged_api]
  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/nightly/",
  57        html_playground_url = "http://play.rust-lang.org/")]
  58
  59 #![no_std]
  60 #![allow(unknown_features, raw_pointer_derive)]
  61 #![feature(intrinsics, lang_items)]
  62 #![feature(simd, unsafe_destructor, slicing_syntax)]
  63 #![feature(unboxed_closures)]
  64 #![deny(missing_docs)]
  65
  66 #[macro_use]
  67 mod macros;
  68
  69 #[path = "num/float_macros.rs"]
  70 #[macro_use]
  71 mod float_macros;
  72
  73 #[path = "num/int_macros.rs"]
  74 #[macro_use]
  75 mod int_macros;
  76
  77 #[path = "num/uint_macros.rs"]
  78 #[macro_use]
  79 mod uint_macros;
  80
  81 #[path = "num/int.rs"]  pub mod int;
  82 #[path = "num/i8.rs"]   pub mod i8;
  83 #[path = "num/i16.rs"]  pub mod i16;
  84 #[path = "num/i32.rs"]  pub mod i32;
  85 #[path = "num/i64.rs"]  pub mod i64;
  86
  87 #[path = "num/uint.rs"] pub mod uint;
  88 #[path = "num/u8.rs"]   pub mod u8;
  89 #[path = "num/u16.rs"]  pub mod u16;
  90 #[path = "num/u32.rs"]  pub mod u32;
  91 #[path = "num/u64.rs"]  pub mod u64;
  92
  93 #[path = "num/f32.rs"]   pub mod f32;
  94 #[path = "num/f64.rs"]   pub mod f64;
  95
  96 pub mod num;
  97
  98 /* The libcore prelude, not as all-encompassing as the libstd prelude */
  99
 100 pub mod prelude;
 101
 102 /* Core modules for ownership management */
 103
 104 pub mod intrinsics;
 105 pub mod mem;
 106 pub mod nonzero;
 107 pub mod ptr;
 108
 109 /* Core language traits */
 110
 111 pub mod marker;
 112 pub mod ops;
 113 pub mod cmp;
 114 pub mod clone;
 115 pub mod default;
 116
 117 /* Core types and methods on primitives */
 118
 119 pub mod any;
 120 pub mod atomic;
 121 pub mod borrow;
 122 pub mod cell;
 123 pub mod char;
 124 pub mod panicking;
 125 pub mod finally;
 126 pub mod iter;
 127 pub mod option;
 128 pub mod raw;
 129 pub mod result;
 130 pub mod simd;
 131 pub mod slice;
 132 pub mod str;
 133 pub mod hash;
 134 pub mod fmt;
 135
 136 // note: does not need to be public
 137 mod tuple;
 138 mod array;
 139
 140 #[doc(hidden)]
 141 mod core {
 142     pub use panicking;
 143     pub use fmt;
 144 }
 145
 146 #[doc(hidden)]
 147 mod std {
 148     pub use clone;
 149     pub use cmp;
 150     #[cfg(stage0)]
 151     pub use marker as kinds;
 152     pub use marker;
 153     pub use option;
 154     pub use fmt;
 155     pub use hash;
 156 }