lib.rs.html -- source
Description: Source to the Rust file `/usr/obj/ports/rust-1.16.0/rustc-1.16.0-src/src/liballoc/lib.rs`.
Keywords: rust, rustlang, rust-lang

      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

    // 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 allocation library
    //!
    //! This is the lowest level library through which allocation in Rust can be
    //! performed.
    //!
    //! This library, like libcore, is not intended for general usage, but rather as
    //! a building block of other libraries. The types and interfaces in this
    //! library are reexported through the [standard library](../std/index.html),
    //! and should not be used through this library.
    //!
    //! Currently, there are four major definitions in this library.
    //!
    //! ## Boxed values
    //!
    //! The [`Box`](boxed/index.html) type is a smart pointer type. There can
    //! only be one owner of a `Box`, and the owner can decide to mutate the
    //! contents, which live on the heap.
    //!
    //! This type can be sent among threads efficiently as the size of a `Box` value
    //! is the same as that of a pointer. Tree-like data structures are often built
    //! with boxes because each node often has only one owner, the parent.
    //!
    //! ## Reference counted pointers
    //!
    //! The [`Rc`](rc/index.html) type is a non-threadsafe reference-counted pointer
    //! type intended for sharing memory within a thread. An `Rc` pointer wraps a
    //! type, `T`, and only allows access to `&T`, a shared reference.
    //!
    //! This type is useful when inherited mutability (such as using `Box`) is too
    //! constraining for an application, and is often paired with the `Cell` or
    //! `RefCell` types in order to allow mutation.
    //!
    //! ## Atomically reference counted pointers
    //!
    //! The [`Arc`](arc/index.html) type is the threadsafe equivalent of the `Rc`
    //! type. It provides all the same functionality of `Rc`, except it requires
    //! that the contained type `T` is shareable. Additionally, `Arc<T>` is itself
    //! sendable while `Rc<T>` is not.
    //!
    //! This type allows for shared access to the contained data, and is often
    //! paired with synchronization primitives such as mutexes to allow mutation of
    //! shared resources.
    //!
    //! ## Heap interfaces
    //!
    //! The [`heap`](heap/index.html) module defines the low-level interface to the
    //! default global allocator. It is not compatible with the libc allocator API.

    #![crate_name = "alloc"]
    #![crate_type = "rlib"]
    #![allow(unused_attributes)]
    #![unstable(feature = "alloc",
                reason = "this library is unlikely to be stabilized in its current \
                          form or name",
                issue = "27783")]
    #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
           html_favicon_url = "https://doc.rust-lang.org/favicon.ico",
           html_root_url = "https://doc.rust-lang.org/nightly/",
           issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/",
           test(no_crate_inject, attr(allow(unused_variables), deny(warnings))))]
    #![no_std]
    #![needs_allocator]
    #![deny(warnings)]

    #![feature(allocator)]
    #![feature(box_syntax)]
    #![feature(cfg_target_has_atomic)]
    #![feature(coerce_unsized)]
    #![feature(const_fn)]
    #![feature(core_intrinsics)]
    #![feature(custom_attribute)]
    #![feature(dropck_eyepatch)]
    #![cfg_attr(not(test), feature(exact_size_is_empty))]
    #![feature(fundamental)]
    #![feature(generic_param_attrs)]
    #![feature(lang_items)]
    #![feature(needs_allocator)]
    #![feature(optin_builtin_traits)]
    #![feature(placement_in_syntax)]
    #![feature(shared)]
    #![feature(staged_api)]
    #![feature(unboxed_closures)]
    #![feature(unique)]
    #![feature(unsize)]

    #![cfg_attr(not(test), feature(fused, fn_traits, placement_new_protocol))]
    #![cfg_attr(test, feature(test, box_heap))]

    // Allow testing this library

    #[cfg(test)]
    #[macro_use]
    extern crate std;

    // Module with internal macros used by other modules (needs to be included before other modules).
    #[macro_use]
    mod macros;

    // Heaps provided for low-level allocation strategies

    pub mod heap;

    // Primitive types using the heaps above

    // Need to conditionally define the mod from `boxed.rs` to avoid
    // duplicating the lang-items when building in test cfg; but also need
    // to allow code to have `use boxed::HEAP;`
    // and `use boxed::Box;` declarations.
    #[cfg(not(test))]
    pub mod boxed;
    #[cfg(test)]
    mod boxed {
        pub use std::boxed::{Box, HEAP};
    }
    #[cfg(test)]
    mod boxed_test;
    #[cfg(target_has_atomic = "ptr")]
    pub mod arc;
    pub mod rc;
    pub mod raw_vec;
    pub mod oom;

    pub use oom::oom;

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand 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`)