Struct rsonpath_syntax::builder::JsonPathQueryBuilder

pub struct JsonPathQueryBuilder { /* private fields */ }

Builder for JsonPathQuery instances.

Examples

let mut builder = JsonPathQueryBuilder::new();
     
builder.child_name("a")
    .descendant_name("b")
    .child_wildcard()
    .child_name("c")
    .descendant_wildcard()
    .child_slice(|x| x.with_start(3).with_end(-7).with_step(2));

// Can also use `builder.build()` as a non-consuming version.
let query: JsonPathQuery = builder.into();

assert_eq!(query.to_string(), "$['a']..['b'][*]['c']..[*][3:-7:2]");

Implementations

impl JsonPathQueryBuilder

pub fn new() -> Self

Initialize an empty builder.

Examples

let builder = JsonPathQueryBuilder::new();
let query: JsonPathQuery = builder.into();

assert!(query.segments().is_empty());

pub fn child<F>(&mut self, selectors_builder: F) -> &mut Self

where F: FnOnce(&mut JsonPathSelectorsBuilder) -> &mut JsonPathSelectorsBuilder,

Add a child segment with selectors defined in the selectors_builder function.

See the documentation of JsonPathSelectorsBuilder for selector building details.

Examples

let mut builder = JsonPathQueryBuilder::new();
builder.child(|x| x.name("abc").index(10).wildcard());
let result = builder.into_query();
assert_eq!(result.segments().len(), 1);
let segment = &result.segments()[0];
assert!(segment.is_child());
assert_eq!(&segment.selectors().as_slice(), &[
    Selector::Name(JsonString::new("abc")),
    Selector::Index(Index::FromStart(JsonUInt::from(10))),
    Selector::Wildcard,
]);

pub fn descendant<F>(&mut self, selectors_builder: F) -> &mut Self

where F: FnOnce(&mut JsonPathSelectorsBuilder) -> &mut JsonPathSelectorsBuilder,

Add a descendant segment with selectors defined in the selectors_builder function.

See the documentation of JsonPathSelectorsBuilder for selector building details.

Examples

let mut builder = JsonPathQueryBuilder::new();
builder.descendant(|x| x.name("abc").index(10).wildcard());
let result = builder.into_query();
assert_eq!(result.segments().len(), 1);
let segment = &result.segments()[0];
assert!(segment.is_descendant());
assert_eq!(&segment.selectors().as_slice(), &[
    Selector::Name(JsonString::new("abc")),
    Selector::Index(Index::FromStart(JsonUInt::from(10))),
    Selector::Wildcard,
]);

pub fn child_name<S: Into<JsonString>>(&mut self, name: S) -> &mut Self

Add a child segment with a single name selector.

This is a shorthand for .child(|x| x.name(name)).

pub fn child_wildcard(&mut self) -> &mut Self

Add a child segment with a single wildcard selector.

This is a shorthand for .child(|x| x.wildcard()).

pub fn child_index<N: Into<JsonInt>>(&mut self, idx: N) -> &mut Self

Add a child segment with a single index selector.

This is a shorthand for .child(|x| x.index(idx)).

pub fn child_slice<F>(&mut self, slice_builder: F) -> &mut Self

where F: FnOnce(&mut SliceBuilder) -> &mut SliceBuilder,

Add a child segment with a single slice selector.

This is a shorthand for .child(|x| x.slice(slice_builder)).

pub fn descendant_name<S: Into<JsonString>>(&mut self, name: S) -> &mut Self

Add a descendant segment with a single name selector.

This is a shorthand for .descendant(|x| x.name(name)).

pub fn descendant_wildcard(&mut self) -> &mut Self

Add a descendant segment with a single name selector.

This is a shorthand for .descendant(|x| x.wildcard()).

pub fn descendant_index<N: Into<JsonInt>>(&mut self, idx: N) -> &mut Self

Add a descendant segment with a single name selector.

This is a shorthand for .descendant(|x| x.index(idx)).

pub fn descendant_slice<F>(&mut self, slice_builder: F) -> &mut Self

where F: FnOnce(&mut SliceBuilder) -> &mut SliceBuilder,

Add a descendant segment with a single slice selector.

This is a shorthand for .descendant(|x| x.slice(slice_builder)).

pub fn to_query(&mut self) -> JsonPathQuery

Produce a JsonPathQuery from the builder.

This clones all data in the builder to create the query. If possible, use into_query to consume the builder and avoid a copy.

pub fn into_query(self) -> JsonPathQuery

Produce a JsonPathQuery consuming builder.

To avoid consuming the builder use to_query.

Trait Implementations

impl Default for JsonPathQueryBuilder

fn default() -> Self

Returns the “default value” for a type.

impl From<JsonPathQueryBuilder> for JsonPathQuery

fn from(value: JsonPathQueryBuilder) -> Self

Converts to this type from the input type.