diff-struct 0.2.1

A trait for diffing and apply diffs to structs of a certain type
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

mod impls;
#[cfg(test)]
mod tests;
pub mod utils;

pub use diff_derive::Diff;
pub use impls::*;

/// A trait to diff and apply diffs between two structs
/// The derive macro can be used on structs when all fields of the struct implement Diff
/// Implementations are provided for bools, numeric types, Option types, and HashMaps
pub trait Diff: Sized {
    /// The type associated with the structs' difference
    type Repr;

    /// Produces a diff between two structs
    fn diff(&self, other: &Self) -> Self::Repr;
    /// Applies the diff directly to the struct
    fn apply(&mut self, diff: &Self::Repr);
    /// The identity element of the struct
    /// ```
    /// use diff::Diff;
    /// let s = 42;
    /// let i = <i32 as Diff>::identity();
    /// assert_eq!(i.apply_new(&i.diff(&s)), s);
    /// ```
    /// or mathematically speaking, `i + (s - i) = s`
    fn identity() -> Self;
    /// Applies the diff to the struct and produces a new struct
    fn apply_new(&self, diff: &Self::Repr) -> Self {
        let mut new = Self::identity();
        new.apply(&new.diff(self));
        new.apply(diff);
        new
    }
}