Skip to main content

NormalizedJsonDocument

Struct NormalizedJsonDocument 

Source
pub struct NormalizedJsonDocument<'input> { /* private fields */ }
Expand description

A normalized JSON document whose text outlives borrowed decode results.

Preparing a document charges raw and normalized input budgets. Decoding it later charges only decoded-value budgets, and the same document may be decoded repeatedly. Documents are detached from the decoder that prepared them; value charges belong to the decoder performing each decode.

Borrowing follows Serde’s JSON representation rules: strings without JSON escapes can borrow from this document, while strings containing escapes require an owned target because deserialization must materialize their unescaped contents.

§Examples

use qubit_budget::json::JsonDecodeLimits;
use qubit_json::decode::NormalizingJsonDecodePolicy;
use qubit_json::decode::NormalizingJsonDecoder;
use serde_json::Value;

let input = "  {\"ok\":true}  ";
let mut decoder = NormalizingJsonDecoder::with_limits(
    NormalizingJsonDecodePolicy::builder().build(),
    JsonDecodeLimits::new(),
);
let document = decoder.prepare_str(input)?;
assert_eq!(document.as_str(), r#"{"ok":true}"#);
assert_eq!(document.raw_input_bytes(), input.len());
assert_eq!(document.normalized_input_bytes(), document.as_str().len());
let value = decoder.decode_precharged_document::<Value>(&document)?;
assert_eq!(value["ok"], true);

Implementations§

Source§

impl<'input> NormalizedJsonDocument<'input>

Source

pub fn as_str(&self) -> &str

Returns the normalized JSON text retained by this document.

The returned slice borrows the document. It is the exact text consumed by later document-based decoding and does not allocate.

§Returns

The normalized JSON text.

Source

pub const fn raw_input_bytes(&self) -> usize

Returns the original input length in bytes.

This value includes whitespace, a UTF-8 byte-order mark, and any other input bytes removed or rewritten during normalization.

§Returns

The byte length charged for the original input.

Source

pub const fn normalized_input_bytes(&self) -> usize

Returns the normalized text length in bytes.

This is the byte length of Self::as_str, after all enabled normalization has completed.

§Returns

The byte length charged for normalized text.

Trait Implementations§

Source§

impl<'input> Clone for NormalizedJsonDocument<'input>

Source§

fn clone(&self) -> NormalizedJsonDocument<'input>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<'input> Debug for NormalizedJsonDocument<'input>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'input> Freeze for NormalizedJsonDocument<'input>

§

impl<'input> RefUnwindSafe for NormalizedJsonDocument<'input>

§

impl<'input> Send for NormalizedJsonDocument<'input>

§

impl<'input> Sync for NormalizedJsonDocument<'input>

§

impl<'input> Unpin for NormalizedJsonDocument<'input>

§

impl<'input> UnsafeUnpin for NormalizedJsonDocument<'input>

§

impl<'input> UnwindSafe for NormalizedJsonDocument<'input>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.