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(specialization)]
  56 #![feature(staged_api)]
  57 #![feature(trusted_len)]
  58 #![feature(unicode)]
  59 #![feature(unique)]
  60 #![feature(untagged_unions)]
  61 #![cfg_attr(test, feature(rand, test))]
  62
  63 #![no_std]
  64
  65 extern crate std_unicode;
  66 extern crate alloc;
  67
  68 #[cfg(test)]
  69 #[macro_use]
  70 extern crate std;
  71 #[cfg(test)]
  72 extern crate test;
  73
  74 #[doc(no_inline)]
  75 pub use binary_heap::BinaryHeap;
  76 #[doc(no_inline)]
  77 pub use btree_map::BTreeMap;
  78 #[doc(no_inline)]
  79 pub use btree_set::BTreeSet;
  80 #[doc(no_inline)]
  81 pub use linked_list::LinkedList;
  82 #[doc(no_inline)]
  83 #[allow(deprecated)]
  84 pub use enum_set::EnumSet;
  85 #[doc(no_inline)]
  86 pub use vec_deque::VecDeque;
  87 #[doc(no_inline)]
  88 pub use string::String;
  89 #[doc(no_inline)]
  90 pub use vec::Vec;
  91
  92 // Needed for the vec! macro
  93 pub use alloc::boxed;
  94
  95 #[macro_use]
  96 mod macros;
  97
  98 pub mod binary_heap;
  99 mod btree;
 100 pub mod borrow;
 101 pub mod enum_set;
 102 pub mod fmt;
 103 pub mod linked_list;
 104 pub mod range;
 105 pub mod slice;
 106 pub mod str;
 107 pub mod string;
 108 pub mod vec;
 109 pub mod vec_deque;
 110
 111 #[stable(feature = "rust1", since = "1.0.0")]
 112 pub mod btree_map {
 113     //! A map based on a B-Tree.
 114     #[stable(feature = "rust1", since = "1.0.0")]
 115     pub use btree::map::*;
 116 }
 117
 118 #[stable(feature = "rust1", since = "1.0.0")]
 119 pub mod btree_set {
 120     //! A set based on a B-Tree.
 121     #[stable(feature = "rust1", since = "1.0.0")]
 122     pub use btree::set::*;
 123 }
 124
 125 #[cfg(not(test))]
 126 mod std {
 127     pub use core::ops;      // RangeFull
 128 }
 129
 130 /// An endpoint of a range of keys.
 131 #[unstable(feature = "collections_bound", issue = "27787")]
 132 #[derive(Clone, Copy, Debug, Hash, PartialEq, Eq)]
 133 pub enum Bound<T> {
 134     /// An inclusive bound.
 135     Included(T),
 136     /// An exclusive bound.
 137     Excluded(T),
 138     /// An infinite endpoint. Indicates that there is no bound in this direction.
 139     Unbounded,
 140 }
 141
 142 /// An intermediate trait for specialization of `Extend`.
 143 #[doc(hidden)]
 144 trait SpecExtend<I: IntoIterator> {
 145     /// Extends `self` with the contents of the given iterator.
 146     fn spec_extend(&mut self, iter: I);
 147 }