mod.rs.html -- source
Description: Source to the Rust file `library/alloc/src/collections/mod.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

    //! Collection types.

    #![stable(feature = "rust1", since = "1.0.0")]

    pub mod binary_heap;
    mod btree;
    pub mod linked_list;
    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 super::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 super::btree::set::*;
    }

    #[stable(feature = "rust1", since = "1.0.0")]
    #[doc(no_inline)]
    pub use binary_heap::BinaryHeap;

    #[stable(feature = "rust1", since = "1.0.0")]
    #[doc(no_inline)]
    pub use btree_map::BTreeMap;

    #[stable(feature = "rust1", since = "1.0.0")]
    #[doc(no_inline)]
    pub use btree_set::BTreeSet;

    #[stable(feature = "rust1", since = "1.0.0")]
    #[doc(no_inline)]
    pub use linked_list::LinkedList;

    #[stable(feature = "rust1", since = "1.0.0")]
    #[doc(no_inline)]
    pub use vec_deque::VecDeque;

    use crate::alloc::{Layout, LayoutErr};
    use core::fmt::Display;

    /// The error type for `try_reserve` methods.
    #[derive(Clone, PartialEq, Eq, Debug)]
    #[unstable(feature = "try_reserve", reason = "new API", issue = "48043")]
    pub enum TryReserveError {
        /// Error due to the computed capacity exceeding the collection's maximum
        /// (usually `isize::MAX` bytes).
        CapacityOverflow,

        /// The memory allocator returned an error
        AllocError {
            /// The layout of allocation request that failed
            layout: Layout,

            #[doc(hidden)]
            #[unstable(
                feature = "container_error_extra",
                issue = "none",
                reason = "\
                Enable exposing the allocator’s custom error value \
                if an associated type is added in the future: \
                https://github.com/rust-lang/wg-allocators/issues/23"
            )]
            non_exhaustive: (),
        },
    }

    #[unstable(feature = "try_reserve", reason = "new API", issue = "48043")]
    impl From<LayoutErr> for TryReserveError {
        #[inline]
        fn from(_: LayoutErr) -> Self {
            TryReserveError::CapacityOverflow
        }
    }

    #[unstable(feature = "try_reserve", reason = "new API", issue = "48043")]
    impl Display for TryReserveError {
        fn fmt(
            &self,
            fmt: &mut core::fmt::Formatter<'_>,
        ) -> core::result::Result<(), core::fmt::Error> {
            fmt.write_str("memory allocation failed")?;
            let reason = match &self {
                TryReserveError::CapacityOverflow => {
                    " because the computed capacity exceeded the collection's maximum"
                }
                TryReserveError::AllocError { .. } => " because the memory allocator returned a error",
            };
            fmt.write_str(reason)
        }
    }

    /// 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);
    }