Struct ParserBuilder

pub struct ParserBuilder { /* private fields */ }

Configurable builder for a Parser instance.

Implementations

impl ParserBuilder

pub fn new() -> Self

Create a new instance of the builder with the default settings.

pub fn set_recursion_limit(&mut self, value: Option<usize>) -> &mut Self

Override the default recursion limit in a query. Defaults to Parser::RECURSION_LIMIT_DEFAULT.

JSONPath queries are inherently recursive, since

• LogicalExpr can be an arbitrarily deep tree of AND/OR operators;
• the TestExpr in a filter can test arbitrary nested JSONPath queries.

Our parser implementation is recursive, so an excessively nested query could overflow the stack.

The limit can be relaxed here, or removed entirely by passing None.

Examples

let default_parser = ParserBuilder::new().build();
let no_nesting_parser = ParserBuilder::new()
    .set_recursion_limit(Some(1))
    .build();

let query = "$[?@[?@]]";
assert!(default_parser.parse(query).is_ok());
assert!(no_nesting_parser.parse(query).is_err());

pub fn allow_surrounding_whitespace(&mut self, value: bool) -> &mut Self

Control whether leading and trailing whitespace is allowed in a query. Defaults to false.

The RFC grammar makes leading and trailing whitespace disallowed. The Parser defaults to this strict handling, but can be relaxed with this setting.

Examples

let default_parser = ParserBuilder::new().build();
let relaxed_parser = ParserBuilder::new()
    .allow_surrounding_whitespace(true)
    .build();

let query = "  $.leading_whitespace";
assert!(default_parser.parse(query).is_err());
assert!(relaxed_parser.parse(query).is_ok());

pub fn build(&self) -> Parser

Build a new instance of a Parser.

Trait Implementations

impl Clone for ParserBuilder

fn clone(&self) -> ParserBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParserBuilder

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

Formats the value using the given formatter.

impl Default for ParserBuilder

fn default() -> ParserBuilder

Returns the “default value” for a type.

impl From<ParserBuilder> for Parser

fn from(value: ParserBuilder) -> Self

Converts to this type from the input type.