lib.rs.html -- source
Description: Source to the Rust file `src/libcollections/lib.rs`.
Keywords: rust, rustlang, rust-lang

      1
      2
      3
      4
      5
      6
      7
      8
      9
     10
     11
     12
     13
     14
     15
     16
     17
     18
     19
     20
     21
     22
     23
     24
     25
     26
     27
     28
     29
     30
     31
     32
     33
     34
     35
     36
     37
     38
     39
     40
     41
     42
     43
     44
     45
     46
     47
     48
     49
     50
     51
     52
     53
     54
     55
     56
     57
     58
     59
     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146

    // Copyright 2013-2014 The Rust Project Developers. See the COPYRIGHT
    // file at the top-level directory of this distribution and at
    // http://rust-lang.org/COPYRIGHT.
    //
    // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
    // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
    // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
    // option. This file may not be copied, modified, or distributed
    // except according to those terms.

    //! Collection types.
    //!
    //! See [std::collections](../std/collections/index.html) for a detailed discussion of
    //! collections in Rust.

    #![crate_name = "collections"]
    #![crate_type = "rlib"]
    #![unstable(feature = "collections",
                reason = "library is unlikely to be stabilized with the current \
                          layout and name, use std::collections instead",
                issue = "27783")]
    #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
           html_favicon_url = "https://doc.rust-lang.org/favicon.ico",
           html_root_url = "https://doc.rust-lang.org/nightly/",
           html_playground_url = "https://play.rust-lang.org/",
           issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/",
           test(no_crate_inject, attr(allow(unused_variables), deny(warnings))))]

    #![cfg_attr(test, allow(deprecated))] // rand
    #![deny(warnings)]

    #![feature(alloc)]
    #![feature(allow_internal_unstable)]
    #![feature(box_patterns)]
    #![feature(box_syntax)]
    #![cfg_attr(not(test), feature(char_escape_debug))]
    #![feature(core_intrinsics)]
    #![feature(dropck_eyepatch)]
    #![feature(exact_size_is_empty)]
    #![feature(fmt_internals)]
    #![feature(fused)]
    #![feature(generic_param_attrs)]
    #![feature(heap_api)]
    #![feature(inclusive_range)]
    #![feature(lang_items)]
    #![feature(nonzero)]
    #![feature(pattern)]
    #![feature(placement_in)]
    #![feature(placement_in_syntax)]
    #![feature(placement_new_protocol)]
    #![feature(shared)]
    #![feature(slice_get_slice)]
    #![feature(slice_patterns)]
    #![feature(specialization)]
    #![feature(staged_api)]
    #![feature(trusted_len)]
    #![feature(unicode)]
    #![feature(unique)]
    #![feature(untagged_unions)]
    #![cfg_attr(test, feature(rand, test))]

    #![no_std]

    extern crate std_unicode;
    extern crate alloc;

    #[cfg(test)]
    #[macro_use]
    extern crate std;
    #[cfg(test)]
    extern crate test;

    #[doc(no_inline)]
    pub use binary_heap::BinaryHeap;
    #[doc(no_inline)]
    pub use btree_map::BTreeMap;
    #[doc(no_inline)]
    pub use btree_set::BTreeSet;
    #[doc(no_inline)]
    pub use linked_list::LinkedList;
    #[doc(no_inline)]
    #[allow(deprecated)]
    pub use enum_set::EnumSet;
    #[doc(no_inline)]
    pub use vec_deque::VecDeque;
    #[doc(no_inline)]
    pub use string::String;
    #[doc(no_inline)]
    pub use vec::Vec;

    // Needed for the vec! macro
    pub use alloc::boxed;

    #[macro_use]
    mod macros;

    pub mod binary_heap;
    mod btree;
    pub mod borrow;
    pub mod enum_set;
    pub mod fmt;
    pub mod linked_list;
    pub mod range;
    pub mod slice;
    pub mod str;
    pub mod string;
    pub mod vec;
    pub mod vec_deque;

    #[stable(feature = "rust1", since = "1.0.0")]
    pub mod btree_map {
        //! A map based on a B-Tree.
        #[stable(feature = "rust1", since = "1.0.0")]
        pub use btree::map::*;
    }

    #[stable(feature = "rust1", since = "1.0.0")]
    pub mod btree_set {
        //! A set based on a B-Tree.
        #[stable(feature = "rust1", since = "1.0.0")]
        pub use btree::set::*;
    }

    #[cfg(not(test))]
    mod std {
        pub use core::ops;      // RangeFull
    }

    /// An endpoint of a range of keys.
    #[unstable(feature = "collections_bound", issue = "27787")]
    #[derive(Clone, Copy, Debug, Hash, PartialEq, Eq)]
    pub enum Bound<T> {
        /// An inclusive bound.
        Included(T),
        /// An exclusive bound.
        Excluded(T),
        /// An infinite endpoint. Indicates that there is no bound in this direction.
        Unbounded,
    }

    /// An intermediate trait for specialization of `Extend`.
    #[doc(hidden)]
    trait SpecExtend<I: IntoIterator> {
        /// Extends `self` with the contents of the given iterator.
        fn spec_extend(&mut self, iter: I);
    }

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)