Struct JsonDecodeOptions

Source

pub struct JsonDecodeOptions { /* private fields */ }

Expand description

Configuration switches for crate::LenientJsonDecoder.

Its fields control text normalization, input limits, and error diagnostics. Defaults are intentionally conservative and cover the most common non-fully-trusted text inputs without attempting aggressive repair.

§Examples

use qubit_json::{JsonDecodeOptions, LenientJsonDecoder};

let options = JsonDecodeOptions::strict();
let _decoder = LenientJsonDecoder::new(options);
let _moved_options = options;

Implementations§

Source §

impl JsonDecodeOptions

Source

pub const fn lenient() -> Self

Creates the default lenient option set.

§Returns

An option set that enables every supported normalization rule, applies no input-size limit, and redacts input-derived error details.

Source

pub const fn strict() -> Self

Creates an option set that disables all text-rewriting rules.

The decoder still applies empty-input classification, optional raw and normalized input-size limits, the configured privacy policy, and stable error mapping before or around parsing and deserialization.

§Returns

An option set that leaves input text unchanged, applies no raw or normalized size limit, delegates parsing and deserialization to serde_json, and redacts input-derived error details.

Source

pub const fn trim_whitespace(&self) -> bool

Returns whether leading and trailing whitespace is removed.

§Returns

true when surrounding whitespace is removed; otherwise, false.

Source

pub const fn with_trim_whitespace(self, enabled: bool) -> Self

Returns these options with whitespace trimming enabled or disabled.

§Parameters

enabled - Whether to remove surrounding whitespace.

§Returns

The updated option set.

Source

pub const fn strip_utf8_bom(&self) -> bool

Returns whether a leading UTF-8 byte order mark is removed.

§Returns

true when a leading UTF-8 byte order mark is removed; otherwise, false.

Source

pub const fn with_strip_utf8_bom(self, enabled: bool) -> Self

Returns these options with UTF-8 byte order mark stripping configured.

§Parameters

enabled - Whether to remove a leading UTF-8 byte order mark.

§Returns

The updated option set.

Source

pub const fn markdown_fence_policy(&self) -> &MarkdownFencePolicy

Returns the policy used to remove one outer Markdown code fence.

§Returns

The configured Markdown fence policy.

§Examples

#![deny(unused_must_use)]
use qubit_json::JsonDecodeOptions;

let options = JsonDecodeOptions::strict();
options.markdown_fence_policy();

Source

pub const fn with_markdown_fence_policy( self, markdown_fence_policy: MarkdownFencePolicy, ) -> Self

Returns these options with a Markdown fence policy.

§Parameters

markdown_fence_policy - Policy used to recognize and remove one outer Markdown code fence.

§Returns

The updated option set.

Source

pub const fn escape_control_chars_in_strings(&self) -> bool

Returns whether raw control characters in JSON strings are escaped.

§Returns

true when raw ASCII control characters inside JSON strings are escaped; otherwise, false.

Source

pub const fn with_escape_control_chars_in_strings(self, enabled: bool) -> Self

Returns these options with JSON-string control character escaping configured.

§Parameters

enabled - Whether to escape raw ASCII control characters inside JSON strings.

§Returns

The updated option set.

Source

pub const fn max_input_bytes(&self) -> Option<usize>

Returns the raw input byte-size limit.

§Returns

Some(limit) when accepted raw input is capped at limit bytes, or None when the decoder enforces no input-size limit.

Source

pub const fn with_max_input_bytes(self, max_input_bytes: Option<usize>) -> Self

Returns these options with a raw input byte-size limit.

§Parameters

max_input_bytes - Some(limit) to cap the raw input at limit bytes, or None to remove the limit.

§Returns

The updated option set.

Source

pub const fn max_normalized_bytes(&self) -> Option<usize>

Returns the normalized JSON byte-size limit.

§Returns

Some(limit) when normalized JSON is capped at limit bytes, or None when the decoder enforces no normalized-size limit.

Source

pub const fn with_max_normalized_bytes( self, max_normalized_bytes: Option<usize>, ) -> Self

Returns these options with a normalized JSON byte-size limit.

The decoder calculates the normalized size before allocating repaired text for raw control characters, so this limit also bounds the allocation caused by supported control-character escaping.