cadd 0.2.0-alpha.1

Painless checked arithmetics and conversions
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

#[cfg(feature = "std")]
use std::backtrace::{Backtrace, BacktraceStatus};

use {
    alloc::{boxed::Box, string::String},
    core::fmt::{self, Debug, Display, Formatter},
};

/// A general error with a message and a backtrace (if enabled).
pub struct Error(Box<ErrorInner>);

struct ErrorInner {
    message: String,
    #[cfg(feature = "std")]
    backtrace: Backtrace,
}

impl Error {
    /// Creates a new error and captures the backtrace (if enabled).
    #[inline]
    #[must_use]
    pub fn new(message: String) -> Self {
        Self(Box::new(ErrorInner {
            message,
            #[cfg(feature = "std")]
            backtrace: Backtrace::capture(),
        }))
    }

    /// Description of the error.
    #[inline]
    #[must_use]
    pub fn message(&self) -> &str {
        &self.0.message
    }

    /// Backtrace to where the error was created.
    #[cfg(feature = "std")]
    #[inline]
    pub fn backtrace(&self) -> &Backtrace {
        &self.0.backtrace
    }
}

impl Debug for Error {
    #[inline]
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.0.message)?;
        #[cfg(feature = "std")]
        if self.0.backtrace.status() == BacktraceStatus::Captured {
            write!(f, "\nstack backtrace:\n{}", self.0.backtrace)?;
        }
        Ok(())
    }
}

impl Display for Error {
    #[inline]
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        write!(f, "{:?}", self)
    }
}

#[expect(clippy::absolute_paths, reason = "for clarity")]
impl core::error::Error for Error {}