aob_common 1.0.2

String searching with wildcards
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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128

use std::{
    fmt::{
        self,
        Display,
        Formatter,
    },
    ops::Range,
};

/// A [`Reason`] gives more context about why parsing failed.
#[derive(Clone, Debug, Eq, PartialEq)]
pub enum Reason {
    /// Encountered an unexpected input in the stream.
    Unexpected,
    /// Encountered an unclosed set of delimiters.
    Unclosed,
    /// The given character is not a valid hexdigit.
    InvalidHexdigit(char),
}

impl Display for Reason {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        match self {
            Self::Unexpected => write!(f, "unexpected input"),
            Self::Unclosed => write!(f, "unclosed delimiter"),
            Self::InvalidHexdigit(c) => write!(f, "'{c}' is not a hexdigit"),
        }
    }
}

#[derive(Clone, Debug)]
pub(crate) struct SimpleError {
    pub(crate) span: Range<usize>,
    pub(crate) reason: Reason,
}

impl SimpleError {
    pub(crate) fn invalid_hexdigit(span: Range<usize>, found: char) -> Self {
        Self {
            span,
            reason: Reason::InvalidHexdigit(found),
        }
    }
}

impl chumsky::Error<char> for SimpleError {
    type Span = Range<usize>;
    type Label = &'static str;

    fn expected_input_found<Iter: IntoIterator<Item = Option<char>>>(
        span: Self::Span,
        _expected: Iter,
        _found: Option<char>,
    ) -> Self {
        Self {
            span,
            reason: Reason::Unexpected,
        }
    }

    fn with_label(self, _label: Self::Label) -> Self {
        self
    }

    fn merge(self, _other: Self) -> Self {
        self
    }

    fn unclosed_delimiter(
        _unclosed_span: Self::Span,
        _unclosed: char,
        span: Self::Span,
        _expected: char,
        _found: Option<char>,
    ) -> Self {
        Self {
            span,
            reason: Reason::Unclosed,
        }
    }
}

/// Describes errors encountered when parsing custom pattern syntax.
#[derive(Clone, Debug)]
pub struct Error<'a> {
    pub(crate) source: &'a str,
    pub(crate) inner: SimpleError,
}

impl<'a> Error<'a> {
    /// The span over which the error was encountered.
    ///
    /// ```
    /// # use aob_common::DynamicNeedle;
    /// let error = DynamicNeedle::from_ida("12 3_ 56").unwrap_err();
    /// assert_eq!(error.span(), 4..5);
    /// ```
    #[must_use]
    pub fn span(&self) -> Range<usize> {
        self.inner.span.clone()
    }

    /// A human readable reason describing why the error occurred.
    ///
    /// ```
    /// # use aob_common::{DynamicNeedle, Reason};
    /// let error = DynamicNeedle::from_ida("12 3_ 56").unwrap_err();
    /// assert_eq!(error.reason(), &Reason::InvalidHexdigit('_'));
    /// ```
    #[must_use]
    pub fn reason(&self) -> &Reason {
        &self.inner.reason
    }
}

impl Display for Error<'_> {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        let start = self.inner.span.start;
        let end = self.inner.span.end;
        let span = &self.source[start..end];
        write!(
            f,
            "error while parsing token \"{span}\" in range [{start}, {end})",
        )
    }
}

impl std::error::Error for Error<'_> {}