Struct QueryBuilder 

pub struct QueryBuilder<'q> {
    client: &'q mut Client,
    root: Option<&'q str>,
    depth: Option<u32>,
    include_values: bool,
}

Available on crate feature client only.

Query builder returned by Client::query.

Fields

client: &'q mut Client

root: Option<&'q str>

depth: Option<u32>

include_values: bool

Implementations

impl<'q> QueryBuilder<'q>

pub const fn new(client: &'q mut Client) -> Self

Creates a new query builder.

pub const fn root(self, root: &'q str) -> Self

Sets the root path for the query.

All paths in the result will be relative to this root.

pub const fn depth(self, depth: u32) -> Self

Sets the maximum depth for the query.

Default is unlimited - which includes all child nodes.

pub const fn include_values(self, include: bool) -> Self

Whether to include values in the query result.

Default is false.

pub async fn send(self) -> Result<Result<QueryResult<'q>, LelumError<'q>>>

Sends the query request and returns the result.