Struct BudgetReport 

#[non_exhaustive]
pub struct BudgetReport {
    pub breached: Option<BudgetBreach>,
    pub events: usize,
    pub aliases: usize,
    pub anchors: usize,
    pub recorded_anchor_events: usize,
    pub recorded_anchor_bytes: usize,
    pub documents: usize,
    pub nodes: usize,
    pub max_depth: usize,
    pub total_scalar_bytes: usize,
    pub total_comment_bytes: usize,
    pub merge_keys: usize,
}

Summary of the scan (even if no breach).

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.

breached: Option<BudgetBreach>

Some(..) if a limit was exceeded; None if all budgets were respected.

events: usize

Total number of parser events observed.

aliases: usize

Total number of alias events (*ref).

anchors: usize

Total number of distinct anchors that were defined (by id).

recorded_anchor_events: usize

Cumulative number of event copies attempted for anchor retention.

recorded_anchor_bytes: usize

Cumulative owned string payload bytes attempted for retained anchor events.

documents: usize

Total number of YAML documents in the stream.

nodes: usize

Total number of nodes encountered (scalars + sequence starts + mapping starts).

max_depth: usize

Maximum structural nesting depth reached at any point in the stream.

total_scalar_bytes: usize

Sum of bytes across all scalar values (Scalar.value.len()), saturating on overflow.

total_comment_bytes: usize

Sum of bytes across all comment values, saturating on overflow.

merge_keys: usize

Total number of merge keys (<<) encountered while merge-key expansion was enabled.

Trait Implementations

impl Clone for BudgetReport

fn clone(&self) -> BudgetReport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BudgetReport

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

Formats the value using the given formatter.

impl Default for BudgetReport

fn default() -> BudgetReport

Returns the “default value” for a type.