library/alloc/src/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
  54 //! [`Box`]: boxed
  55 //! [`Cell`]: core::cell
  56 //! [`Rc`]: rc
  57 //! [`RefCell`]: core::cell
  58
  59 // To run liballoc tests without x.py without ending up with two copies of liballoc, Miri needs to be
  60 // able to "empty" this crate. See <https://github.com/rust-lang/miri-test-libstd/issues/4>.
  61 // rustc itself never sets the feature, so this line has no affect there.
  62 #![cfg(any(not(feature = "miri-test-libstd"), test, doctest))]
  63 #![allow(unused_attributes)]
  64 #![stable(feature = "alloc", since = "1.36.0")]
  65 #![doc(
  66     html_playground_url = "https://play.rust-lang.org/",
  67     issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/",
  68     test(no_crate_inject, attr(allow(unused_variables), deny(warnings)))
  69 )]
  70 #![cfg_attr(
  71     not(bootstrap),
  72     doc(cfg_hide(
  73         not(test),
  74         not(any(test, bootstrap)),
  75         any(not(feature = "miri-test-libstd"), test, doctest),
  76         no_global_oom_handling,
  77         not(no_global_oom_handling),
  78         target_has_atomic = "ptr"
  79     ))
  80 )]
  81 #![no_std]
  82 #![needs_allocator]
  83 //
  84 // Lints:
  85 #![deny(unsafe_op_in_unsafe_fn)]
  86 #![warn(deprecated_in_future)]
  87 #![warn(missing_debug_implementations)]
  88 #![warn(missing_docs)]
  89 #![allow(explicit_outlives_requirements)]
  90 //
  91 // Library features:
  92 #![feature(alloc_layout_extra)]
  93 #![feature(allocator_api)]
  94 #![feature(array_chunks)]
  95 #![feature(array_methods)]
  96 #![feature(array_windows)]
  97 #![feature(async_stream)]
  98 #![feature(coerce_unsized)]
  99 #![cfg_attr(not(no_global_oom_handling), feature(const_btree_new))]
 100 #![feature(const_cow_is_borrowed)]
 101 #![feature(core_intrinsics)]
 102 #![feature(dispatch_from_dyn)]
 103 #![feature(exact_size_is_empty)]
 104 #![feature(extend_one)]
 105 #![feature(fmt_internals)]
 106 #![feature(fn_traits)]
 107 #![feature(inplace_iteration)]
 108 #![feature(iter_advance_by)]
 109 #![feature(iter_zip)]
 110 #![feature(layout_for_ptr)]
 111 #![feature(maybe_uninit_extra)]
 112 #![feature(maybe_uninit_slice)]
 113 #![cfg_attr(test, feature(new_uninit))]
 114 #![feature(nonnull_slice_from_raw_parts)]
 115 #![feature(option_result_unwrap_unchecked)]
 116 #![feature(pattern)]
 117 #![feature(ptr_internals)]
 118 #![feature(receiver_trait)]
 119 #![feature(set_ptr_value)]
 120 #![feature(slice_group_by)]
 121 #![feature(slice_ptr_get)]
 122 #![feature(slice_ptr_len)]
 123 #![feature(slice_range)]
 124 #![feature(str_internals)]
 125 #![feature(trusted_len)]
 126 #![feature(trusted_random_access)]
 127 #![feature(try_trait_v2)]
 128 #![feature(unicode_internals)]
 129 #![feature(unsize)]
 130 //
 131 // Language features:
 132 #![feature(allocator_internals)]
 133 #![feature(allow_internal_unstable)]
 134 #![feature(arbitrary_self_types)]
 135 #![feature(associated_type_bounds)]
 136 #![feature(auto_traits)]
 137 #![feature(box_patterns)]
 138 #![feature(box_syntax)]
 139 #![feature(cfg_sanitize)]
 140 #![feature(cfg_target_has_atomic)]
 141 #![feature(const_fn_trait_bound)]
 142 #![feature(const_trait_impl)]
 143 #![feature(decl_macro)]
 144 #![feature(destructuring_assignment)]
 145 #![feature(dropck_eyepatch)]
 146 #![feature(exclusive_range_pattern)]
 147 #![feature(fundamental)]
 148 #![cfg_attr(not(test), feature(generator_trait))]
 149 #![feature(lang_items)]
 150 #![feature(min_specialization)]
 151 #![feature(negative_impls)]
 152 #![feature(never_type)]
 153 #![feature(nll)]
 154 #![feature(rustc_allow_const_fn_unstable)]
 155 #![feature(rustc_attrs)]
 156 #![feature(staged_api)]
 157 #![cfg_attr(test, feature(test))]
 158 #![feature(unboxed_closures)]
 159 #![feature(unsized_fn_params)]
 160 //
 161 // Rustdoc features:
 162 #![feature(doc_cfg)]
 163 #![cfg_attr(not(bootstrap), feature(doc_cfg_hide))]
 164 // Technically, this is a bug in rustdoc: rustdoc sees the documentation on `#[lang = slice_alloc]`
 165 // blocks is for `&[T]`, which also has documentation using this feature in `core`, and gets mad
 166 // that the feature-gate isn't enabled. Ideally, it wouldn't check for the feature gate for docs
 167 // from other crates, but since this can only appear for lang items, it doesn't seem worth fixing.
 168 #![feature(intra_doc_pointers)]
 169
 170 // Allow testing this library
 171 #[cfg(test)]
 172 #[macro_use]
 173 extern crate std;
 174 #[cfg(test)]
 175 extern crate test;
 176
 177 // Module with internal macros used by other modules (needs to be included before other modules).
 178 #[macro_use]
 179 mod macros;
 180
 181 // Heaps provided for low-level allocation strategies
 182
 183 pub mod alloc;
 184
 185 // Primitive types using the heaps above
 186
 187 // Need to conditionally define the mod from `boxed.rs` to avoid
 188 // duplicating the lang-items when building in test cfg; but also need
 189 // to allow code to have `use boxed::Box;` declarations.
 190 #[cfg(not(test))]
 191 pub mod boxed;
 192 #[cfg(test)]
 193 mod boxed {
 194     pub use std::boxed::Box;
 195 }
 196 pub mod borrow;
 197 pub mod collections;
 198 pub mod fmt;
 199 pub mod raw_vec;
 200 pub mod rc;
 201 pub mod slice;
 202 pub mod str;
 203 pub mod string;
 204 #[cfg(target_has_atomic = "ptr")]
 205 pub mod sync;
 206 #[cfg(all(not(no_global_oom_handling), target_has_atomic = "ptr"))]
 207 pub mod task;
 208 #[cfg(test)]
 209 mod tests;
 210 pub mod vec;
 211
 212 #[doc(hidden)]
 213 #[unstable(feature = "liballoc_internals", issue = "none", reason = "implementation detail")]
 214 pub mod __export {
 215     pub use core::format_args;
 216 }