wopt 0.4.4

A procedural macro that automatically generates an Option-wrapped version of a struct, reducing boilerplate for optional updates.
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

# wopt (with-options)


## Description

A procedural macro that automatically generates an Option-wrapped version of a struct, reducing boilerplate for optional updates.

## Example

```rust
use wopt::*;

#[derive(Clone, Copy, Debug, Default, PartialEq, WithOpt)]

#[wopt(derive(Debug, Default, PartialEq))]

struct Example {
    a: u8,
    b: f32,
    c: i16,
}

fn main() {
    // original struct
    let mut ex = Example {
        a: 1,
        b: 2.0,
        c: -3,
    };

    // the original's optional struct
    let mut ex_opt = ExampleOpt {
        a: None,
        b: Some(420.0), // this will patch `ex.b`
        c: None,
    };
    // currently has a modification (b)
    assert!(ex_opt.is_modified());

    // "patch" the original with the optional struct.
    ex.patch(&mut ex_opt);

    // patching mutably "takes" the optional struct, meaning,
    // after patching it no longer has any modifications.
    assert!(!ex_opt.is_modified());

    assert_eq!(
        ex,
        Example {
            a: 1,
            b: 420.0, // the only field to change
            c: -3
        }
    )
}
```

## Struct Attributes

| Name | Description |
| ---- | ----------- |
| `derive(...)` | Specified derivations for the optional struct. |
| `no_serde` | When provided, does not generate ser/de methods for original struct. |

## Field Attributes

For more information on how to use these attributes, refer to the structures in `tests\common\mod.rs`.
| Name | Description |
| ---- | ----------- |
| `optional` | Force the optional version of the current struct to use the optional version of the current field. |
| `ser`/`de` | Specify methods of serialization/deserialization (if specified, both are required). |
| `serde`    | Force the generated `serialize`/`deserialize` methods of the field (must derive `WithOpt`) to be used (usually paired with `optional`). |
| `required` | Does not wrap the specified field with an `Option`. |
| `skip`     | Does not include the current field. |


## Optional Feature(s)

| Name | Description |
| ---- | ----------- |
| [`bytemuck`](https://crates.io/crates/bitflags) | Serialize/Deserialize using `bytemuck`. |
| `unchecked` | Disable unwrap checks.


## Additional Notes

The automatically generated optional-struct does not come with any trait/derivation implementations. The fields are publicized, however, it may be helpful to specify the `Default` trait:
```rust
#[derive(WithOpt)]

#[wopt(derive(Default))] // attempts to implement `Default`

struct ExampleWithDefault(u8);
```