Struct JSONQuery

pub struct JSONQuery {
    pub elements: Vec<QueryElement>,
}

This is the main interface to this library. Create a new JSONQuery by calling parse.

Fields

elements: Vec<QueryElement>

A list of access-elements, field names or array indices.

Implementations

impl JSONQuery

pub fn parse(input: &str) -> Result<Self, QueryParseErr>

Construct a new JSONQuery object from an example string.

use access_json::JSONQuery;
use access_json::query::QueryElement; // Only needed to validate our parsing.

assert_eq!(
  JSONQuery::parse(".field.array[8]").unwrap().elements,
  vec![QueryElement::field("field"),
       QueryElement::field("array"),
       QueryElement::array_item(8)]);

pub fn execute( &self, target: &dyn AnySerializable, ) -> Result<Option<Value>, QueryExecErr>

Execute a JSONQuery object against any serde-serializable object.

use access_json::JSONQuery;
use std::collections::HashMap;
use serde_json;

let mut data: HashMap<&str, u32> = HashMap::default();
data.insert("cat", 9);

let query = JSONQuery::parse(".cat")?;
let output = query.execute(&data)?;
let expected = serde_json::to_value(&9)?;

assert_eq!(Some(expected), output);

Trait Implementations

impl Clone for JSONQuery

fn clone(&self) -> JSONQuery

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JSONQuery

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for JSONQuery

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for JSONQuery

This is a way to visualize a JSONQuery object as a parse-able string.

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

Formats the value using the given formatter.

impl PartialEq for JSONQuery

fn eq(&self, other: &JSONQuery) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for JSONQuery

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for JSONQuery

impl StructuralPartialEq for JSONQuery