Struct QueryLibrary 

pub struct QueryLibrary { /* private fields */ }

A collection of named queries parsed from a .jpx file.

Implementations

impl QueryLibrary

pub fn new() -> QueryLibrary

Create an empty query library.

pub fn parse(content: &str) -> Result<QueryLibrary, ParseError>

Parse a query library from file content.

Format

• -- :name <name> starts a new query
• -- :desc <description> adds a description to the current query
• -- other comment lines are ignored
• Non-comment lines are appended to the current query’s expression

Errors

Returns an error if:

• A query has an empty name
• A query has no expression
• Duplicate query names are found
• No queries are found in the content

Example

use jpx_core::query_library::QueryLibrary;

let content = r#"
-- :name count
length(@)
"#;

let library = QueryLibrary::parse(content).unwrap();
assert_eq!(library.len(), 1);

pub fn get(&self, name: &str) -> Option<&NamedQuery>

Get a query by name.

Example

use jpx_core::query_library::QueryLibrary;

let lib = QueryLibrary::parse("-- :name test\nlength(@)").unwrap();
let query = lib.get("test").unwrap();
assert_eq!(query.expression, "length(@)");

pub fn list(&self) -> &[NamedQuery]

Get all queries.

Example

use jpx_core::query_library::QueryLibrary;

let lib = QueryLibrary::parse("-- :name a\n`1`\n-- :name b\n`2`").unwrap();
assert_eq!(lib.list().len(), 2);

pub fn names(&self) -> Vec<&str>

Get query names.

Example

use jpx_core::query_library::QueryLibrary;

let lib = QueryLibrary::parse("-- :name foo\n`1`\n-- :name bar\n`2`").unwrap();
assert_eq!(lib.names(), vec!["foo", "bar"]);

pub fn len(&self) -> usize

Get the number of queries in the library.

pub fn is_empty(&self) -> bool

Check if the library is empty.

pub fn iter(&self) -> impl Iterator<Item = &NamedQuery>

Iterate over queries.

Trait Implementations

impl Clone for QueryLibrary

fn clone(&self) -> QueryLibrary

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QueryLibrary

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

Formats the value using the given formatter.

impl Default for QueryLibrary

fn default() -> QueryLibrary

Returns the “default value” for a type.

impl<'a> IntoIterator for &'a QueryLibrary

type Item = &'a NamedQuery

The type of the elements being iterated over.

type IntoIter = Iter<'a, NamedQuery>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a QueryLibrary as IntoIterator>::IntoIter

Creates an iterator from a value.