jsongrep 0.9.0

JSONPath-inspired query language for JSON, YAML, TOML, and other serialization formats
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

/*!
This module provides the main query engine implementation, as well as the parser for the query
language and the intermediary AST representations of queries.
*/
pub mod ast;
pub(crate) mod common;
pub mod dfa;
pub(crate) mod nfa;
pub mod parser;

use serde_json_borrow::Value;

/// Interface for query engine implementations.
#[deprecated(
    since = "0.9.0",
    note = "Use `QueryDFA::find` directly. This trait will be removed in a future release."
)]
pub trait QueryEngine {
    /// Finds all JSON pointers in the given JSON document that match the
    /// specified query.
    ///
    /// Follows the semantics of `JSONPath`, returning the matched values as an
    /// array of `JSONPointer` instances.
    fn find<'a>(
        &self,
        json: &'a Value<'a>,
        query: &'a Query,
    ) -> Vec<JSONPointer<'a>>;
}

// Re-exports
pub use ast::*;
pub use common::{JSONPointer, PathType};
pub use dfa::*;
pub use nfa::*;
pub use parser::*;