#error #opinionated #macro #quickly #define #syntax #thiserror

macro quickerr

A macro to define errors quickly, like thiserror but terser and more opinionated

5 unstable releases

0.3.2 Aug 18, 2023
0.3.1 Aug 18, 2023
0.2.0 Aug 18, 2023
0.1.1 May 17, 2023

#1394 in Procedural macros

MIT/Apache

16KB
285 lines

quickerr

A macro to define errors quickly, like thiserror but terser and more opinionated. Exclusively uses a decl macro, so compile times should not be greatly impacted. It uses markdown-like syntax. Primarily for my own personal use as I find it extremely helpful for quickly defining high quality errors.

Example:

# use quickerr::error;
# error! { MyOtherError "" }
# error! { MySecondOtherError "" }
error! {
  pub EnumError
  "a problem happened!"
  MyOtherError,
  MySecondOtherError,
}

this roughly expands to:

#[derive(Debug)]
#[non_exhaustive]
pub enum EnumError {
    MyOtherError(MyOtherError),
    MySecondOtherError(MySecondOtherError),
}

impl ::std::fmt::Display for EnumError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str("a problem happened!")
    }
}

impl ::std::error::Error for EnumError {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        Some(match self {
            MyOtherError(err) => err,
            MySecondOtherError(err) => err,
        })
    }
}

impl ::std::convert::From<MyOtherError> for EnumError {
    fn from(source: MyOtherError) -> Self {
        Self::MyOtherError(source)
    }
}

impl ::std::convert::From<MySecondOtherError> for EnumError {
    fn from(source: MySecondOtherError) -> Self {
        Self::MySecondOtherError(source)
    }
}

Dependencies

~230–660KB
~16K SLoC