jsonvet 3.0.0

Checks JSON, I-JSON, JSONC, JWCC (HuJSON), JSON5 and JSON Lines for syntax errors and duplicate keys, with exact positions.
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

use std::borrow::Cow;

/// One step through a document's values, from [`parse`](crate::parse), in document order.
///
/// An object is `ObjectStart`, then a `Key` and its value for each member, then `End`; an array
/// is `ArrayStart`, its elements, then `End`. A JSON Lines file is one document after another.
///
/// Public for jsonvet-cli only and outside the semver contract: it can change in any release.
#[doc(hidden)]
#[derive(Clone, Debug, PartialEq, Eq)]
#[non_exhaustive]
pub struct Event<'a> {
    /// The byte offset where the token starts: the bracket, the key or the value.
    pub offset: usize,
    /// What the token is.
    pub kind: EventKind<'a>,
}

/// The token an [`Event`] stands for. Strings come decoded, with U+FFFD for a lone surrogate
/// escape. Keys come decoded as WTF-8, which keeps each lone surrogate: see [`key_text`].
///
/// [`key_text`]: crate::key_text
///
/// Public for jsonvet-cli only and outside the semver contract: it can change in any release.
#[doc(hidden)]
#[derive(Clone, Debug, PartialEq, Eq)]
#[non_exhaustive]
pub enum EventKind<'a> {
    /// `{`.
    ObjectStart,
    /// `[`.
    ArrayStart,
    /// The `}` or `]` that closes the innermost open container.
    End,
    /// An object member's key, as WTF-8: UTF-8, except that a lone surrogate escape such as
    /// `\ud800` is kept as its own three bytes (`ED A0 80`).
    Key(Cow<'a, [u8]>),
    /// `null`.
    Null,
    /// `true` or `false`.
    Bool(bool),
    /// A number as written, sign included: `-1.5e3`, and in JSON5 also `+0x1F`, `.5`, `5.`,
    /// `Infinity` or `NaN`.
    Number(&'a str),
    /// A string.
    String(Cow<'a, str>),
}