#struct #patch #macro #derive #overlay

struct-patch

A library that helps you implement partial updates for your structs

7 releases

0.2.3 Mar 4, 2023
0.2.2 Mar 2, 2023
0.2.1 Feb 23, 2023
0.2.0 Jan 21, 2023
0.1.5 Jan 21, 2023

#300 in Encoding

Download history 144/week @ 2023-01-13 158/week @ 2023-01-20 28/week @ 2023-01-27 40/week @ 2023-02-03 241/week @ 2023-02-10 387/week @ 2023-02-17 777/week @ 2023-02-24 615/week @ 2023-03-03 498/week @ 2023-03-10 461/week @ 2023-03-17 320/week @ 2023-03-24

2,125 downloads per month

MIT license

10KB
107 lines

Struct Patch

Crates.io MIT licensed Docs

A lib help you patch Rust instance, and easy to partial update configures.

Introduction

This crate provides the Patch trait and an accompanying derive macro.

Deriving Patch on a struct will generate a struct similar to the original one, but with all fields wrapped in an Option.
An instance of such a patch struct can be applied onto the original struct, replacing values only if they are set to Some, leaving them unchanged otherwise.

Quick Example

use struct_patch::Patch;
use serde::{Deserialize, Serialize};

#[derive(Default, Debug, PartialEq, Patch)]
#[patch_derive(Debug, Default, Deserialize, Serialize)]
struct Item {
    field_bool: bool,
    field_int: usize,
    field_string: String,
}

fn patch_json() {
    let mut item = Item {
        field_bool: true,
        field_int: 42,
        field_string: String::from("hello"),
    };

    let data = r#"{
        "field_int": 7
    }"#;

    let patch: ItemPatch = serde_json::from_str(data).unwrap();

    item.apply(patch);

    assert_eq!(
        item,
        Item {
            field_bool: true,
            field_int: 7,
            field_string: String::from("hello")
        }
    );
}

Dependencies

~0.8–1.2MB
~28K SLoC