rune_alloc/
error.rs

Help
1//! Error types used by rune alloc.
2
3use core::alloc::LayoutError;
4use core::convert::Infallible;
5use core::fmt;
6
7use crate::alloc::AllocError;
8
9/// An error type returned when a custom error is available alongside an allocation error.
10#[derive(Debug)]
11pub enum CustomError<E> {
12    /// Custom error being returned.
13    Custom(E),
14    /// Try reserve error being returned.
15    Error(Error),
16}
17
18impl<E> From<Error> for CustomError<E> {
19    fn from(error: Error) -> Self {
20        CustomError::Error(error)
21    }
22}
23
24impl<E> From<AllocError> for CustomError<E> {
25    fn from(error: AllocError) -> Self {
26        CustomError::Error(Error::from(error))
27    }
28}
29
30/// The error type for methods which allocate or reserve.
31#[derive(Debug, Clone, Copy, PartialEq, Eq)]
32#[non_exhaustive]
33pub enum Error {
34    /// Error due to the computed capacity exceeding the collection's maximum
35    /// (usually `isize::MAX` bytes).
36    #[doc(hidden)]
37    CapacityOverflow,
38
39    /// Error when computing layout.
40    #[doc(hidden)]
41    LayoutError,
42
43    /// Error during internal formatting.
44    #[doc(hidden)]
45    FormatError,
46
47    /// The memory allocator returned an error
48    #[doc(hidden)]
49    AllocError {
50        /// The layout of the allocation request that failed.
51        error: AllocError,
52    },
53}
54
55impl From<AllocError> for Error {
56    #[inline]
57    fn from(error: AllocError) -> Self {
58        Error::AllocError { error }
59    }
60}
61
62impl From<Infallible> for Error {
63    #[inline(always)]
64    fn from(value: Infallible) -> Self {
65        match value {}
66    }
67}
68
69impl From<LayoutError> for Error {
70    #[inline]
71    fn from(_: LayoutError) -> Self {
72        Error::LayoutError
73    }
74}
75
76impl fmt::Display for Error {
77    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
78        match self {
79            Error::CapacityOverflow => write!(f, "Capacity overflow"),
80            Error::LayoutError => write!(f, "Layout error"),
81            Error::FormatError => write!(f, "Format error"),
82            Error::AllocError { error } => error.fmt(f),
83        }
84    }
85}
86
87impl core::error::Error for Error {}
rune_alloc/error.rs

rune_alloc/
error.rs
