src/liballoc/lib.rs

   1 // Copyright 2014-2017 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 allocation and collections library
  12 //!
  13 //! This library provides smart pointers and collections for managing
  14 //! heap-allocated values.
  15 //!
  16 //! This library, like libcore, is not intended for general usage, but rather as
  17 //! a building block of other libraries. The types and interfaces in this
  18 //! library are reexported through the [standard library](../std/index.html),
  19 //! and should not be used through this library.
  20 //!
  21 //! ## Boxed values
  22 //!
  23 //! The [`Box`](boxed/index.html) type is a smart pointer type. There can
  24 //! only be one owner of a `Box`, and the owner can decide to mutate the
  25 //! contents, which live on the heap.
  26 //!
  27 //! This type can be sent among threads efficiently as the size of a `Box` value
  28 //! is the same as that of a pointer. Tree-like data structures are often built
  29 //! with boxes because each node often has only one owner, the parent.
  30 //!
  31 //! ## Reference counted pointers
  32 //!
  33 //! The [`Rc`](rc/index.html) type is a non-threadsafe reference-counted pointer
  34 //! type intended for sharing memory within a thread. An `Rc` pointer wraps a
  35 //! type, `T`, and only allows access to `&T`, a shared reference.
  36 //!
  37 //! This type is useful when inherited mutability (such as using `Box`) is too
  38 //! constraining for an application, and is often paired with the `Cell` or
  39 //! `RefCell` types in order to allow mutation.
  40 //!
  41 //! ## Atomically reference counted pointers
  42 //!
  43 //! The [`Arc`](arc/index.html) type is the threadsafe equivalent of the `Rc`
  44 //! type. It provides all the same functionality of `Rc`, except it requires
  45 //! that the contained type `T` is shareable. Additionally, `Arc<T>` is itself
  46 //! sendable while `Rc<T>` is not.
  47 //!
  48 //! This type allows for shared access to the contained data, and is often
  49 //! paired with synchronization primitives such as mutexes to allow mutation of
  50 //! shared resources.
  51 //!
  52 //! ## Collections
  53 //!
  54 //! Implementations of the most common general purpose data structures are
  55 //! defined in this library. They are reexported through the
  56 //! [standard collections library](../std/collections/index.html).
  57 //!
  58 //! ## Heap interfaces
  59 //!
  60 //! The [`heap`](heap/index.html) module defines the low-level interface to the
  61 //! default global allocator. It is not compatible with the libc allocator API.
  62
  63 #![allow(unused_attributes)]
  64 #![unstable(feature = "alloc",
  65             reason = "this library is unlikely to be stabilized in its current \
  66                       form or name",
  67             issue = "27783")]
  68 #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
  69        html_favicon_url = "https://doc.rust-lang.org/favicon.ico",
  70        html_root_url = "https://doc.rust-lang.org/nightly/",
  71        issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/",
  72        test(no_crate_inject, attr(allow(unused_variables), deny(warnings))))]
  73 #![no_std]
  74 #![needs_allocator]
  75 #![deny(warnings)]
  76 #![deny(missing_debug_implementations)]
  77
  78 #![cfg_attr(test, allow(deprecated))] // rand
  79 #![cfg_attr(test, feature(placement_in))]
  80 #![cfg_attr(not(test), feature(core_float))]
  81 #![cfg_attr(not(test), feature(exact_size_is_empty))]
  82 #![cfg_attr(not(test), feature(slice_rotate))]
  83 #![cfg_attr(not(test), feature(generator_trait))]
  84 #![cfg_attr(test, feature(rand, test))]
  85 #![feature(allow_internal_unstable)]
  86 #![feature(box_patterns)]
  87 #![feature(box_syntax)]
  88 #![feature(cfg_target_has_atomic)]
  89 #![feature(coerce_unsized)]
  90 #![feature(const_fn)]
  91 #![feature(core_intrinsics)]
  92 #![feature(custom_attribute)]
  93 #![feature(dropck_eyepatch)]
  94 #![feature(exact_size_is_empty)]
  95 #![feature(fmt_internals)]
  96 #![feature(fundamental)]
  97 #![feature(fused)]
  98 #![feature(generic_param_attrs)]
  99 #![feature(i128_type)]
 100 #![feature(inclusive_range)]
 101 #![feature(iter_rfold)]
 102 #![feature(lang_items)]
 103 #![feature(needs_allocator)]
 104 #![feature(nonzero)]
 105 #![feature(offset_to)]
 106 #![feature(optin_builtin_traits)]
 107 #![feature(pattern)]
 108 #![feature(placement_in_syntax)]
 109 #![feature(placement_new_protocol)]
 110 #![feature(rustc_attrs)]
 111 #![feature(shared)]
 112 #![feature(slice_get_slice)]
 113 #![feature(slice_patterns)]
 114 #![feature(slice_rsplit)]
 115 #![feature(specialization)]
 116 #![feature(staged_api)]
 117 #![feature(str_internals)]
 118 #![feature(trusted_len)]
 119 #![feature(unboxed_closures)]
 120 #![feature(unicode)]
 121 #![feature(unique)]
 122 #![feature(unsize)]
 123 #![feature(allocator_internals)]
 124 #![feature(on_unimplemented)]
 125
 126 #![cfg_attr(not(test), feature(fused, fn_traits, placement_new_protocol, swap_with_slice, i128))]
 127 #![cfg_attr(test, feature(test, box_heap))]
 128
 129 // Allow testing this library
 130
 131 #[cfg(test)]
 132 #[macro_use]
 133 extern crate std;
 134 #[cfg(test)]
 135 extern crate test;
 136
 137 extern crate std_unicode;
 138
 139 // Module with internal macros used by other modules (needs to be included before other modules).
 140 #[macro_use]
 141 mod macros;
 142
 143 // Allocator trait and helper struct definitions
 144
 145 pub mod allocator;
 146
 147 // Heaps provided for low-level allocation strategies
 148
 149 pub mod heap;
 150
 151 // Primitive types using the heaps above
 152
 153 // Need to conditionally define the mod from `boxed.rs` to avoid
 154 // duplicating the lang-items when building in test cfg; but also need
 155 // to allow code to have `use boxed::HEAP;`
 156 // and `use boxed::Box;` declarations.
 157 #[cfg(not(test))]
 158 pub mod boxed;
 159 #[cfg(test)]
 160 mod boxed {
 161     pub use std::boxed::{Box, IntermediateBox, HEAP};
 162 }
 163 #[cfg(test)]
 164 mod boxed_test;
 165 #[cfg(target_has_atomic = "ptr")]
 166 pub mod arc;
 167 pub mod rc;
 168 pub mod raw_vec;
 169
 170 // collections modules
 171 pub mod binary_heap;
 172 mod btree;
 173 pub mod borrow;
 174 pub mod fmt;
 175 pub mod linked_list;
 176 pub mod range;
 177 pub mod slice;
 178 pub mod str;
 179 pub mod string;
 180 pub mod vec;
 181 pub mod vec_deque;
 182
 183 #[stable(feature = "rust1", since = "1.0.0")]
 184 pub mod btree_map {
 185     //! A map based on a B-Tree.
 186     #[stable(feature = "rust1", since = "1.0.0")]
 187     pub use btree::map::*;
 188 }
 189
 190 #[stable(feature = "rust1", since = "1.0.0")]
 191 pub mod btree_set {
 192     //! A set based on a B-Tree.
 193     #[stable(feature = "rust1", since = "1.0.0")]
 194     pub use btree::set::*;
 195 }
 196
 197 #[cfg(not(test))]
 198 mod std {
 199     pub use core::ops;      // RangeFull
 200 }
 201
 202 /// An endpoint of a range of keys.
 203 ///
 204 /// # Examples
 205 ///
 206 /// `Bound`s are range endpoints:
 207 ///
 208 /// ```
 209 /// #![feature(collections_range)]
 210 ///
 211 /// use std::collections::range::RangeArgument;
 212 /// use std::collections::Bound::*;
 213 ///
 214 /// assert_eq!((..100).start(), Unbounded);
 215 /// assert_eq!((1..12).start(), Included(&1));
 216 /// assert_eq!((1..12).end(), Excluded(&12));
 217 /// ```
 218 ///
 219 /// Using a tuple of `Bound`s as an argument to [`BTreeMap::range`].
 220 /// Note that in most cases, it's better to use range syntax (`1..5`) instead.
 221 ///
 222 /// ```
 223 /// use std::collections::BTreeMap;
 224 /// use std::collections::Bound::{Excluded, Included, Unbounded};
 225 ///
 226 /// let mut map = BTreeMap::new();
 227 /// map.insert(3, "a");
 228 /// map.insert(5, "b");
 229 /// map.insert(8, "c");
 230 ///
 231 /// for (key, value) in map.range((Excluded(3), Included(8))) {
 232 ///     println!("{}: {}", key, value);
 233 /// }
 234 ///
 235 /// assert_eq!(Some((&3, &"a")), map.range((Unbounded, Included(5))).next());
 236 /// ```
 237 ///
 238 /// [`BTreeMap::range`]: btree_map/struct.BTreeMap.html#method.range
 239 #[stable(feature = "collections_bound", since = "1.17.0")]
 240 #[derive(Clone, Copy, Debug, Hash, PartialEq, Eq)]
 241 pub enum Bound<T> {
 242     /// An inclusive bound.
 243     #[stable(feature = "collections_bound", since = "1.17.0")]
 244     Included(#[stable(feature = "collections_bound", since = "1.17.0")] T),
 245     /// An exclusive bound.
 246     #[stable(feature = "collections_bound", since = "1.17.0")]
 247     Excluded(#[stable(feature = "collections_bound", since = "1.17.0")] T),
 248     /// An infinite endpoint. Indicates that there is no bound in this direction.
 249     #[stable(feature = "collections_bound", since = "1.17.0")]
 250     Unbounded,
 251 }
 252
 253 /// An intermediate trait for specialization of `Extend`.
 254 #[doc(hidden)]
 255 trait SpecExtend<I: IntoIterator> {
 256     /// Extends `self` with the contents of the given iterator.
 257     fn spec_extend(&mut self, iter: I);
 258 }
 259
 260 #[doc(no_inline)]
 261 pub use binary_heap::BinaryHeap;
 262 #[doc(no_inline)]
 263 pub use btree_map::BTreeMap;
 264 #[doc(no_inline)]
 265 pub use btree_set::BTreeSet;
 266 #[doc(no_inline)]
 267 pub use linked_list::LinkedList;
 268 #[doc(no_inline)]
 269 pub use vec_deque::VecDeque;
 270 #[doc(no_inline)]
 271 pub use string::String;
 272 #[doc(no_inline)]
 273 pub use vec::Vec;