konst 0.4.3

Const equivalents of std features: comparison, destructuring, iteration, and parsing
Documentation
use crate::Parser;

use core::{
    fmt::{self, Display},
    marker::PhantomData,
};

/// Error returned by all parsing methods that return Result.
///
/// This error type knows [`where`](#method.offset) the error happened,
/// in what [`direction`](#method.error_direction) the string was being parsed,
/// and the [`kind`](#method.kind) of error that happened.
#[derive(PartialEq, Eq, Clone)]
pub struct ParseError<'a> {
    start_offset: u32,
    end_offset: u32,
    direction: ParseDirection,
    kind: ErrorKind,
    extra_message: &'static &'static str,
    // Just in case that it goes back to storing the parser
    _lifetime: PhantomData<&'a [u8]>,
}

impl<'a> ParseError<'a> {
    /// Constructs a `ParseError`.
    #[inline(always)]
    pub const fn new(parser: &Parser<'a>, kind: ErrorKind) -> Self {
        Self {
            start_offset: parser.start_offset,
            end_offset: parser.start_offset + parser.str.len() as u32,
            direction: parser.parse_direction,
            kind,
            extra_message: &"",
            _lifetime: PhantomData,
        }
    }

    /// Constructs a `ParseError`  for an `ErrorKind::Other` error with
    /// a customized error message.
    pub const fn other_error(parser: &Parser<'a>, extra_message: &'static &'static str) -> Self {
        Self {
            start_offset: parser.start_offset,
            end_offset: parser.start_offset + parser.str.len() as u32,
            direction: parser.parse_direction,
            kind: ErrorKind::Other,
            extra_message,
            _lifetime: PhantomData,
        }
    }

    /// A const fn equivalent of a clone method.
    pub const fn copy(&self) -> Self {
        Self {
            start_offset: self.start_offset,
            end_offset: self.end_offset,
            direction: self.direction,
            kind: self.kind,
            extra_message: self.extra_message,
            _lifetime: PhantomData,
        }
    }

    /// Gets the byte offset of this error in the parsed string that the
    /// [`Parser`] was constructed from.
    #[inline(always)]
    pub const fn offset(&self) -> usize {
        (match self.direction {
            ParseDirection::FromStart | ParseDirection::FromBoth => self.start_offset,
            ParseDirection::FromEnd => self.end_offset,
        }) as usize
    }

    /// The direction that this error happened from.
    pub const fn error_direction(&self) -> ParseDirection {
        self.direction
    }

    /// The kind of parsing error that this is.
    pub const fn kind(&self) -> ErrorKind {
        self.kind
    }

    const fn extra_message(&self) -> &'static str {
        self.extra_message
    }

    const fn error_for_direction(&self) -> &'static str {
        match self.direction {
            ParseDirection::FromStart => "error from the start at the ",
            ParseDirection::FromEnd => "error from the end at the ",
            ParseDirection::FromBoth => "error from the start and end at the ",
        }
    }
    const fn error_suffix(&self) -> &'static str {
        match self.kind {
            ErrorKind::ParseInteger => " while parsing an integer",
            ErrorKind::ParseBool => " while parsing a bool",
            ErrorKind::Find => " while trying to find and skip a pattern",
            ErrorKind::Strip => " while trying to strip a pattern",
            ErrorKind::SplitExhausted => ": called split on empty parser",
            ErrorKind::DelimiterNotFound => ": delimiter (for splitting) could not be found",
            ErrorKind::Other => {
                if self.extra_message.is_empty() {
                    " other error"
                } else {
                    ": "
                }
            }
        }
    }
}

impl<'a> Display for ParseError<'a> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str(self.error_for_direction())?;
        Display::fmt(&self.offset(), f)?;
        f.write_str(" byte offset")?;
        f.write_str(self.error_suffix())?;
        f.write_str(self.extra_message())?;
        Ok(())
    }
}

