diffo 0.2.0

Semantic diffing for Rust structs via serde
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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173

use serde_value::Value;

/// Represents a change at a specific path in the diff.
///
/// # Examples
///
/// ```
/// use diffo::Change;
/// use serde_value::Value;
///
/// let added = Change::Added(Value::I64(42));
/// let removed = Change::Removed(Value::String("old".into()));
/// let modified = Change::Modified {
///     from: Value::I64(1),
///     to: Value::I64(2),
/// };
/// ```
#[derive(Debug, Clone, PartialEq)]
pub enum Change {
    /// Value was added (present in new, absent in old).
    Added(Value),

    /// Value was removed (present in old, absent in new).
    Removed(Value),

    /// Value was modified.
    Modified {
        /// The old value.
        from: Value,
        /// The new value.
        to: Value,
    },

    /// Collection was truncated in output due to size limits.
    Elided {
        /// Reason for elision.
        reason: String,
        /// Number of items that were elided.
        count: usize,
    },
}

impl Change {
    /// Returns true if this is an `Added` variant.
    ///
    /// # Examples
    ///
    /// ```
    /// use diffo::Change;
    /// use serde_value::Value;
    ///
    /// let change = Change::Added(Value::I64(42));
    /// assert!(change.is_added());
    /// ```
    pub fn is_added(&self) -> bool {
        matches!(self, Change::Added(_))
    }

    /// Returns true if this is a `Removed` variant.
    ///
    /// # Examples
    ///
    /// ```
    /// use diffo::Change;
    /// use serde_value::Value;
    ///
    /// let change = Change::Removed(Value::I64(42));
    /// assert!(change.is_removed());
    /// ```
    pub fn is_removed(&self) -> bool {
        matches!(self, Change::Removed(_))
    }

    /// Returns true if this is a `Modified` variant.
    ///
    /// # Examples
    ///
    /// ```
    /// use diffo::Change;
    /// use serde_value::Value;
    ///
    /// let change = Change::Modified {
    ///     from: Value::I64(1),
    ///     to: Value::I64(2),
    /// };
    /// assert!(change.is_modified());
    /// ```
    pub fn is_modified(&self) -> bool {
        matches!(self, Change::Modified { .. })
    }

    /// Returns true if this is an `Elided` variant.
    ///
    /// # Examples
    ///
    /// ```
    /// use diffo::Change;
    ///
    /// let change = Change::Elided {
    ///     reason: "too large".into(),
    ///     count: 1000,
    /// };
    /// assert!(change.is_elided());
    /// ```
    pub fn is_elided(&self) -> bool {
        matches!(self, Change::Elided { .. })
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_is_added() {
        let change = Change::Added(Value::I64(42));
        assert!(change.is_added());
        assert!(!change.is_removed());
        assert!(!change.is_modified());
        assert!(!change.is_elided());
    }

    #[test]
    fn test_is_removed() {
        let change = Change::Removed(Value::String("test".into()));
        assert!(!change.is_added());
        assert!(change.is_removed());
        assert!(!change.is_modified());
        assert!(!change.is_elided());
    }

    #[test]
    fn test_is_modified() {
        let change = Change::Modified {
            from: Value::I64(1),
            to: Value::I64(2),
        };
        assert!(!change.is_added());
        assert!(!change.is_removed());
        assert!(change.is_modified());
        assert!(!change.is_elided());
    }

    #[test]
    fn test_is_elided() {
        let change = Change::Elided {
            reason: "test".into(),
            count: 100,
        };
        assert!(!change.is_added());
        assert!(!change.is_removed());
        assert!(!change.is_modified());
        assert!(change.is_elided());
    }

    #[test]
    fn test_clone() {
        let change = Change::Modified {
            from: Value::I64(1),
            to: Value::I64(2),
        };
        let cloned = change.clone();
        assert_eq!(change, cloned);
    }

    #[test]
    fn test_debug() {
        let change = Change::Added(Value::I64(42));
        let debug_str = format!("{:?}", change);
        assert!(debug_str.contains("Added"));
        assert!(debug_str.contains("42"));
    }
}