Struct Limits 

pub struct Limits {

    pub max_reader_input_bytes: Option<usize>,
    pub max_depth: Option<usize>,
    pub max_nodes: Option<usize>,
    pub max_buffered_comment_events: Option<usize>,
    pub simple_key_max_lookahead: Option<usize>,
    pub flow_nesting_limit: Option<usize>,
    pub max_events: Option<usize>,
    pub max_aliases: Option<usize>,
    pub max_anchors: Option<usize>,
    pub max_recorded_anchor_events: Option<usize>,
    pub max_recorded_anchor_bytes: Option<usize>,
    pub max_property_expansion_depth: Option<usize>,
    pub max_total_property_interpolation_work: Option<usize>,
    pub max_inclusion_depth: Option<u32>,
    pub max_documents: Option<usize>,
    pub max_total_scalar_bytes: Option<usize>,
    pub max_total_comment_bytes: Option<usize>,
    pub max_merge_keys: Option<usize>,
    pub alias_anchor_min_aliases: Option<usize>,
    pub alias_anchor_ratio_multiplier: Option<usize>,
}

Available on crate features input-toml or input-yaml only.

Overrides for the limits a text is held to, one per field. None leaves the field to the next tier.

Each field is decided on its own, highest first:

1. the call: Input::limits;
2. with input-yaml, the repository: limits: in .ctl/input.yaml, installed by use_repo_limits;
3. the process: set_default_limits, or App::input_limits;
4. the default: ctl-core’s for the three fields every format reads, and serde-saphyr’s for the YAML-only fields.

A repository beats the CLI’s default because the user owns the repository, as a user’s environment beats the CLI’s built-in width.

The field set follows the enabled format features. max_reader_input_bytes, max_depth, and max_nodes exist in every build, and the YAML-only fields exist with input-yaml. Cargo enables a feature for every crate in a build, so another crate can add fields to a build of yours. Build a value with ..Limits::NONE, as in Limits { max_depth: Some(8), ..Limits::NONE }, and it compiles whatever the build enables.

enforce_alias_anchor_ratio is not here: the ratio check is one comparison after scanning, so turning it off saves nothing. It stays on; its multiplier and minimum alias count are overridable.

Fields

max_reader_input_bytes: Option<usize>

Bytes of input text. Also checked for text already in memory.

max_depth: Option<usize>

Nesting of YAML sequences and mappings, or of TOML arrays and tables, with the root table as 1.

max_nodes: Option<usize>

YAML sequences, mappings, and scalars in total; in TOML, the root table and every table, array, and value.

max_buffered_comment_events: Option<usize>

Available on crate feature input-yaml only.

Comment events buffered while resolving an ambiguous entry.

simple_key_max_lookahead: Option<usize>

Available on crate feature input-yaml only.

Characters scanned to resolve a simple key.

flow_nesting_limit: Option<usize>

Available on crate feature input-yaml only.

Simultaneously nested flow collections.

max_events: Option<usize>

Available on crate feature input-yaml only.

Parser events in total.

max_aliases: Option<usize>

Available on crate feature input-yaml only.

Alias (*ref) events.

max_anchors: Option<usize>

Available on crate feature input-yaml only.

Distinct anchor (&anchor) definitions.

max_recorded_anchor_events: Option<usize>

Available on crate feature input-yaml only.

Event copies retained for anchors.

max_recorded_anchor_bytes: Option<usize>

Available on crate feature input-yaml only.

Bytes of string payload retained for anchors.

max_property_expansion_depth: Option<usize>

Available on crate feature input-yaml only.

Nested expansions in one property interpolation.

max_total_property_interpolation_work: Option<usize>

Available on crate feature input-yaml only.

Bytes inspected across all property interpolation.

max_inclusion_depth: Option<u32>

Available on crate feature input-yaml only.

Nesting of !include.

max_documents: Option<usize>

Available on crate feature input-yaml only.

YAML documents in one text.

max_total_scalar_bytes: Option<usize>

Available on crate feature input-yaml only.

Bytes of scalar text in total.

max_total_comment_bytes: Option<usize>

Available on crate feature input-yaml only.

Bytes of comment text in total.

max_merge_keys: Option<usize>

Available on crate feature input-yaml only.

Merge keys (<<). ctl-core refuses merge keys whatever this says.

alias_anchor_min_aliases: Option<usize>

Available on crate feature input-yaml only.

Aliases allowed before the alias-to-anchor ratio applies.

alias_anchor_ratio_multiplier: Option<usize>

Available on crate feature input-yaml only.

How many aliases each anchor may have once the ratio applies.

Implementations

impl Limits

pub const NONE: Self

No overrides: every field falls through.

pub fn or(self, lower: &Self) -> Self

self, with each unset field taken from lower.

impl Limits

pub const DEFAULT_MAX_READER_INPUT_BYTES: usize

max_reader_input_bytes when no tier sets it: 256 MiB.

pub const DEFAULT_MAX_DEPTH: usize = 64

max_depth when no tier sets it.

pub const DEFAULT_MAX_NODES: usize = 250_000

max_nodes when no tier sets it.

Trait Implementations

impl Clone for Limits

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Limits

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

Formats the value using the given formatter.

impl Default for Limits

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Limits

where Limits: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Limits

impl PartialEq for Limits

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Limits