Struct rsonpath::query::builder::JsonPathQueryBuilder

pub struct JsonPathQueryBuilder { /* private fields */ }

Builder for JsonPathQuery instances.

Examples

let builder = JsonPathQueryBuilder::new()
    .child(JsonString::new("a"))
    .descendant(JsonString::new("b"))
    .any_child()
    .child(JsonString::new("c"))
    .any_descendant();

// Can also use `builder.build()`.
let query: JsonPathQuery = builder.into();

assert_eq!(format!("{query}"), "$['a']..['b'][*]['c']..[*]");

Implementations

impl JsonPathQueryBuilder

pub fn new() -> Self

Initialize an empty builder.

Examples

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

assert_eq!(*query.root(), JsonPathQueryNode::Root(None));

pub fn child(self, member_name: JsonString) -> Self

Add a child selector with a given member name.

pub fn array_index_child(self, index: NonNegativeArrayIndex) -> Self

Add a child selector with a given index.

pub fn array_index_descendant(self, index: NonNegativeArrayIndex) -> Self

Add a descendant selector with a given index.

pub fn any_child(self) -> Self

Add a wildcard child selector.

pub fn descendant(self, member_name: JsonString) -> Self

Add a descendant selector with a given member_name.

pub fn any_descendant(self) -> Self

Add a wildcard descendant selector.

pub fn build(self) -> JsonPathQuery

Consume the builder and produce a JsonPathQuery.

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.