//! JsonPath implementation for Rust //! //! # Example //! ``` //! extern crate jsonpath_lib as jsonpath; //! #[macro_use] extern crate serde_json; //! //! let json_obj = json!({ //! "store": { //! "book": [ //! { //! "category": "reference", //! "author": "Nigel Rees", //! "title": "Sayings of the Century", //! "price": 8.95 //! }, //! { //! "category": "fiction", //! "author": "Evelyn Waugh", //! "title": "Sword of Honour", //! "price": 12.99 //! }, //! { //! "category": "fiction", //! "author": "Herman Melville", //! "title": "Moby Dick", //! "isbn": "0-553-21311-3", //! "price": 8.99 //! }, //! { //! "category": "fiction", //! "author": "J. R. R. Tolkien", //! "title": "The Lord of the Rings", //! "isbn": "0-395-19395-8", //! "price": 22.99 //! } //! ], //! "bicycle": { //! "color": "red", //! "price": 19.95 //! } //! }, //! "expensive": 10 //! }); //! //! let mut selector = jsonpath::selector(&json_obj); //! //! // //! // $.store.book[*].author //! // //! let json = selector("$.store.book[*].author").unwrap(); //! let ret = json!(["Nigel Rees","Evelyn Waugh","Herman Melville","J. R. R. Tolkien"]); //! assert_eq!(json, ret); //! //! // //! // $..author //! // //! let json = selector("$..author").unwrap(); //! let ret = json!(["Nigel Rees","Evelyn Waugh","Herman Melville","J. R. R. Tolkien"]); //! assert_eq!(json, ret); //! //! // //! // $.store.* //! // //! let json = selector("$.store.*").unwrap(); //! let ret = json!([ //! [ //! {"category" : "reference", "author" : "Nigel Rees","title" : "Sayings of the Century", "price" : 8.95}, //! {"category" : "fiction", "author" : "Evelyn Waugh","title" : "Sword of Honour","price" : 12.99}, //! {"category" : "fiction", "author" : "Herman Melville","title" : "Moby Dick","isbn" : "0-553-21311-3","price" : 8.99}, //! {"category" : "fiction", "author" : "J. R. R. Tolkien","title" : "The Lord of the Rings","isbn" : "0-395-19395-8","price" : 22.99} //! ], //! {"color" : "red","price" : 19.95}, //! ]); //! assert_eq!(ret, json); //! //! // //! // $.store..price //! // //! let json = selector("$.store..price").unwrap(); //! let ret = json!([8.95, 12.99, 8.99, 22.99, 19.95]); //! assert_eq!(ret, json); //! //! // //! // $..book[2] //! // //! let json = selector("$..book[2]").unwrap(); //! let ret = json!([{ //! "category" : "fiction", //! "author" : "Herman Melville", //! "title" : "Moby Dick", //! "isbn" : "0-553-21311-3", //! "price" : 8.99 //! }]); //! assert_eq!(ret, json); //! //! // //! // $..book[-2] //! // //! let json = selector("$..book[-2]").unwrap(); //! let ret = json!([{ //! "category" : "fiction", //! "author" : "Herman Melville", //! "title" : "Moby Dick", //! "isbn" : "0-553-21311-3", //! "price" : 8.99 //! }]); //! assert_eq!(ret, json); //! //! // //! // $..book[0,1] //! // //! let json = selector("$..book[0,1]").unwrap(); //! let ret = json!([ //! {"category" : "reference","author" : "Nigel Rees","title" : "Sayings of the Century","price" : 8.95}, //! {"category" : "fiction","author" : "Evelyn Waugh","title" : "Sword of Honour","price" : 12.99} //! ]); //! assert_eq!(ret, json); //! //! // //! // $..book[:2] //! // //! let json = selector("$..book[:2]").unwrap(); //! let ret = json!([ //! {"category" : "reference","author" : "Nigel Rees","title" : "Sayings of the Century","price" : 8.95}, //! {"category" : "fiction","author" : "Evelyn Waugh","title" : "Sword of Honour","price" : 12.99} //! ]); //! assert_eq!(ret, json); //! //! // //! // $..book[2:] //! // //! let json = selector("$..book[2:]").unwrap(); //! let ret = json!([ //! {"category" : "fiction","author" : "Herman Melville","title" : "Moby Dick","isbn" : "0-553-21311-3","price" : 8.99}, //! {"category" : "fiction","author" : "J. R. R. Tolkien","title" : "The Lord of the Rings","isbn" : "0-395-19395-8","price" : 22.99} //! ]); //! assert_eq!(ret, json); //! //! // //! // $..book[?(@.isbn)] //! // //! let json = selector("$..book[?(@.isbn)]").unwrap(); //! let ret = json!([ //! {"category" : "fiction","author" : "Herman Melville","title" : "Moby Dick","isbn" : "0-553-21311-3","price" : 8.99}, //! {"category" : "fiction","author" : "J. R. R. Tolkien","title" : "The Lord of the Rings","isbn" : "0-395-19395-8","price" : 22.99} //! ]); //! assert_eq!(ret, json); //! //! // //! // $.store.book[?(@.price < 10)] //! // //! let json = selector("$.store.book[?(@.price < 10)]").unwrap(); //! let ret = json!([ //! {"category" : "reference","author" : "Nigel Rees","title" : "Sayings of the Century","price" : 8.95}, //! {"category" : "fiction","author" : "Herman Melville","title" : "Moby Dick","isbn" : "0-553-21311-3","price" : 8.99} //! ]); //! assert_eq!(ret, json); //! ``` extern crate env_logger; extern crate indexmap; #[macro_use] extern crate log; #[macro_use] extern crate serde; extern crate serde_json; use std::error::Error; use std::ops::Deref; use std::result; use serde_json::Value; use filter::value_filter::JsonValueFilter; use parser::parser::{NodeVisitor, Parser}; use ref_value::model::RefValueWrapper; #[doc(hidden)] pub mod parser; #[doc(hidden)] pub mod filter; #[doc(hidden)] pub mod ref_value; fn query_from_str(json: &str, path: &str) -> result::Result { let mut jf = JsonValueFilter::new(json)?; let mut parser = Parser::new(path); parser.parse(&mut jf)?; Ok(jf) } fn query_from_json_wrapper(json_wrapper: RefValueWrapper, path: &str) -> result::Result { let mut jf = JsonValueFilter::new_from_value(json_wrapper); let mut parser = Parser::new(path); parser.parse(&mut jf)?; Ok(jf) } /// It is a highorder function that compile a JsonPath then returns a function. /// /// this return function can be reused for different JsonObjects. /// /// ```rust /// extern crate jsonpath_lib as jsonpath; /// #[macro_use] extern crate serde_json; /// /// let mut template = jsonpath::compile("$..friends[0]"); /// /// let json_obj = json!({ /// "school": { /// "friends": [ /// {"name": "친구1", "age": 20}, /// {"name": "친구2", "age": 20} /// ] /// }, /// "friends": [ /// {"name": "친구3", "age": 30}, /// {"name": "친구4"} /// ]}); /// /// let json = template(&json_obj).unwrap(); /// let ret = json!([ /// {"name": "친구3", "age": 30}, /// {"name": "친구1", "age": 20} /// ]); /// assert_eq!(json, ret); /// ``` pub fn compile<'a>(path: &'a str) -> impl FnMut(&Value) -> result::Result + 'a { let mut parser = Parser::new(path); let node = parser.compile(); move |json| { match &node { Ok(n) => { let mut jf = JsonValueFilter::new_from_value(json.into()); jf.visit(n.clone()); Ok((&jf.take_value()).into()) } Err(e) => Err(e.clone()) } } } /// It returns highorder function that return a function. /// /// this function has a jsonpath as argument and return a serde_json::value::Value. so you can use different JsonPath for one JsonObject. /// /// ```rust /// extern crate jsonpath_lib as jsonpath; /// #[macro_use] extern crate serde_json; /// /// let json_obj = json!({ /// "school": { /// "friends": [ /// {"name": "친구1", "age": 20}, /// {"name": "친구2", "age": 20} /// ] /// }, /// "friends": [ /// {"name": "친구3", "age": 30}, /// {"name": "친구4"} /// ]}); /// /// let mut selector = jsonpath::selector(&json_obj); /// /// let json = selector("$..friends[0]").unwrap(); /// let ret = json!([ /// {"name": "친구3", "age": 30}, /// {"name": "친구1", "age": 20} /// ]); /// assert_eq!(json, ret); /// /// let json = selector("$..friends[1]").unwrap(); /// let ret = json!([ /// {"name": "친구4"}, /// {"name": "친구2", "age": 20} /// ]); /// assert_eq!(json, ret); /// ``` pub fn selector(json: &Value) -> impl FnMut(&str) -> result::Result { let wrapper: RefValueWrapper = json.into(); move |path: &str| { let mut jf = query_from_json_wrapper(wrapper.clone(), path)?; Ok((&jf.take_value()).into()) } } /// It returns highorder function that returns a function. /// /// this function has a jsonpath as argument and return a serde::Deserialize. so you can use different JsonPath for one JsonObject. /// /// ```rust /// extern crate jsonpath_lib as jsonpath; /// extern crate serde; /// #[macro_use] extern crate serde_json; /// /// use serde::{Deserialize, Serialize}; /// /// let json_obj = json!({ /// "school": { /// "friends": [ /// {"name": "친구1", "age": 20}, /// {"name": "친구2", "age": 20} /// ] /// }, /// "friends": [ /// {"name": "친구3", "age": 30}, /// {"name": "친구4"} /// ]}); /// /// #[derive(Serialize, Deserialize, PartialEq, Debug)] /// struct Friend { /// name: String, /// age: Option, /// } /// /// let mut selector = jsonpath::selector_as::>(&json_obj); /// /// let json = selector("$..friends[0]").unwrap(); /// let ret = vec!( /// Friend { name: "친구3".to_string(), age: Some(30) }, /// Friend { name: "친구1".to_string(), age: Some(20) } /// ); /// assert_eq!(json, ret); /// /// let json = selector("$..friends[1]").unwrap(); /// let ret = vec!( /// Friend { name: "친구4".to_string(), age: None }, /// Friend { name: "친구2".to_string(), age: Some(20) } /// ); /// assert_eq!(json, ret); /// ``` pub fn selector_as(json: &Value) -> impl FnMut(&str) -> result::Result { let wrapper: RefValueWrapper = json.into(); move |path: &str| { let mut jf = query_from_json_wrapper(wrapper.clone(), path)?; T::deserialize(jf.take_value().deref()).map_err(|e| format!("{:?}", e)) } } #[deprecated(since = "0.1.4", note = "Please use the selector function instead")] pub fn reader(json: &Value) -> impl FnMut(&str) -> result::Result { selector(json) } /// Select a JsonObject. it return a serde_json::value::Value. /// /// ```rust /// extern crate jsonpath_lib as jsonpath; /// #[macro_use] extern crate serde_json; /// /// let json_obj = json!({ /// "school": { /// "friends": [ /// {"name": "친구1", "age": 20}, /// {"name": "친구2", "age": 20} /// ] /// }, /// "friends": [ /// {"name": "친구3", "age": 30}, /// {"name": "친구4"} /// ]}); /// /// let json = jsonpath::select(&json_obj, "$..friends[0]").unwrap(); /// /// let ret = json!([ /// {"name": "친구3", "age": 30}, /// {"name": "친구1", "age": 20} /// ]); /// assert_eq!(json, ret); /// ``` pub fn select(json: &Value, path: &str) -> result::Result { let mut jf = query_from_json_wrapper(json.into(), path)?; Ok((&jf.take_value()).into()) } #[deprecated(since = "0.1.4", note = "Please use the select function instead")] pub fn read(json: &Value, path: &str) -> result::Result { select(json, path) } #[deprecated(since = "0.1.7", note = "Please use the select_as_str function instead")] pub fn select_str(json: &str, path: &str) -> result::Result { select_as_str(json, path) } /// Select a JsonObject. it return a JsonObject as String. /// /// ```rust /// extern crate jsonpath_lib as jsonpath; /// #[macro_use] extern crate serde_json; /// /// let ret = jsonpath::select_as_str(r#" /// { /// "school": { /// "friends": [ /// {"name": "친구1", "age": 20}, /// {"name": "친구2", "age": 20} /// ] /// }, /// "friends": [ /// {"name": "친구3", "age": 30}, /// {"name": "친구4"} /// ] /// } /// "#, "$..friends[0]").unwrap(); /// /// assert_eq!(ret, r#"[{"name":"친구3","age":30},{"name":"친구1","age":20}]"#); /// ``` pub fn select_as_str(json: &str, path: &str) -> result::Result { let mut jf = query_from_str(json, path)?; serde_json::to_string(&jf.take_value().deref()).map_err(|e| e.description().to_string()) } /// Select a JsonObject. it return a deserialized instance of type `T` /// /// ```rust /// extern crate jsonpath_lib as jsonpath; /// extern crate serde; /// #[macro_use] extern crate serde_json; /// /// use serde::{Deserialize, Serialize}; /// /// #[derive(Deserialize, PartialEq, Debug)] /// struct Person { /// name: String, /// age: u8, /// phones: Vec, /// } /// /// let ret: Person = jsonpath::select_as(r#" /// { /// "person": /// { /// "name": "Doe John", /// "age": 44, /// "phones": [ /// "+44 1234567", /// "+44 2345678" /// ] /// } /// } /// "#, "$.person").unwrap(); /// /// let person = Person { /// name: "Doe John".to_string(), /// age: 44, /// phones: vec!["+44 1234567".to_string(), "+44 2345678".to_string()], /// }; /// /// assert_eq!(person, ret); /// ``` pub fn select_as(json: &str, path: &str) -> result::Result { let mut jf = query_from_str(json, path)?; T::deserialize(jf.take_value().deref()).map_err(|e| e.description().to_string()) }