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
  14 //! discussion of 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 #![cfg_attr(not(test), feature(core_float))]
  39 #![feature(core_intrinsics)]
  40 #![feature(dropck_eyepatch)]
  41 #![feature(exact_size_is_empty)]
  42 #![feature(fmt_internals)]
  43 #![feature(fused)]
  44 #![feature(generic_param_attrs)]
  45 #![feature(heap_api)]
  46 #![feature(i128_type)]
  47 #![feature(inclusive_range)]
  48 #![feature(lang_items)]
  49 #![feature(manually_drop)]
  50 #![feature(nonzero)]
  51 #![feature(pattern)]
  52 #![feature(placement_in)]
  53 #![feature(placement_in_syntax)]
  54 #![feature(placement_new_protocol)]
  55 #![feature(shared)]
  56 #![feature(slice_get_slice)]
  57 #![feature(slice_patterns)]
  58 #![feature(slice_rsplit)]
  59 #![cfg_attr(not(test), feature(sort_unstable))]
  60 #![feature(specialization)]
  61 #![feature(staged_api)]
  62 #![feature(str_internals)]
  63 #![feature(str_mut_extras)]
  64 #![feature(trusted_len)]
  65 #![feature(unicode)]
  66 #![feature(unique)]
  67 #![feature(untagged_unions)]
  68 #![cfg_attr(not(test), feature(str_checked_slicing))]
  69 #![cfg_attr(test, feature(rand, test))]
  70 #![feature(offset_to)]
  71
  72 #![no_std]
  73
  74 extern crate std_unicode;
  75 extern crate alloc;
  76
  77 #[cfg(test)]
  78 #[macro_use]
  79 extern crate std;
  80 #[cfg(test)]
  81 extern crate test;
  82
  83 #[doc(no_inline)]
  84 pub use binary_heap::BinaryHeap;
  85 #[doc(no_inline)]
  86 pub use btree_map::BTreeMap;
  87 #[doc(no_inline)]
  88 pub use btree_set::BTreeSet;
  89 #[doc(no_inline)]
  90 pub use linked_list::LinkedList;
  91 #[doc(no_inline)]
  92 #[allow(deprecated)]
  93 pub use enum_set::EnumSet;
  94 #[doc(no_inline)]
  95 pub use vec_deque::VecDeque;
  96 #[doc(no_inline)]
  97 pub use string::String;
  98 #[doc(no_inline)]
  99 pub use vec::Vec;
 100
 101 // Needed for the vec! macro
 102 pub use alloc::boxed;
 103
 104 #[macro_use]
 105 mod macros;
 106
 107 pub mod binary_heap;
 108 mod btree;
 109 pub mod borrow;
 110 pub mod enum_set;
 111 pub mod fmt;
 112 pub mod linked_list;
 113 pub mod range;
 114 pub mod slice;
 115 pub mod str;
 116 pub mod string;
 117 pub mod vec;
 118 pub mod vec_deque;
 119
 120 #[stable(feature = "rust1", since = "1.0.0")]
 121 pub mod btree_map {
 122     //! A map based on a B-Tree.
 123     #[stable(feature = "rust1", since = "1.0.0")]
 124     pub use btree::map::*;
 125 }
 126
 127 #[stable(feature = "rust1", since = "1.0.0")]
 128 pub mod btree_set {
 129     //! A set based on a B-Tree.
 130     #[stable(feature = "rust1", since = "1.0.0")]
 131     pub use btree::set::*;
 132 }
 133
 134 #[cfg(not(test))]
 135 mod std {
 136     pub use core::ops;      // RangeFull
 137 }
 138
 139 /// An endpoint of a range of keys.
 140 ///
 141 /// # Examples
 142 ///
 143 /// `Bound`s are range endpoints:
 144 ///
 145 /// ```
 146 /// #![feature(collections_range)]
 147 ///
 148 /// use std::collections::range::RangeArgument;
 149 /// use std::collections::Bound::*;
 150 ///
 151 /// assert_eq!((..100).start(), Unbounded);
 152 /// assert_eq!((1..12).start(), Included(&1));
 153 /// assert_eq!((1..12).end(), Excluded(&12));
 154 /// ```
 155 ///
 156 /// Using a tuple of `Bound`s as an argument to [`BTreeMap::range`].
 157 /// Note that in most cases, it's better to use range syntax (`1..5`) instead.
 158 ///
 159 /// ```
 160 /// use std::collections::BTreeMap;
 161 /// use std::collections::Bound::{Excluded, Included, Unbounded};
 162 ///
 163 /// let mut map = BTreeMap::new();
 164 /// map.insert(3, "a");
 165 /// map.insert(5, "b");
 166 /// map.insert(8, "c");
 167 ///
 168 /// for (key, value) in map.range((Excluded(3), Included(8))) {
 169 ///     println!("{}: {}", key, value);
 170 /// }
 171 ///
 172 /// assert_eq!(Some((&3, &"a")), map.range((Unbounded, Included(5))).next());
 173 /// ```
 174 ///
 175 /// [`BTreeMap::range`]: btree_map/struct.BTreeMap.html#method.range
 176 #[stable(feature = "collections_bound", since = "1.17.0")]
 177 #[derive(Clone, Copy, Debug, Hash, PartialEq, Eq)]
 178 pub enum Bound<T> {
 179     /// An inclusive bound.
 180     #[stable(feature = "collections_bound", since = "1.17.0")]
 181     Included(T),
 182     /// An exclusive bound.
 183     #[stable(feature = "collections_bound", since = "1.17.0")]
 184     Excluded(T),
 185     /// An infinite endpoint. Indicates that there is no bound in this direction.
 186     #[stable(feature = "collections_bound", since = "1.17.0")]
 187     Unbounded,
 188 }
 189
 190 /// An intermediate trait for specialization of `Extend`.
 191 #[doc(hidden)]
 192 trait SpecExtend<I: IntoIterator> {
 193     /// Extends `self` with the contents of the given iterator.
 194     fn spec_extend(&mut self, iter: I);
 195 }