Struct ParserLimits 

#[non_exhaustive]
pub struct ParserLimits {

    pub max_depth: usize,
    pub max_document_length: usize,
    pub max_stream_bytes: usize,
    pub max_alias_expansions: usize,
    pub max_mapping_keys: usize,
    pub max_sequence_length: usize,
    pub max_events: usize,
    pub max_nodes: usize,
    pub max_total_scalar_bytes: usize,
    pub max_documents: usize,
    pub max_merge_keys: usize,
    pub alias_anchor_ratio: Option<f64>,
    pub alias_jump_event_factor: Option<usize>,
    pub max_include_depth: usize,
    pub max_include_sources: usize,
    pub max_total_include_bytes: usize,
}

Resource budgets enforced while parsing YAML.

This value separates denial-of-service controls from YAML semantics and post-parse integrations. Apply a complete budget set with ParserConfig::with_limits, or read the active budgets with ParserConfig::limits. Existing ParserConfig limit fields remain public for backward compatibility.

Examples

use noyalib::{ParserConfig, ParserLimits};

let mut limits = ParserLimits::strict();
limits.max_document_length = 8 * 1024;
let cfg = ParserConfig::new().with_limits(limits);
assert_eq!(cfg.max_document_length, 8 * 1024);

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

max_depth: usize

Maximum YAML structural recursion depth.

max_document_length: usize

Maximum bytes in one YAML document.

max_stream_bytes: usize

Maximum bytes in one multi-document stream.

max_alias_expansions: usize

Maximum expansions of one anchor.

max_mapping_keys: usize

Maximum keys in one mapping.

max_sequence_length: usize

Maximum elements in one sequence.

max_events: usize

Maximum parser events across the input.

max_nodes: usize

Maximum Value nodes across the input.

max_total_scalar_bytes: usize

Maximum scalar bytes after alias expansion.

max_documents: usize

Maximum documents in one stream.

max_merge_keys: usize

Maximum merge-key entries across one document.

alias_anchor_ratio: Option<f64>

Optional maximum alias-to-anchor ratio.

alias_jump_event_factor: Option<usize>

Optional transitive alias-expansion factor per parser event.

max_include_depth: usize

Maximum !include recursion depth.

max_include_sources: usize

Maximum sources resolved by one include walk.

max_total_include_bytes: usize

Maximum cumulative bytes returned by include resolvers.

Implementations

impl ParserLimits

pub fn profile(profile: ParserProfile) -> Self

Return the resource budgets associated with a named parser profile.

The SerdeYaml profile uses the standard absolute budgets plus the compatibility layer’s transitive alias-expansion factor.

pub const fn strict() -> Self

Return the tighter budgets used by ParserProfile::Strict.

Trait Implementations

impl Clone for ParserLimits

fn clone(&self) -> ParserLimits

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ParserLimits

impl Debug for ParserLimits

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

Formats the value using the given formatter.

impl Default for ParserLimits

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for ParserLimits

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ParserLimits