dts 0.6.14

A tool to deserialize, transform and serialize data between different encodings
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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

//! Provides functionality to filter a `serde_json::Value` based on a filter expression.

use crate::Result;
use serde_json::Value;

#[cfg(feature = "jaq")]
mod jaq;
#[cfg(not(feature = "jaq"))]
mod jq;

#[cfg(feature = "jaq")]
use jaq::Filter as FilterImpl;
#[cfg(not(feature = "jaq"))]
use jq::Filter as FilterImpl;

/// A jq-like filter for transforming a `Value` into a different `Value` based on the contents of
/// a filter expression.
///
/// This can be used to transform a `Value` using a `jq` expression.
///
/// ## Example
///
/// ```
/// use dts::filter::Filter;
/// use serde_json::json;
/// # use std::error::Error;
/// #
/// # fn main() -> Result<(), Box<dyn Error>> {
/// let value = json!([5, 4, 10]);
///
/// let filter = Filter::new("map(select(. > 5))")?;
/// let result = filter.apply(value)?;
///
/// assert_eq!(result, json!([10]));
/// #   Ok(())
/// # }
/// ```
pub struct Filter {
    inner: FilterImpl,
}

impl Filter {
    /// Constructs the filter from the `&str` expression.
    ///
    /// Depending on the underlying implementation this may return an error if parsing the
    /// expression fails.
    pub fn new(expr: &str) -> Result<Filter> {
        let inner = FilterImpl::new(expr)?;
        Ok(Filter { inner })
    }

    /// Applies the filter to a `Value` and returns the result.
    pub fn apply(&self, value: Value) -> Result<Value> {
        self.inner.apply(value)
    }
}