]> git.lizzy.rs Git - rust.git/blob - src/libcollections/lib.rs
Rollup merge of #41065 - jorendorff:slice-rsplit-41020, r=alexcrichton
[rust.git] / src / libcollections / lib.rs
1 // Copyright 2013-2014 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 //! Collection types.
12 //!
13 //! See [std::collections](../std/collections/index.html) for a detailed discussion of
14 //! collections in Rust.
15
16 #![crate_name = "collections"]
17 #![crate_type = "rlib"]
18 #![unstable(feature = "collections",
19             reason = "library is unlikely to be stabilized with the current \
20                       layout and name, use std::collections instead",
21             issue = "27783")]
22 #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
23        html_favicon_url = "https://doc.rust-lang.org/favicon.ico",
24        html_root_url = "https://doc.rust-lang.org/nightly/",
25        html_playground_url = "https://play.rust-lang.org/",
26        issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/",
27        test(no_crate_inject, attr(allow(unused_variables), deny(warnings))))]
28
29 #![cfg_attr(test, allow(deprecated))] // rand
30 #![deny(warnings)]
31 #![deny(missing_debug_implementations)]
32
33 #![feature(alloc)]
34 #![feature(allow_internal_unstable)]
35 #![feature(box_patterns)]
36 #![feature(box_syntax)]
37 #![cfg_attr(not(test), feature(char_escape_debug))]
38 #![feature(core_intrinsics)]
39 #![feature(dropck_eyepatch)]
40 #![feature(exact_size_is_empty)]
41 #![feature(fmt_internals)]
42 #![feature(fused)]
43 #![feature(generic_param_attrs)]
44 #![feature(heap_api)]
45 #![feature(inclusive_range)]
46 #![feature(lang_items)]
47 #![feature(nonzero)]
48 #![feature(pattern)]
49 #![feature(placement_in)]
50 #![feature(placement_in_syntax)]
51 #![feature(placement_new_protocol)]
52 #![feature(shared)]
53 #![feature(slice_get_slice)]
54 #![feature(slice_patterns)]
55 #![feature(slice_rsplit)]
56 #![cfg_attr(not(test), feature(sort_unstable))]
57 #![feature(specialization)]
58 #![feature(staged_api)]
59 #![feature(str_internals)]
60 #![feature(trusted_len)]
61 #![feature(unicode)]
62 #![feature(unique)]
63 #![feature(untagged_unions)]
64 #![cfg_attr(not(test), feature(str_checked_slicing))]
65 #![cfg_attr(test, feature(rand, test))]
66 #![feature(offset_to)]
67
68 #![no_std]
69
70 extern crate std_unicode;
71 extern crate alloc;
72
73 #[cfg(test)]
74 #[macro_use]
75 extern crate std;
76 #[cfg(test)]
77 extern crate test;
78
79 #[doc(no_inline)]
80 pub use binary_heap::BinaryHeap;
81 #[doc(no_inline)]
82 pub use btree_map::BTreeMap;
83 #[doc(no_inline)]
84 pub use btree_set::BTreeSet;
85 #[doc(no_inline)]
86 pub use linked_list::LinkedList;
87 #[doc(no_inline)]
88 #[allow(deprecated)]
89 pub use enum_set::EnumSet;
90 #[doc(no_inline)]
91 pub use vec_deque::VecDeque;
92 #[doc(no_inline)]
93 pub use string::String;
94 #[doc(no_inline)]
95 pub use vec::Vec;
96
97 // Needed for the vec! macro
98 pub use alloc::boxed;
99
100 #[macro_use]
101 mod macros;
102
103 pub mod binary_heap;
104 mod btree;
105 pub mod borrow;
106 pub mod enum_set;
107 pub mod fmt;
108 pub mod linked_list;
109 pub mod range;
110 pub mod slice;
111 pub mod str;
112 pub mod string;
113 pub mod vec;
114 pub mod vec_deque;
115
116 #[stable(feature = "rust1", since = "1.0.0")]
117 pub mod btree_map {
118     //! A map based on a B-Tree.
119     #[stable(feature = "rust1", since = "1.0.0")]
120     pub use btree::map::*;
121 }
122
123 #[stable(feature = "rust1", since = "1.0.0")]
124 pub mod btree_set {
125     //! A set based on a B-Tree.
126     #[stable(feature = "rust1", since = "1.0.0")]
127     pub use btree::set::*;
128 }
129
130 #[cfg(not(test))]
131 mod std {
132     pub use core::ops;      // RangeFull
133 }
134
135 /// An endpoint of a range of keys.
136 #[stable(feature = "collections_bound", since = "1.17.0")]
137 #[derive(Clone, Copy, Debug, Hash, PartialEq, Eq)]
138 pub enum Bound<T> {
139     /// An inclusive bound.
140     #[stable(feature = "collections_bound", since = "1.17.0")]
141     Included(T),
142     /// An exclusive bound.
143     #[stable(feature = "collections_bound", since = "1.17.0")]
144     Excluded(T),
145     /// An infinite endpoint. Indicates that there is no bound in this direction.
146     #[stable(feature = "collections_bound", since = "1.17.0")]
147     Unbounded,
148 }
149
150 /// An intermediate trait for specialization of `Extend`.
151 #[doc(hidden)]
152 trait SpecExtend<I: IntoIterator> {
153     /// Extends `self` with the contents of the given iterator.
154     fn spec_extend(&mut self, iter: I);
155 }