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