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.
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.
11 //! # The Rust core allocation and collections library
13 //! This library provides smart pointers and collections for managing
14 //! heap-allocated values.
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 re-exported through the [standard library](../std/index.html),
19 //! and should not be used through this library.
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.
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.
31 //! ## Reference counted pointers
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.
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.
41 //! ## Atomically reference counted pointers
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.
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
54 //! Implementations of the most common general purpose data structures are
55 //! defined in this library. They are re-exported through the
56 //! [standard collections library](../std/collections/index.html).
58 //! ## Heap interfaces
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.
63 #![allow(unused_attributes)]
64 #![unstable(feature = "alloc",
65 reason = "this library is unlikely to be stabilized in its current \
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))))]
76 #![deny(missing_debug_implementations)]
78 #![cfg_attr(test, allow(deprecated))] // rand
79 #![cfg_attr(not(test), feature(core_float))]
80 #![cfg_attr(not(test), feature(exact_size_is_empty))]
81 #![cfg_attr(not(test), feature(generator_trait))]
82 #![cfg_attr(test, feature(rand, test))]
83 #![feature(allocator_api)]
84 #![feature(allow_internal_unstable)]
85 #![feature(ascii_ctype)]
86 #![feature(box_into_raw_non_null)]
87 #![feature(box_patterns)]
88 #![feature(box_syntax)]
89 #![feature(cfg_target_has_atomic)]
90 #![feature(coerce_unsized)]
91 #![feature(collections_range)]
93 #![feature(core_intrinsics)]
94 #![feature(custom_attribute)]
95 #![feature(dropck_eyepatch)]
96 #![feature(exact_size_is_empty)]
97 #![feature(fmt_internals)]
99 #![feature(fundamental)]
100 #![feature(generic_param_attrs)]
101 #![cfg_attr(stage0, feature(i128_type))]
102 #![feature(lang_items)]
103 #![feature(needs_allocator)]
105 #![feature(offset_to)]
106 #![feature(optin_builtin_traits)]
109 #![feature(ptr_internals)]
110 #![feature(rustc_attrs)]
111 #![feature(slice_get_slice)]
112 #![feature(slice_rsplit)]
113 #![feature(specialization)]
114 #![feature(staged_api)]
115 #![feature(str_internals)]
116 #![feature(trusted_len)]
117 #![feature(try_reserve)]
118 #![feature(unboxed_closures)]
121 #![feature(allocator_internals)]
122 #![feature(on_unimplemented)]
123 #![feature(exact_chunks)]
124 #![feature(pointer_methods)]
125 #![feature(inclusive_range_fields)]
127 #![cfg_attr(not(test), feature(fn_traits, swap_with_slice, i128))]
128 #![cfg_attr(test, feature(test))]
130 // Allow testing this library
140 extern crate std_unicode;
142 // Module with internal macros used by other modules (needs to be included before other modules).
146 #[rustc_deprecated(since = "1.27.0", reason = "use the heap module in core, alloc, or std instead")]
147 #[unstable(feature = "allocator_api", issue = "32838")]
148 pub use core::heap as allocator;
150 // Heaps provided for low-level allocation strategies
154 // Primitive types using the heaps above
156 // Need to conditionally define the mod from `boxed.rs` to avoid
157 // duplicating the lang-items when building in test cfg; but also need
158 // to allow code to have `use boxed::Box;` declarations.
163 pub use std::boxed::Box;
167 #[cfg(target_has_atomic = "ptr")]
172 // collections modules
184 #[stable(feature = "rust1", since = "1.0.0")]
186 //! A map based on a B-Tree.
187 #[stable(feature = "rust1", since = "1.0.0")]
188 pub use btree::map::*;
191 #[stable(feature = "rust1", since = "1.0.0")]
193 //! A set based on a B-Tree.
194 #[stable(feature = "rust1", since = "1.0.0")]
195 pub use btree::set::*;
200 pub use core::ops; // RangeFull
203 /// An intermediate trait for specialization of `Extend`.
205 trait SpecExtend<I: IntoIterator> {
206 /// Extends `self` with the contents of the given iterator.
207 fn spec_extend(&mut self, iter: I);
211 pub use binary_heap::BinaryHeap;
213 pub use btree_map::BTreeMap;
215 pub use btree_set::BTreeSet;
217 pub use linked_list::LinkedList;
219 pub use vec_deque::VecDeque;
221 pub use string::String;