serde_diff_derive/
lib.rs

1extern crate proc_macro;
2
3mod serde_diff;
4
5/// # Examples
6///
7/// Minimal example of implementing diff support for a struct
8/// ```rust
9/// use serde_diff::SerdeDiff;
10/// use serde::{Serialize, Deserialize};
11/// #[derive(SerdeDiff)]
12/// struct MySimpleStruct {
13///    val: u32,
14/// }
15/// ```
16///
17/// Example of an opaque (non-recursive diff) implementation of SerdeDiff using `#[serde_diff(opaque)]` on the struct.
18/// Field types are not required to implement SerdeDiff in this case, only Serialize + Deserialize + PartialEq.
19/// ```rust
20/// use serde_diff::SerdeDiff;
21/// use serde::{Serialize, Deserialize};
22/// #[derive(SerdeDiff, Serialize, Deserialize, PartialEq)]
23/// #[serde_diff(opaque)]
24/// struct OpaqueTest(i32);
25/// ```
26///
27/// Example of a struct with an opaque field using `#[serde_diff(opaque)]` on a field.
28/// ```rust
29/// use serde_diff::SerdeDiff;
30/// use serde::{Serialize, Deserialize};
31/// #[derive(SerdeDiff)]
32/// struct MyInnerStruct {
33///     #[serde_diff(opaque)]
34///     heap: std::collections::HashSet<i32>,
35/// }
36/// ```
37///
38/// Example of diffing a target struct `MySimpleStruct` that is being used for serialization instead
39/// of the struct `MyComplexStruct` itself. Useful for cases where derived data is present at
40/// runtime, but not wanted in the serialized form.
41/// ```rust
42/// use serde_diff::SerdeDiff;
43/// use serde::{Serialize, Deserialize};
44/// #[derive(SerdeDiff, Serialize, Deserialize, Clone)]
45/// #[serde(from = "MySimpleStruct", into = "MySimpleStruct")]
46/// #[serde_diff(target = "MySimpleStruct")]
47/// struct MyComplexStruct {
48///    val: u32,
49///    derived_val: String,
50/// }
51///
52/// #[derive(SerdeDiff, Serialize, Deserialize, Default)]
53/// #[serde(rename = "MyComplexStruct", default)]
54/// struct MySimpleStruct {
55///    val: u32,
56/// }
57///
58/// impl From<MySimpleStruct> for MyComplexStruct {
59///    fn from(my_simple_struct: MySimpleStruct) -> Self {
60///        MyComplexStruct {
61///            val: my_simple_struct.val,
62///            derived_val: my_simple_struct.val.to_string(),
63///        }
64///    }
65/// }
66///
67/// impl Into<MySimpleStruct> for MyComplexStruct {
68///     fn into(self) -> MySimpleStruct {
69///         MySimpleStruct {
70///             val: self.val,
71///         }
72///     }
73/// }
74/// ```
75#[proc_macro_derive(SerdeDiff, attributes(serde_diff))]
76pub fn serde_diff_macro_derive(input: proc_macro::TokenStream) -> proc_macro::TokenStream {
77    serde_diff::macro_derive(input)
78}
serde_diff_derive/lib.rs

serde_diff_derive/
lib.rs
