cds 0.10.0

Collection of Optimized Data Structures
Documentation 
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

use core::{
    alloc::Layout,
    fmt::{Debug, Display, Formatter},
};

/// An error returned when capacity reservation fails.
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
pub enum ReservationError {
    /// Collection capacity overflow.
    ///
    /// Is returned when a collection's length-type `L`
    /// cannot represent the resulting overall capacity.
    CapacityOverflow,

    /// Allocation error.
    ///
    /// Is returned when the underlying memory allocator fails to fulfill
    /// an allocation request.
    ///
    /// See [`alloc`] for more information.
    ///
    /// [`alloc`]: alloc::alloc::GlobalAlloc::alloc
    AllocError {
        /// The layout passed to the underlying allocator.
        layout: Layout,
    },
}

impl Display for ReservationError {
    fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result {
        match self {
            ReservationError::CapacityOverflow => {
                write!(f, "memory reservation error: capacity overflow")
            }
            ReservationError::AllocError { ref layout } => {
                write!(
                    f,
                    "memory reservation error: alloc error. layout {{ size: {}, align: {} }}",
                    layout.size(),
                    layout.align()
                )
            }
        }
    }
}

#[cfg(feature = "std")]
#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
impl std::error::Error for ReservationError {}

#[cfg(all(test, feature = "std"))]
mod testing {
    use super::*;

    #[test]
    fn test_reservation_error_display() {
        let e = ReservationError::CapacityOverflow;
        assert_eq!(e.to_string(), "memory reservation error: capacity overflow");

        let layout = alloc::alloc::Layout::from_size_align(100, 8).unwrap();
        let e = ReservationError::AllocError { layout };
        assert_eq!(
            e.to_string(),
            "memory reservation error: alloc error. layout { size: 100, align: 8 }"
        )
    }
}