qubit-json 0.2.0

Lenient JSON decoder for non-fully-trusted JSON text inputs
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

/*******************************************************************************
 *
 *    Copyright (c) 2026.
 *    Haixing Hu, Qubit Co. Ltd.
 *
 *    All rights reserved.
 *
 ******************************************************************************/
//! Defines the option type used to configure the lenient JSON decoder.
//!
//! Author: Haixing Hu

/// Configuration switches for [`crate::LenientJsonDecoder`].
///
/// Each flag controls one normalization rule applied before parsing JSON.
/// Defaults are intentionally conservative and cover the most common
/// non-fully-trusted text inputs without attempting aggressive repair.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct JsonDecodeOptions {
    /// Controls whether leading and trailing whitespace is removed before any
    /// other normalization step is applied.
    pub trim_whitespace: bool,
    /// Controls whether a leading UTF-8 byte order mark (`U+FEFF`) is removed
    /// before parsing.
    pub strip_utf8_bom: bool,
    /// Controls whether one outer Markdown code fence is removed.
    ///
    /// Typical examples include `````json ... ````` and bare fenced blocks
    /// starting with ````` followed by a newline.
    pub strip_markdown_code_fence: bool,
    /// Controls whether Markdown fence stripping requires a matching closing
    /// fence.
    ///
    /// When enabled, an opening fence without a valid closing fence keeps the
    /// input unchanged.
    pub strip_markdown_code_fence_requires_closing: bool,
    /// Controls whether Markdown fence stripping only accepts JSON-like
    /// language tags (`json`, `jsonc`, or empty tag).
    ///
    /// When enabled, fenced blocks labeled with other languages are not
    /// stripped.
    pub strip_markdown_code_fence_json_only: bool,
    /// Controls whether raw ASCII control characters inside JSON string
    /// literals are converted into valid JSON escape sequences.
    pub escape_control_chars_in_strings: bool,
    /// Caps the accepted raw input size in bytes before normalization.
    ///
    /// When set to `Some(limit)`, any input whose byte length is greater than
    /// `limit` is rejected before further processing. When set to `None`,
    /// no size limit is enforced.
    pub max_input_bytes: Option<usize>,
}

impl Default for JsonDecodeOptions {
    fn default() -> Self {
        Self {
            trim_whitespace: true,
            strip_utf8_bom: true,
            strip_markdown_code_fence: true,
            strip_markdown_code_fence_requires_closing: false,
            strip_markdown_code_fence_json_only: false,
            escape_control_chars_in_strings: true,
            max_input_bytes: None,
        }
    }
}