Skip to main content

FromJsonConfigBuilder

Struct FromJsonConfigBuilder 

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

Builder for FromJsonConfig

Provides ergonomic configuration of JSON import limits and behavior.

§Examples

use hedl_json::FromJsonConfig;

// Custom limits
let config = FromJsonConfig::builder()
    .max_depth(1_000)
    .max_array_size(100_000)
    .max_string_length(10 * 1024 * 1024)
    .build();

// Strict limits for untrusted input
let strict = FromJsonConfig::builder()
    .max_depth(50)
    .max_array_size(10_000)
    .max_string_length(1_000_000)
    .max_object_size(1_000)
    .build();

// Unlimited (use with caution!)
let unlimited = FromJsonConfig::builder()
    .unlimited()
    .build();

Implementations§

Source§

impl FromJsonConfigBuilder

Source

pub fn default_type_name(self, name: impl Into<String>) -> Self

Set the default type name for arrays without metadata

Source

pub fn version(self, major: u32, minor: u32) -> Self

Set the HEDL version to use

Source

pub fn max_depth(self, limit: usize) -> Self

Set the maximum recursion depth

Use None to disable the limit (not recommended for untrusted input).

Source

pub fn max_array_size(self, limit: usize) -> Self

Set the maximum array size

Use None to disable the limit (not recommended for untrusted input).

Source

pub fn max_string_length(self, limit: usize) -> Self

Set the maximum string length in bytes

Use None to disable the limit (not recommended for untrusted input).

Source

pub fn max_object_size(self, limit: usize) -> Self

Set the maximum object size (number of keys)

Use None to disable the limit (not recommended for untrusted input).

Source

pub fn surrogate_policy(self, policy: SurrogatePolicy) -> Self

Set the policy for handling unpaired UTF-16 surrogates

§Options
  • SurrogatePolicy::Reject (default): Error on invalid surrogates
  • SurrogatePolicy::ReplaceWithFFFD: Replace with U+FFFD
  • SurrogatePolicy::Skip: Remove invalid surrogates silently
§Example
use hedl_json::{FromJsonConfig, SurrogatePolicy};

let config = FromJsonConfig::builder()
    .surrogate_policy(SurrogatePolicy::ReplaceWithFFFD)
    .build();
Source

pub fn unlimited(self) -> Self

Disable all limits (use with caution - only for trusted input)

This removes all safety limits and can lead to memory exhaustion or stack overflow with malicious or malformed JSON.

Source

pub fn lenient(self, lenient: bool) -> Self

Enable lenient JSON parsing (trailing commas, comments)

When enabled, the parser accepts:

  • Trailing commas in arrays and objects
  • Single-line (//) and multi-line (/* */) comments

Requires the lenient feature flag.

§Examples
use hedl_json::FromJsonConfig;

let config = FromJsonConfig::builder()
    .lenient(true)
    .build();

// Now you can parse JSON with trailing commas
let json = r#"{"name": "Alice", "age": 30,}"#;
Source

pub fn build(self) -> FromJsonConfig

Build the configuration

Trait Implementations§

Source§

impl Clone for FromJsonConfigBuilder

Source§

fn clone(&self) -> FromJsonConfigBuilder

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FromJsonConfigBuilder

Source§

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

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

impl Default for FromJsonConfigBuilder

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more