A lightweight, zero-dependency struct diffing library which allows changed fields to be collected and applied

Last update: Dec 25, 2022

Related tags

Overview

structdiff

A lightweight, zero-dependency struct diffing library which allows changed fields to be collected and applied. Derive Difference on a struct, then use the StructDiff trait to make and apply diffs.

Example:

use structdiff::{Difference, StructDiff};

#[derive(Debug, PartialEq, Clone, Difference)]
struct Example {
    field1: f64,
    #[difference(skip)]
    field2: Vec<i32>,
    field3: String,
}

let first = Example {
    field1: 0.0,
    field2: Vec::new(),
    field3: String::from("Hello Diff"),
};

let second = Example {
    field1: 3.14,
    field2: vec![1],
    field3: String::from("Hello Diff"),
};

let diffs = first.diff(&second);
// diffs is now a Vec of differences, with length 
// equal to number of changed/unskipped fields
assert_eq!(diffs.len(), 1);

let diffed = first.apply(diffs);
// diffed is now equal to second, except for skipped field
assert_eq!(diffed.field1, second.field1);
assert_eq!(diffed.field3, second.field3);
assert_ne!(diffed, second);

For more examples take a look at integration tests

Derive macro attributes

#[difference(skip)] - Do not consider this field when creating a diff
#[difference(recurse)] - Generate a StructDiff for this field when creating a diff
#[difference(collection_strategy = "{}")
- unordered_hash - Generates a changeset for collections of items which implement Hash + Eq, rather than cloning the entire list. (currently works for Vec, BTreeSet, LinkedList, and HashSet)

Optional features

[nanoserde, serde] - Serialization of Difference derived associated types

Development status

This is being actively worked on (especially on collections strategies). PRs will be accepted for either more tests or functionality.

Parse command line arguments by defining a struct.

StructOpt Parse command line arguments by defining a struct. It combines clap with custom derive. Documentation Find it on Docs.rs. You can also check

2.6k Jan 5, 2023

Convert a unix timestamp (seconds) to a struct {year, month, day, hour, minute, second, weekday}.

uts2ts uts2ts is a simple function that does only one thing: It converts a unix timestamp to something slightly more useful. ;-) So why then? Well, it

6 Jul 26, 2023

Statically verified Rust struct field names as strings.

field Statically verified struct field names as strings. See the documentation for more details. Installation Add the following to your Cargo manifest

3 Jul 9, 2023

A high-performance WebSocket integration library for streaming public market data. Used as a key dependency of the `barter-rs` project.

Barter-Data A high-performance WebSocket integration library for streaming public market data from leading cryptocurrency exchanges - batteries includ

23 Feb 3, 2023

Comments

Collections Support
Need to add different strategies for handling collections. Hashmaps/sets are straightforward, but need to decide on better ways than == for comparing Vecs/Arrays/LinkedLists/Maps (and allow recursion, probably).

[x] unordered/hashable strategy - Turn any two array-like collections into a hashset and compare

[x] hashmap/btreemap impl

[ ] ordered with minimal moves
opened by knickish 0

A lightweight, zero-dependency struct diffing library which allows changed fields to be collected and applied

Related tags

Overview

structdiff

Example:

Derive macro attributes

Optional features

Development status

You might also like...

Parse command line arguments by defining a struct.

Convert a unix timestamp (seconds) to a struct {year, month, day, hour, minute, second, weekday}.

Statically verified Rust struct field names as strings.

A high-performance WebSocket integration library for streaming public market data. Used as a key dependency of the `barter-rs` project.

Dynamic dependency injection library for rust.

Track and query Cargo dependency graphs.

Generate a dependency list to thank them on README.

python dependency vulnerability scanner, written in Rust.

Rudi - an out-of-the-box dependency injection framework for Rust.

Comments

Collections Support

Owner

Rust TUI library - Clipping region is a set of min/max x/y values applied to the existing region

List public items (public API) of library crates. Enables diffing public API between releases.

zero-dependency 3d math library in rust

Run if inputs have changed, otherwise use cache

A crate providing a MemoryCell struct, which stores a current and previous value.

Bit fields and masks for rust!

Command-line tool that provides a workflow for extending, editing, diffing, and writing to vim-style grep lines.

A zero-dependency crate for writing repetitive code easier and faster.

A truly zero-dependency crate providing quick, easy, reliable, and scalable access to the name "jordin"

A super simple /sbin/init for Linux which allows running one and only one program