asmjson 0.2.5

A fast JSON parser using AVX-512/AVX2/SWAR classifiers
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

// ---------------------------------------------------------------------------
// Sax trait — SAX-style event sink
// ---------------------------------------------------------------------------

/// Receives a stream of structural events as the parser walks the input.
///
/// Implement this trait to produce any output from a single pass over the JSON
/// source.  The built-in implementation used by [`crate::parse_to_dom`]
/// produces a flat [`crate::dom::Dom`].
///
/// A custom implementation can be driven via [`crate::parse_with`] (portable
/// SWAR) or [`crate::parse_with_zmm`] (AVX-512BW assembly).
pub trait Sax<'src> {
    /// The type returned by [`finish`](Sax::finish).
    type Output;

    /// A `null` literal was parsed.
    fn null(&mut self) {}
    /// A `true` or `false` literal was parsed.
    fn bool_val(&mut self, _v: bool) {}
    /// A JSON number; `s` is a slice of the original source string.
    fn number(&mut self, _s: &'src str) {}
    /// A JSON string value with no escape sequences; `s` borrows from the source.
    fn string(&mut self, _s: &'src str) {}
    /// A JSON string value that contained escape sequences.
    /// `s` is the **raw** slice from the source JSON, still containing backslash
    /// sequences (e.g. `\n`, `\uXXXX`).  Call [`crate::unescape_str`] if you
    /// need the decoded text.
    fn escaped_string(&mut self, _s: &str) {}
    /// An object key with no escape sequences; `s` borrows from the source.
    fn key(&mut self, _s: &'src str) {}
    /// An object key that contained escape sequences.
    /// `s` is the **raw** slice from the source JSON, still containing backslash
    /// sequences.  Call [`crate::unescape_str`] if you need the decoded text.
    fn escaped_key(&mut self, _s: &str) {}
    /// Opening `{` of an object.
    fn start_object(&mut self) {}
    /// Closing `}` of an object.
    fn end_object(&mut self) {}
    /// Opening `[` of an array.
    fn start_array(&mut self) {}
    /// Closing `]` of an array.
    fn end_array(&mut self) {}
    /// Called once after the last token; returns the final output or `None` on
    /// internal error.
    fn finish(self) -> Option<Self::Output>;
}