Skip to content

Repository files navigation

Diffus

Finds the difference between two instances of any data structure.

Diffus in action

use diffus_derive::Diffus;use diffus::{edit,Diffable};#[derive(Diffus)]structPoint{x:i32,y:i32,}fnmain(){let left_point = Point{x:1,y:2};let right_point = Point{x:1,y:3};let diff = left_point.diff(&right_point);match diff {
edit::Edit::Copy(_) => println!("point: no difference"),
edit::Edit::Change(EditedPoint{ x, y }) => {match x {
edit::Edit::Copy(_) => println!("x: no difference"),
edit::Edit::Change((left_x, right_x)) => println!("x: {} => {}", left_x, right_x),}match y {
edit::Edit::Copy(_) => println!("y: no difference"),
edit::Edit::Change((left_y, right_y)) => println!("y: {} => {}", left_y, right_y),}}}}

Diffus on maps

Difference between maps is done through its keys. The identity of an element comes from its associated key, and it otherwise works in the same way as for collections with Same.

The possible edits of a map are Copy, Insert, Remove, Change

use diffus::{edit,Diffable};fnmain(){let unity: std::collections::HashMap<_,_> =
[(1,1),(2,2),(3,3)].iter().cloned().collect();let not_unity: std::collections::HashMap<_,_> =
[(1,1),(2,3),(4,4)].iter().cloned().collect();iflet edit::Edit::Change(diff) = unity.diff(&not_unity){assert!(diff[&1].is_copy());assert_eq!(diff[&2].change().unwrap(),&(&2,&3));assert!(diff[&3].is_remove());assert_eq!(diff[&4].insert().unwrap(),&4);}else{unreachable!()}}

Diffus on collections

Difference between collections is done through the Longest Common Subsequence (LCS) algorithm and with additional support for objects that have changed values but kept its Same "identity".

Strings are considered as collections.

The possible edits of a collection are Copy, Insert, Remove, Change.

use diffus_derive::Diffus;use diffus::{edit::{self, collection},Same,Diffable};#[derive(Diffus,Debug)]structIdentified{id:u32,value:u32,}implSameforIdentified{fnsame(&self,other:&Self) -> bool{self.id == other.id}}fnmain(){let left = vec![Identified{ id:1, value:0},Identified{ id:2, value:0},Identified{ id:3, value:0},Identified{ id:4, value:0},Identified{ id:5, value:0},Identified{ id:6, value:0},Identified{ id:7, value:0},];let right = vec![Identified{ id:1, value:0},Identified{ id:2, value:1},Identified{ id:4, value:0},Identified{ id:3, value:0},Identified{ id:5, value:0},Identified{ id:6, value:0},];let diff = left.diff(&right);match diff {
edit::Edit::Copy(_) => println!("no difference"),
edit::Edit::Change(diff) => {
diff.into_iter().map(|edit| {match edit {
collection::Edit::Copy(elem) => println!("copy: {:?}", elem),
collection::Edit::Insert(elem) => println!("insert: {:?}", elem),
collection::Edit::Remove(elem) => println!("remove: {:?}", elem),
collection::Edit::Change(EditedIdentified{ id, value}) => {println!("changed:");match id {
edit::Edit::Copy(_) => println!(" copy: id"),
edit::Edit::Change((left_id, right_id)) => println!(" id: {} => {}", left_id, right_id),}match value {
edit::Edit::Copy(_) => println!(" copy: value"),
edit::Edit::Change((left_value, right_value)) => println!(" value: {} => {}", left_value, right_value),}}};}).collect::<Vec<_>>();},};}

Diffus on enums

Difference between two enums works as expected, it separates variant changes from associated variant field changes.

Possible edits of an enum are Copy, VariantChanged, AssociatedChanged.

use diffus_derive::Diffus;use diffus::{edit,Diffable};#[derive(Diffus,Debug,PartialEq)]enumTest{A,B(String),Bd(String,u32),C{x:u32},Cd{x:u32,y:String},}fnmain(){let left = Test::Cd{x:42,y:"Bilbo Baggins".to_owned(),};let right = Test::Cd{x:42,y:"Frodo Baggins".to_owned(),};iflet edit::Edit::Change(edit::enm::Edit::AssociatedChanged(EditedTest::Cd{ x, y },)) = left.diff(&right){assert!(x.is_copy());assert!(y.is_change());}else{unreachable!()}let left = Test::Cd{x:42,y:"Bilbo Baggins".to_owned(),};let right = Test::B("Frodo Baggins".to_owned());iflet edit::Edit::Change(edit::enm::Edit::VariantChanged(l, r)) =
left.diff(&right){assert_eq!(&left, l);assert_eq!(&right, r);}else{unreachable!()}}

Custom difference with diffus

Differences can easily be specialized to suit your needs.

use diffus::{edit,Diffable};structSecret(String);impl<'a>Diffable<'a>forSecret{typeDiff = ();fndiff(&'aself,other:&'aSelf) -> edit::Edit<Self::Diff>{ifself.0 == other.0{
edit::Edit::Copy}else{
edit::Edit::Change(())}}}fnmain(){assert_eq!(Secret("Something".to_owned()).diff(&Secret("Else".to_owned())).change().unwrap(),&());}

About

No description, website, or topics provided.

Resources

Stars

59 stars

Watchers

18 watching

Forks

Releases

Packages

Used by

Contributors

Languages