Skip to main content

JsonValidatedDecodeOptions

Struct JsonValidatedDecodeOptions 

Source
pub struct JsonValidatedDecodeOptions { /* private fields */ }
Expand description

Generic structural and source-token limits for validated decoding.

By default, no additional limits are imposed and the number model is Integer64. A limit set to Some(0) is a real zero-item/zero-byte limit; None means that the corresponding additional limit is disabled. Value nodes and object-key nodes both count toward the node limit. String limits count the source spelling inside each token, excluding quotes and including escape bytes such as the six bytes in \u0061.

§Examples

use qubit_json::decode::{JsonDecoder, JsonNumberPolicy, JsonValidatedDecodeOptions};

let options = JsonValidatedDecodeOptions::builder()
    .max_value_and_key_nodes(3)
    .max_encoded_string_bytes(8)
    .build();
let value = JsonDecoder::unlimited().decode_unique_validated_str(
    r#"{"id":42}"#,
    &options,
    |_path, _token| Ok::<_, std::convert::Infallible>(JsonNumberPolicy::ExactSafeInteger),
)?;
assert_eq!(value.as_value()["id"].as_i64(), Some(42));

Implementations§

Source§

impl JsonValidatedDecodeOptions

Source

pub fn builder() -> JsonValidatedDecodeOptionsBuilder

Creates a builder with no extra limits and the Integer64 model.

§Returns

A builder whose optional root kind and additional limits are unset.

Source

pub const fn root_kind(&self) -> Option<JsonRootKind>

Returns the optional required root kind. None accepts any root kind.

§Returns

The required root kind, or None when no root-kind restriction applies.

Source

pub const fn admission_policy(&self) -> JsonValidatedAdmissionPolicy

Returns the token admission order used by validated decoding.

§Returns

The configured policy. The default is JsonValidatedAdmissionPolicy::Immediate.

Source

pub const fn number_model(&self) -> JsonDecodeNumberModel

Returns the selected number model.

§Returns

The number representation model used for preserved numbers.

Source

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

Returns the optional per-document value-and-key node limit. None disables this additional limit; Some(0) permits no nodes.

§Returns

The configured combined node limit, or None when it is disabled.

Source

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

Returns the optional per-token source-string byte limit. It excludes the quotes and includes escape spelling bytes. None disables this additional limit; Some(0) permits only empty string token contents.

§Returns

The configured per-token source-byte limit, or None when disabled.

Trait Implementations§

Source§

impl Clone for JsonValidatedDecodeOptions

Source§

fn clone(&self) -> Self

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 Debug for JsonValidatedDecodeOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for JsonValidatedDecodeOptions

Source§

impl PartialEq for JsonValidatedDecodeOptions

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for JsonValidatedDecodeOptions

Auto Trait Implementations§

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.