nest_struct 0.4.2

Nest struct and enum definitions with minimal syntax changes
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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138

[![Crates.io](https://img.shields.io/crates/v/nest_struct.svg)](https://crates.io/crates/nest_struct)
[![CI](https://github.com/ZibanPirate/nest_struct/actions/workflows/ci.yml/badge.svg)](https://github.com/ZibanPirate/nest_struct/actions/workflows/ci.yml)
![Maintenance](https://img.shields.io/badge/maintenance-activly--developed-brightgreen.svg)

# nest_struct

Nest struct and enum definitions with minimal syntax changes in Rust

### Example

```rust
use nest_struct::nest_struct;

#[nest_struct]
struct Post {
    title: String,
    summary: String,
    author: nest! {
        name: String,
        handle: String,
    },
}
```

<details>
  <summary>See expanded code</summary>

```rust
struct Post {
    title: String,
    summary: String,
    author: PostAuthor,
}

struct PostAuthor {
    name: String,
    handle: String,
}
```

</details>
<br>

You can also overwrite inner struct name, by passing the name itself as macro instead of `nest!`:

```rust
use nest_struct::nest_struct;

#[nest_struct]
struct Post {
    title: String,
    summary: String,
    author: Author! {
        name: String,
        handle: String,
    },
}
```

<details>
 <summary>See expanded code</summary>

```rust
struct Post {
    title: String,
    summary: String,
    author: Author,
}

struct Author {
    name: String,
    handle: String,
}
```

</details>
<br>

<details>
 <summary>Another example calling Pokemon API</summary>

```rust
use nest_struct::nest_struct;

// Define a struct with nested struct definitions all in one place
// with minimal syntax changes.
#[nest_struct]
#[derive(serde::Deserialize)]
struct APIResponse {
    id: u32,
    name: String,
    abilities: Vec<nest! {
            ability: nest! { name: String, url: String },
            is_hidden: bool,
            slot: u32,
        },
    >,
}

let body = reqwest::blocking::get("https://pokeapi.co/api/v2/pokemon/ditto").unwrap().text().unwrap();
let api_response: APIResponse = serde_json::from_str(&body).unwrap();

assert_eq!(api_response.name, "ditto");
// Access nested struct fields
assert_eq!(api_response.abilities.first().unwrap().ability.name, "limber");
```

</details>
<br>

For more examples, see the [`./tests/cases`](https://github.com/ZibanPirate/nest_struct/tree/main/tests/cases) directory.

### Features

-   [x] deep nesting (no theoretical limit).
-   [x] nest `struct` inside another `struct`.
-   [x] nest `enum` inside another `enum`.
-   [x] nest `enum` inside a `struct` and vice-versa.
-   [x] inherit `derive` and other attribute macros from root `struct`.
-   [x] auto-generate inner `struct` names.
-   [x] overwrite the auto-generated inner struct name.

Feature parity with native Rust code:

-   [x] `impl` block on inner `struct`s.
-   [ ] define `derive` and other attribute macros individually per inner `struct`.
-   [ ] define doc comments individually per inner `struct`.
-   [ ] useful compiler error messages.
-   [x] support generic types.
-   [x] support lifetimes.

## Contributing

Contributions are welcome, please read [`CONTRIBUTING.md`](https://github.com/ZibanPirate/nest_struct/blob/main/CONTRIBUTING.md) to get started.

## License

Licensed under MIT (twitter: [@zibanpirate](https://twitter.com/zibanpirate)).