iq 0.5.1

introspection with dynamic queries
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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86

use {
    crate::*,
    serde::{
        Serialize,
        de::DeserializeOwned,
    },
};

/// A trait to import if you want extract function on any `Serialize` type.
pub trait IQ {
    /// Extract a "primitive" value (including strings, simple enum variants, etc)
    /// as a string using the Display implementation of the deep value.
    fn extract_primitive<P: IqPath>(
        &self,
        path: P,
    ) -> Option<String>;

    /// Extract a value as JSON
    fn extract_json<P: IqPath>(
        &self,
        path: P,
    ) -> Option<String>;

    /// Extract a value as JSON, pretty
    fn extract_json_pretty<P: IqPath>(
        &self,
        path: P,
    ) -> Option<String>;

    /// Extract a value in a type which must implement `Deserialize`, from a value, at
    /// the given path.
    ///
    /// This function uses a JSON representation of the deep value as intermediate
    /// step, which adds some (usually light) overload but also allows to extract
    /// in a different type than the real type of the deep value.
    fn extract_value<P: IqPath, V: DeserializeOwned>(
        &self,
        path: P,
    ) -> Result<Option<V>, IqError>;

    /// Extract the size of the string/tuple/map/vec/struct at the given path
    fn extract_size<P: IqPath>(
        &self,
        path: P,
    ) -> Option<usize>;
}

impl<T> IQ for T
where
    T: Serialize,
{
    fn extract_primitive<P: IqPath>(
        &self,
        path: P,
    ) -> Option<String> {
        extract_primitive(self, path)
    }

    fn extract_json<P: IqPath>(
        &self,
        path: P,
    ) -> Option<String> {
        extract_json(self, path)
    }

    fn extract_json_pretty<P: IqPath>(
        &self,
        path: P,
    ) -> Option<String> {
        extract_json(self, path)
    }

    fn extract_value<P: IqPath, V: DeserializeOwned>(
        &self,
        path: P,
    ) -> Result<Option<V>, IqError> {
        extract_value(self, path)
    }

    fn extract_size<P: IqPath>(
        &self,
        path: P,
    ) -> Option<usize> {
        extract_size(self, path)
    }
}