wopt 0.2.6

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

# 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(WithOpt)]

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

struct Example {
    a: u8,
    #[wopt(required)]
    b: f32,
    c: String,
}

fn main() {
    let b = 420.0;
    let mut ex_opt = ExampleOpt::default();
    ex_opt.b = b;

    assert_eq!(
        ex_opt,
        ExampleOpt {
            a: None,
            b,
            c: None
        },
    )
}
```

## Field Attributes

| Name | Description |
| ---- | ----------- |
| `required` | Does not wrap the specified field with an `Option`. |
| `skip` | Does not include the specified field. |


## Optional Features

| Name | Description |
| ---- | ----------- |
| [rkyv](https://crates.io/crates/bitflags) | Serialize/Deserialize using `rkyv`. |
| [serde](https://crates.io/crates/serde)   | Seriailze/Deserialize using `serde`. |


## 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);
```