      1
      2
      3
      4
      5
      6
      7
      8
      9
     10
     11
     12
     13
     14
     15
     16
     17
     18
     19
     20
     21
     22
     23
     24
     25
     26
     27
     28
     29
     30
     31
     32
     33
     34
     35
     36
     37
     38
     39
     40
     41
     42
     43
     44
     45
     46
     47
     48
     49
     50
     51
     52
     53
     54
     55
     56
     57
     58
     59
     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178

    // Copyright 2014 The Rust Project Developers. See the COPYRIGHT
    // file at the top-level directory of this distribution and at
    // http://rust-lang.org/COPYRIGHT.
    //
    // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
    // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
    // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
    // option. This file may not be copied, modified, or distributed
    // except according to those terms.

    //! # The Rust Core Library
    //!
    //! The Rust Core Library is the dependency-free[^free] foundation of [The
    //! Rust Standard Library](../std/index.html). It is the portable glue
    //! between the language and its libraries, defining the intrinsic and
    //! primitive building blocks of all Rust code. It links to no
    //! upstream libraries, no system libraries, and no libc.
    //!
    //! [^free]: Strictly speaking, there are some symbols which are needed but
    //!          they aren't always necessary.
    //!
    //! The core library is *minimal*: it isn't even aware of heap allocation,
    //! nor does it provide concurrency or I/O. These things require
    //! platform integration, and this library is platform-agnostic.
    //!
    //! # How to use the core library
    //!
    //! Please note that all of these details are currently not considered stable.
    //!
    // FIXME: Fill me in with more detail when the interface settles
    //! This library is built on the assumption of a few existing symbols:
    //!
    //! * `memcpy`, `memcmp`, `memset` - These are core memory routines which are
    //!   often generated by LLVM. Additionally, this library can make explicit
    //!   calls to these functions. Their signatures are the same as found in C.
    //!   These functions are often provided by the system libc, but can also be
    //!   provided by the [rlibc crate](https://crates.io/crates/rlibc).
    //!
    //! * `rust_begin_panic` - This function takes four arguments, a
    //!   `fmt::Arguments`, a `&'static str`, and two `u32`'s. These four arguments
    //!   dictate the panic message, the file at which panic was invoked, and the
    //!   line and column inside the file. It is up to consumers of this core
    //!   library to define this panic function; it is only required to never
    //!   return. This requires a `lang` attribute named `panic_fmt`.
    //!
    //! * `rust_eh_personality` - is used by the failure mechanisms of the
    //!    compiler. This is often mapped to GCC's personality function, but crates
    //!    which do not trigger a panic can be assured that this function is never
    //!    called. The `lang` attribute is called `eh_personality`.

    // Since libcore defines many fundamental lang items, all tests live in a
    // separate crate, libcoretest, to avoid bizarre issues.

    #![stable(feature = "core", since = "1.6.0")]
    #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
           html_favicon_url = "../../rust-logo-32x32-blk.png",
           html_root_url = "https://doc.rust-lang.org/nightly/",
           html_playground_url = "https://play.rust-lang.org/",
           issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/",
           test(no_crate_inject, attr(deny(warnings))),
           test(attr(allow(dead_code, deprecated, unused_variables, unused_mut))))]

    #![no_core]
    #![deny(missing_docs)]
    #![deny(missing_debug_implementations)]
    #![deny(warnings)]

    #![feature(allow_internal_unstable)]
    #![feature(asm)]
    #![feature(associated_type_defaults)]
    #![feature(cfg_target_feature)]
    #![feature(cfg_target_has_atomic)]
    #![feature(concat_idents)]
    #![feature(const_fn)]
    #![feature(custom_attribute)]
    #![feature(fundamental)]
    #![feature(i128_type)]
    #![feature(inclusive_range_syntax)]
    #![feature(intrinsics)]
    #![feature(lang_items)]
    #![feature(never_type)]
    #![feature(no_core)]
    #![feature(on_unimplemented)]
    #![feature(optin_builtin_traits)]
    #![feature(prelude_import)]
    #![feature(repr_simd, platform_intrinsics)]
    #![feature(rustc_attrs)]
    #![feature(specialization)]
    #![feature(staged_api)]
    #![feature(unboxed_closures)]
    #![feature(untagged_unions)]
    #![feature(unwind_attributes)]
    #![feature(doc_spotlight)]
    #![feature(rustc_const_unstable)]

    #[prelude_import]
    #[allow(unused)]
    use prelude::v1::*;

    #[macro_use]
    mod macros;

    #[macro_use]
    mod internal_macros;

    #[path = "num/int_macros.rs"]
    #[macro_use]
    mod int_macros;

    #[path = "num/uint_macros.rs"]
    #[macro_use]
    mod uint_macros;

    #[path = "num/isize.rs"] pub mod isize;
    #[path = "num/i8.rs"]    pub mod i8;
    #[path = "num/i16.rs"]   pub mod i16;
    #[path = "num/i32.rs"]   pub mod i32;
    #[path = "num/i64.rs"]   pub mod i64;
    #[path = "num/i128.rs"]   pub mod i128;

    #[path = "num/usize.rs"] pub mod usize;
    #[path = "num/u8.rs"]    pub mod u8;
    #[path = "num/u16.rs"]   pub mod u16;
    #[path = "num/u32.rs"]   pub mod u32;
    #[path = "num/u64.rs"]   pub mod u64;
    #[path = "num/u128.rs"]   pub mod u128;

    #[path = "num/f32.rs"]   pub mod f32;
    #[path = "num/f64.rs"]   pub mod f64;

    #[macro_use]
    pub mod num;

    /* The libcore prelude, not as all-encompassing as the libstd prelude */

    pub mod prelude;

    /* Core modules for ownership management */

    pub mod intrinsics;
    pub mod mem;
    pub mod nonzero;
    pub mod ptr;

    /* Core language traits */

    pub mod marker;
    pub mod ops;
    pub mod cmp;
    pub mod clone;
    pub mod default;
    pub mod convert;
    pub mod borrow;

    /* Core types and methods on primitives */

    pub mod any;
    pub mod array;
    pub mod sync;
    pub mod cell;
    pub mod char;
    pub mod panicking;
    pub mod iter;
    pub mod option;
    pub mod raw;
    pub mod result;

    pub mod slice;
    pub mod str;
    pub mod hash;
    pub mod fmt;
    pub mod time;

    // note: does not need to be public
    mod char_private;
    mod iter_private;
    mod tuple;
    mod unit;

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)