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_box_extras)]
  64 #![feature(str_mut_extras)]
  65 #![feature(trusted_len)]
  66 #![feature(unicode)]
  67 #![feature(unique)]
  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 pub use vec_deque::VecDeque;
  93 #[doc(no_inline)]
  94 pub use string::String;
  95 #[doc(no_inline)]
  96 pub use vec::Vec;
  97
  98 // Needed for the vec! macro
  99 pub use alloc::boxed;
 100
 101 #[macro_use]
 102 mod macros;
 103
 104 pub mod binary_heap;
 105 mod btree;
 106 pub mod borrow;
 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 ///
 137 /// # Examples
 138 ///
 139 /// `Bound`s are range endpoints:
 140 ///
 141 /// ```
 142 /// #![feature(collections_range)]
 143 ///
 144 /// use std::collections::range::RangeArgument;
 145 /// use std::collections::Bound::*;
 146 ///
 147 /// assert_eq!((..100).start(), Unbounded);
 148 /// assert_eq!((1..12).start(), Included(&1));
 149 /// assert_eq!((1..12).end(), Excluded(&12));
 150 /// ```
 151 ///
 152 /// Using a tuple of `Bound`s as an argument to [`BTreeMap::range`].
 153 /// Note that in most cases, it's better to use range syntax (`1..5`) instead.
 154 ///
 155 /// ```
 156 /// use std::collections::BTreeMap;
 157 /// use std::collections::Bound::{Excluded, Included, Unbounded};
 158 ///
 159 /// let mut map = BTreeMap::new();
 160 /// map.insert(3, "a");
 161 /// map.insert(5, "b");
 162 /// map.insert(8, "c");
 163 ///
 164 /// for (key, value) in map.range((Excluded(3), Included(8))) {
 165 ///     println!("{}: {}", key, value);
 166 /// }
 167 ///
 168 /// assert_eq!(Some((&3, &"a")), map.range((Unbounded, Included(5))).next());
 169 /// ```
 170 ///
 171 /// [`BTreeMap::range`]: btree_map/struct.BTreeMap.html#method.range
 172 #[stable(feature = "collections_bound", since = "1.17.0")]
 173 #[derive(Clone, Copy, Debug, Hash, PartialEq, Eq)]
 174 pub enum Bound<T> {
 175     /// An inclusive bound.
 176     #[stable(feature = "collections_bound", since = "1.17.0")]
 177     Included(T),
 178     /// An exclusive bound.
 179     #[stable(feature = "collections_bound", since = "1.17.0")]
 180     Excluded(T),
 181     /// An infinite endpoint. Indicates that there is no bound in this direction.
 182     #[stable(feature = "collections_bound", since = "1.17.0")]
 183     Unbounded,
 184 }
 185
 186 /// An intermediate trait for specialization of `Extend`.
 187 #[doc(hidden)]
 188 trait SpecExtend<I: IntoIterator> {
 189     /// Extends `self` with the contents of the given iterator.
 190     fn spec_extend(&mut self, iter: I);
 191 }