const _: () = {
    use const_panic::{
        PanicFmt, PanicVal, flatten_panicvals,
        fmt::{self as cfmt, ComputePvCount, FmtArg, FmtKind},
    };

    impl PanicFmt for ParseError<'_> {
        type This = Self;
        type Kind = const_panic::IsCustomType;

        const PV_COUNT: usize = ComputePvCount {
            field_amount: 5,
            summed_pv_count: {
                <u32>::PV_COUNT
                    + <u32>::PV_COUNT
                    + <ParseDirection>::PV_COUNT
                    + <ErrorKind>::PV_COUNT
                    + <&'static &'static str>::PV_COUNT
            },
            delimiter: cfmt::TypeDelim::Braced,
        }
        .call();
    }

    impl<'a> ParseError<'a> {
        /// Formats a ParseError
        pub const fn to_panicvals(&self, fmtarg: FmtArg) -> [PanicVal<'a>; ParseError::PV_COUNT] {
            match fmtarg.fmt_kind {
                FmtKind::Debug => {
                    flatten_panicvals! {fmtarg;
                        "ParseError",
                        open: cfmt::OpenBrace,
                            // cfmt::COMMA_SEP must only be used between fields
                            "start_offset: ", u32 => self.start_offset, cfmt::COMMA_SEP,
                            "end_offset: ", u32 => self.end_offset, cfmt::COMMA_SEP,
                            "direction: ", ParseDirection => self.direction, cfmt::COMMA_SEP,
                            "kind: ", ErrorKind => self.kind, cfmt::COMMA_SEP,
                            "extra_message: ", &'static &'static str =>
                                self.extra_message, cfmt::COMMA_TERM,
                        // the `close:` format override decrements the indentation.
                        close: cfmt::CloseBrace,
                    }
                }
                _ => const_panic::utils::flatten_panicvals(&[&[
                    PanicVal::write_str(self.error_for_direction()),
                    PanicVal::from_usize(self.offset(), FmtArg::DEBUG),
                    PanicVal::write_str(" byte offset"),
                    PanicVal::write_str(self.error_suffix()),
                    PanicVal::write_str(self.extra_message()),
                ]]),
            }
        }
    }

    impl fmt::Debug for ParseError<'_> {
        fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
            fmt.debug_struct("ParseError")
                .field("start_offset", &self.start_offset)
                .field("end_offset", &self.end_offset)
                .field("direction", &self.direction)
                .field("kind", &self.kind)
                .field("extra_message", &self.extra_message)
                .finish()
        }
    }

    ////////

    macro_rules! fieldless_enum_fmt {
        ($self:expr, [$($variant:ident)*]) => (
            match $self {
                $(Self::$variant => PanicVal::write_str(stringify!($variant)),)*
            }
        )
    }

    impl PanicFmt for ParseDirection {
        type This = Self;
        type Kind = const_panic::IsCustomType;

        const PV_COUNT: usize = 1;
    }

    impl ParseDirection {
        /// Formats a ParseDirection
        pub const fn to_panicval<'a>(&self, _fmtarg: FmtArg) -> PanicVal<'a> {
            fieldless_enum_fmt! {self, [FromStart FromEnd FromBoth]}
        }

        /// Formats a ParseDirection
        pub const fn to_panicvals<'a>(
            &self,
            fmtarg: FmtArg,
        ) -> [PanicVal<'a>; ParseDirection::PV_COUNT] {
            [self.to_panicval(fmtarg)]
        }
    }

    ////////

    impl PanicFmt for ErrorKind {
        type This = Self;
        type Kind = const_panic::IsCustomType;

        const PV_COUNT: usize = 1;
    }

    impl ErrorKind {
        /// Formats an ErrorKind
        pub const fn to_panicval<'a>(&self, _fmtarg: FmtArg) -> PanicVal<'a> {
            fieldless_enum_fmt! {self, [
                ParseInteger
                ParseBool
                Find
                Strip
                SplitExhausted
                DelimiterNotFound
                Other
            ]}
        }

        /// Formats a ErrorKind
        pub const fn to_panicvals<'a>(
            &self,
            fmtarg: FmtArg,
        ) -> [PanicVal<'a>; ErrorKind::PV_COUNT] {
            [self.to_panicval(fmtarg)]
        }
    }
};

////////////////////////////////////////////////////////////////////////////////

/// The direction that a parser was parsing from when an error happened.
#[derive(Debug, PartialEq, Eq, Copy, Clone)]
pub enum ParseDirection {
    /// Parsing was attempted from the start of the string
    FromStart = 0,
    /// Parsing was attempted from the end of the string
    FromEnd = 1,
    /// Parsing was attempted from both the start and end of the string
    FromBoth = 2,
}

////////////////////////////////////////////////////////////////////////////////

/// What kind of parsing error this is.
#[non_exhaustive]
#[derive(Debug, PartialEq, Eq, Copy, Clone)]
pub enum ErrorKind {
    /// Returned from integer parsing methods
    ParseInteger,
    /// Returned from `parse_bool`
    ParseBool,
    /// Returned from `*find*` methods
    Find,
    /// Returned from `strip_*` methods
    Strip,
    /// Returned from `split` when the last delimiter-separated/terminated string
    /// has already been returned
    SplitExhausted,
    /// Returned from `split_terminator` when the delimiter could not be found
    DelimiterNotFound,
    /// For user-defined types
    Other,
}