src/liballoc/lib.rs

   1 //! # The Rust core allocation and collections library
   2 //!
   3 //! This library provides smart pointers and collections for managing
   4 //! heap-allocated values.
   5 //!
   6 //! This library, like libcore, normally doesn’t need to be used directly
   7 //! since its contents are re-exported in the [`std` crate](../std/index.html).
   8 //! Crates that use the `#![no_std]` attribute however will typically
   9 //! not depend on `std`, so they’d use this crate instead.
  10 //!
  11 //! ## Boxed values
  12 //!
  13 //! The [`Box`] type is a smart pointer type. There can only be one owner of a
  14 //! [`Box`], and the owner can decide to mutate the contents, which live on the
  15 //! heap.
  16 //!
  17 //! This type can be sent among threads efficiently as the size of a `Box` value
  18 //! is the same as that of a pointer. Tree-like data structures are often built
  19 //! with boxes because each node often has only one owner, the parent.
  20 //!
  21 //! ## Reference counted pointers
  22 //!
  23 //! The [`Rc`] type is a non-threadsafe reference-counted pointer type intended
  24 //! for sharing memory within a thread. An [`Rc`] pointer wraps a type, `T`, and
  25 //! only allows access to `&T`, a shared reference.
  26 //!
  27 //! This type is useful when inherited mutability (such as using [`Box`]) is too
  28 //! constraining for an application, and is often paired with the [`Cell`] or
  29 //! [`RefCell`] types in order to allow mutation.
  30 //!
  31 //! ## Atomically reference counted pointers
  32 //!
  33 //! The [`Arc`] type is the threadsafe equivalent of the [`Rc`] type. It
  34 //! provides all the same functionality of [`Rc`], except it requires that the
  35 //! contained type `T` is shareable. Additionally, [`Arc<T>`][`Arc`] is itself
  36 //! sendable while [`Rc<T>`][`Rc`] is not.
  37 //!
  38 //! This type allows for shared access to the contained data, and is often
  39 //! paired with synchronization primitives such as mutexes to allow mutation of
  40 //! shared resources.
  41 //!
  42 //! ## Collections
  43 //!
  44 //! Implementations of the most common general purpose data structures are
  45 //! defined in this library. They are re-exported through the
  46 //! [standard collections library](../std/collections/index.html).
  47 //!
  48 //! ## Heap interfaces
  49 //!
  50 //! The [`alloc`](alloc/index.html) module defines the low-level interface to the
  51 //! default global allocator. It is not compatible with the libc allocator API.
  52 //!
  53 //! [`Arc`]: sync/index.html
  54 //! [`Box`]: boxed/index.html
  55 //! [`Cell`]: ../core/cell/index.html
  56 //! [`Rc`]: rc/index.html
  57 //! [`RefCell`]: ../core/cell/index.html
  58
  59 #![allow(unused_attributes)]
  60 #![stable(feature = "alloc", since = "1.36.0")]
  61 #![doc(
  62     html_root_url = "https://doc.rust-lang.org/nightly/",
  63     html_playground_url = "https://play.rust-lang.org/",
  64     issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/",
  65     test(no_crate_inject, attr(allow(unused_variables), deny(warnings)))
  66 )]
  67 #![no_std]
  68 #![needs_allocator]
  69 #![warn(deprecated_in_future)]
  70 #![warn(missing_docs)]
  71 #![warn(missing_debug_implementations)]
  72 #![deny(intra_doc_link_resolution_failure)] // rustdoc is run without -D warnings
  73 #![allow(explicit_outlives_requirements)]
  74 #![allow(incomplete_features)]
  75 #![cfg_attr(not(test), feature(generator_trait))]
  76 #![cfg_attr(test, feature(test))]
  77 #![feature(allocator_api)]
  78 #![feature(allow_internal_unstable)]
  79 #![feature(arbitrary_self_types)]
  80 #![feature(box_patterns)]
  81 #![feature(box_syntax)]
  82 #![feature(cfg_sanitize)]
  83 #![feature(cfg_target_has_atomic)]
  84 #![feature(coerce_unsized)]
  85 #![feature(const_btree_new)]
  86 #![feature(const_generic_impls_guard)]
  87 #![feature(const_generics)]
  88 #![feature(const_in_array_repeat_expressions)]
  89 #![feature(const_if_match)]
  90 #![feature(cow_is_borrowed)]
  91 #![feature(dispatch_from_dyn)]
  92 #![feature(core_intrinsics)]
  93 #![feature(container_error_extra)]
  94 #![feature(dropck_eyepatch)]
  95 #![feature(exact_size_is_empty)]
  96 #![feature(extend_one)]
  97 #![feature(fmt_internals)]
  98 #![feature(fn_traits)]
  99 #![feature(fundamental)]
 100 #![feature(internal_uninit_const)]
 101 #![feature(lang_items)]
 102 #![feature(libc)]
 103 #![feature(negative_impls)]
 104 #![feature(new_uninit)]
 105 #![feature(nll)]
 106 #![feature(optin_builtin_traits)]
 107 #![feature(or_patterns)]
 108 #![feature(pattern)]
 109 #![feature(ptr_internals)]
 110 #![feature(ptr_offset_from)]
 111 #![feature(rustc_attrs)]
 112 #![feature(receiver_trait)]
 113 #![feature(min_specialization)]
 114 #![feature(staged_api)]
 115 #![feature(std_internals)]
 116 #![feature(str_internals)]
 117 #![feature(trusted_len)]
 118 #![feature(try_reserve)]
 119 #![feature(unboxed_closures)]
 120 #![feature(unicode_internals)]
 121 #![feature(unsize)]
 122 #![feature(unsized_locals)]
 123 #![feature(allocator_internals)]
 124 #![feature(slice_partition_dedup)]
 125 #![feature(maybe_uninit_extra, maybe_uninit_slice)]
 126 #![feature(alloc_layout_extra)]
 127 #![feature(try_trait)]
 128 #![feature(associated_type_bounds)]
 129
 130 // Allow testing this library
 131
 132 #[cfg(test)]
 133 #[macro_use]
 134 extern crate std;
 135 #[cfg(test)]
 136 extern crate test;
 137
 138 // Module with internal macros used by other modules (needs to be included before other modules).
 139 #[macro_use]
 140 mod macros;
 141
 142 // Heaps provided for low-level allocation strategies
 143
 144 pub mod alloc;
 145
 146 // Primitive types using the heaps above
 147
 148 // Need to conditionally define the mod from `boxed.rs` to avoid
 149 // duplicating the lang-items when building in test cfg; but also need
 150 // to allow code to have `use boxed::Box;` declarations.
 151 #[cfg(not(test))]
 152 pub mod boxed;
 153 #[cfg(test)]
 154 mod boxed {
 155     pub use std::boxed::Box;
 156 }
 157 pub mod borrow;
 158 pub mod collections;
 159 pub mod fmt;
 160 pub mod prelude;
 161 pub mod raw_vec;
 162 pub mod rc;
 163 pub mod slice;
 164 pub mod str;
 165 pub mod string;
 166 #[cfg(target_has_atomic = "ptr")]
 167 pub mod sync;
 168 #[cfg(target_has_atomic = "ptr")]
 169 pub mod task;
 170 #[cfg(test)]
 171 mod tests;
 172 pub mod vec;
 173
 174 #[cfg(not(test))]
 175 mod std {
 176     pub use core::ops; // RangeFull
 177 }
 178
 179 #[doc(hidden)]
 180 #[unstable(feature = "liballoc_internals", issue = "none", reason = "implementation detail")]
 181 pub mod __export {
 182     pub use core::format_args;
 183 }