1//! Collection types.
23// Note: This module is also included in the alloctests crate using #[path] to
4// run the tests. See the comment there for an explanation why this is the case.
56#![stable(feature = "rust1", since = "1.0.0")]
78#[cfg(not(no_global_oom_handling))]
9pub mod binary_heap;
10#[cfg(not(no_global_oom_handling))]
11mod btree;
12#[cfg(not(no_global_oom_handling))]
13pub mod linked_list;
14#[cfg(not(no_global_oom_handling))]
15pub mod vec_deque;
1617#[cfg(not(no_global_oom_handling))]
18#[stable(feature = "rust1", since = "1.0.0")]
19pub mod btree_map {
20//! An ordered map based on a B-Tree.
21#[stable(feature = "rust1", since = "1.0.0")]
22pub use super::btree::map::*;
23}
2425#[cfg(not(no_global_oom_handling))]
26#[stable(feature = "rust1", since = "1.0.0")]
27pub mod btree_set {
28//! An ordered set based on a B-Tree.
29#[stable(feature = "rust1", since = "1.0.0")]
30 #[cfg(not(test))]
31pub use super::btree::set::*;
32}
3334#[cfg(not(test))]
35use core::fmt::Display;
3637#[cfg(not(no_global_oom_handling))]
38#[stable(feature = "rust1", since = "1.0.0")]
39#[doc(no_inline)]
40#[cfg(not(test))]
41pub use binary_heap::BinaryHeap;
42#[cfg(not(no_global_oom_handling))]
43#[stable(feature = "rust1", since = "1.0.0")]
44#[doc(no_inline)]
45#[cfg(not(test))]
46pub use btree_map::BTreeMap;
47#[cfg(not(no_global_oom_handling))]
48#[stable(feature = "rust1", since = "1.0.0")]
49#[doc(no_inline)]
50#[cfg(not(test))]
51pub use btree_set::BTreeSet;
52#[cfg(not(no_global_oom_handling))]
53#[stable(feature = "rust1", since = "1.0.0")]
54#[doc(no_inline)]
55#[cfg(not(test))]
56pub use linked_list::LinkedList;
57#[cfg(not(no_global_oom_handling))]
58#[stable(feature = "rust1", since = "1.0.0")]
59#[doc(no_inline)]
60#[cfg(not(test))]
61pub use vec_deque::VecDeque;
6263#[cfg(not(test))]
64use crate::alloc::{Layout, LayoutError};
6566/// The error type for `try_reserve` methods.
67#[derive(Clone, PartialEq, Eq, Debug)]
68#[stable(feature = "try_reserve", since = "1.57.0")]
69#[cfg(not(test))]
70pub struct TryReserveError {
71 kind: TryReserveErrorKind,
72}
7374#[cfg(test)]
75pub use realalloc::collections::TryReserveError;
7677#[cfg(not(test))]
78impl TryReserveError {
79/// Details about the allocation that caused the error
80#[inline]
81 #[must_use]
82 #[unstable(
83 feature = "try_reserve_kind",
84 reason = "Uncertain how much info should be exposed",
85 issue = "48043"
86)]
87pub fn kind(&self) -> TryReserveErrorKind {
88self.kind.clone()
89 }
90}
9192/// Details of the allocation that caused a `TryReserveError`
93#[derive(Clone, PartialEq, Eq, Debug)]
94#[unstable(
95 feature = "try_reserve_kind",
96 reason = "Uncertain how much info should be exposed",
97 issue = "48043"
98)]
99#[cfg(not(test))]
100pub enum TryReserveErrorKind {
101/// Error due to the computed capacity exceeding the collection's maximum
102 /// (usually `isize::MAX` bytes).
103CapacityOverflow,
104105/// The memory allocator returned an error
106AllocError {
107/// The layout of allocation request that failed
108layout: Layout,
109110#[doc(hidden)]
111 #[unstable(
112 feature = "container_error_extra",
113 issue = "none",
114 reason = "\
115 Enable exposing the allocator’s custom error value \
116 if an associated type is added in the future: \
117 https://github.com/rust-lang/wg-allocators/issues/23"
118)]
119non_exhaustive: (),
120 },
121}
122123#[cfg(test)]
124pub use realalloc::collections::TryReserveErrorKind;
125126#[unstable(
127 feature = "try_reserve_kind",
128 reason = "Uncertain how much info should be exposed",
129 issue = "48043"
130)]
131#[rustc_const_unstable(feature = "const_convert", issue = "143773")]
132#[cfg(not(test))]
133impl const From<TryReserveErrorKind> for TryReserveError {
134#[inline]
135fn from(kind: TryReserveErrorKind) -> Self {
136Self { kind }
137 }
138}
139140#[unstable(feature = "try_reserve_kind", reason = "new API", issue = "48043")]
141#[rustc_const_unstable(feature = "const_convert", issue = "143773")]
142#[cfg(not(test))]
143impl const From<LayoutError> for TryReserveErrorKind {
144/// Always evaluates to [`TryReserveErrorKind::CapacityOverflow`].
145#[inline]
146fn from(_: LayoutError) -> Self {
147 TryReserveErrorKind::CapacityOverflow
148 }
149}
150151#[stable(feature = "try_reserve", since = "1.57.0")]
152#[cfg(not(test))]
153impl Display for TryReserveError {
154fn fmt(
155&self,
156 fmt: &mut core::fmt::Formatter<'_>,
157 ) -> core::result::Result<(), core::fmt::Error> {
158 fmt.write_str("memory allocation failed")?;
159let reason = match self.kind {
160 TryReserveErrorKind::CapacityOverflow => {
161" because the computed capacity exceeded the collection's maximum"
162}
163 TryReserveErrorKind::AllocError { .. } => {
164" because the memory allocator returned an error"
165}
166 };
167 fmt.write_str(reason)
168 }
169}
170171/// An intermediate trait for specialization of `Extend`.
172#[doc(hidden)]
173#[cfg(not(no_global_oom_handling))]
174trait SpecExtend<I: IntoIterator> {
175/// Extends `self` with the contents of the given iterator.
176fn spec_extend(&mut self, iter: I);
177}
178179#[stable(feature = "try_reserve", since = "1.57.0")]
180#[cfg(not(test))]
181impl core::error::Error for TryReserveError {}