rust-patch 0.1.3

Patch structs with other structs
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

# rust-patch
Patch structs with other structs

[![Build status](https://github.com/netthier/rust-patch/actions/workflows/rust.yml/badge.svg?branch=main)](https://github.com/netthier/rust-patch/actions/workflows/rust.yml)
[![Crates.io](https://img.shields.io/crates/v/rust-patch)](https://crates.io/crates/rust-patch)
[![Documentation](https://docs.rs/rust-patch/badge.svg)](https://docs.rs/rust-patch)

`rust-patch` allows you to avoid boilerplate code when implementing partial updates of Rust structs.  
Simply define a patch struct containing a subset of your fields, derive the `Patch` trait,
and specify the original struct using the `#[patch]` attribute.  
Fields of a patch struct may either be of the same type `T` as in the original struct or `Option<T>`.  
In the latter case, the field to be patched will be left unchanged if the corresponding field in the patch is `None`

This crate is `no_std` compatible.

## Container attributes
### `#[patch = "..."]`
Set target struct to be patched
```rust
use rust_patch::Patch;
struct Item { data: u32 }

#[derive(Patch)]
#[patch = "Item"]
struct ItemPatch { data: Option<u32> }
```
## Field attributes
By default, any fields in the patch of type `Option<T>` will be applied as such:
```rust ignore
if let Some(val) = patch.field {
    target.field = val;
} 
```
this behavior can be changed by the following field attributes.
### `#[patch(as_option)]`
The `as_option` attribute allows patching structs where a field itself is already an `Option<T>` with the following logic:
```rust ignore
if patch.field.is_some() {
    target.field = patch.field;
}
```
Applying this attribute to a field with a type without an `is_some()` method results in an error.

### `#[patch(direct)]`
The `direct` attribute makes it so that the field is treated like any other `T`, meaning it will be applied like this:
```rust ignore
target.field = patch.field;
```
Applying this attribute to a field where the type is not `Option<T>` is a no-op.

## Example
```rust
use rust_patch::Patch;
use serde::Deserialize;

#[derive(PartialEq, Debug)]
struct User {
    id: String,
    name: String,
    email: String,
}

#[derive(Deserialize, Patch)]
#[patch = "User"]
struct UserPatch {
    name: Option<String>,
    email: Option<String>,
}

let user = User {
    id: "6bf25b70-bffa-49e0-905b-2d2e608e3abd".to_string(),
    name: "Max Mustermann".to_string(),
    email: "max.mustermann@example.org".to_string(),
};

let raw_patch = r#"{
    "id": "some invalid id",
    "email": "max.mustermann@example.com"
}"#;

let patch: UserPatch = serde_json::from_str(raw_patch).unwrap();
let patched_user = patch.apply(user);

// Since `id` is not part of our `UserPatch` struct it stays unchanged
assert_eq! {
    patched_user,
    User {
        id: "6bf25b70-bffa-49e0-905b-2d2e608e3abd".to_string(),
        name: "Max Mustermann".to_string(),
        email: "max.mustermann@example.com".to_string()
    }
};
```