Struct Options 

#[non_exhaustive]
pub struct Options {
    pub emit_comments: bool,
    pub max_buffered_comment_events: usize,
    pub simple_key_max_lookahead: usize,
    pub flow_nesting_limit: usize,
    pub block_nesting_limit: usize,
    pub max_directive_bytes: usize,
    pub max_reserved_directive_params: usize,
}

Options controlling parser and scanner behavior and resource usage.

Construct this type with crate::options! so that code remains compatible when new options are added in future releases.

Examples

let options = granit_parser::options! {
    max_buffered_comment_events: 64,
    emit_comments: false,
    flow_nesting_limit: 512,
    block_nesting_limit: 256,
};

assert_eq!(options.max_buffered_comment_events, 64);
assert!(!options.emit_comments);
assert_eq!(options.flow_nesting_limit, 512);
assert_eq!(options.block_nesting_limit, 256);

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.

emit_comments: bool

Whether scanners emit comment tokens and parsers emit comment events.

The default is true. When this is false, comments are still recognized and validated as YAML syntax, but their text is not captured and no comment tokens or events are emitted. Comment bytes are still consumed, so this is not an input-size or processing-time limit. Self::max_buffered_comment_events has no effect while comment emission is disabled.

max_buffered_comment_events: usize

Maximum number of consecutive comment events buffered while resolving an ambiguous collection entry.

The default is 96. A value of zero rejects the first comment that would need buffering.

simple_key_max_lookahead: usize

Maximum number of characters inspected while resolving a simple key.

The default is 1024, matching YAML’s simple-key length restriction. A key at exactly this limit is accepted. Lower values impose a stricter resource limit; higher values relax that YAML restriction.

flow_nesting_limit: usize

Maximum number of simultaneously nested flow collections.

The default is 255. A value of zero rejects the first flow collection opener.

block_nesting_limit: usize

Maximum number of simultaneously nested block collections parsed, or block indentation levels retained by a scanner used directly.

The default is 255. A value of zero rejects the first block sequence or mapping. This bounds both indentation state retained while scanning and the number of closing tokens queued when nested block collections end together. Parsers also count indentless block sequences, which do not add scanner indentation state.

max_directive_bytes: usize

Maximum number of UTF-8 source bytes retained for a directive name and payload.

The default is 1024. Separating blanks before retained values count toward the limit. %YAML version components instead have a fixed nine-digit limit and are stored as integers. Real directives are far shorter than the default.

max_reserved_directive_params: usize

Maximum number of parameters retained for a single reserved directive.

The default is 16. The parser ignores reserved directives, so their parameters only reach code driving crate::Scanner directly. A value of zero rejects the first parameter.

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Options

impl PartialEq for Options

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Options