core-json-derive 0.4.1

`derive` macros for `core-json-traits`
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

# `core-json` Derive

A macro to automatically derive `JsonDeserialize` and `JsonStructure` from
[`core-json-traits`](https://docs.rs/core-json-traits).

### Usage

This crate can be used quite directly as follows.

```rs
#[derive(core_json_derive::JsonDeserialize, core_json_derive::JsonSerialize)]
struct MyStruct {
  abc_def: Vec<u8>,
}
```

Then, deserialization may occur as follows.

```rs
use core_json_traits::*;
MyStruct::deserialize_structure::<_, ConstStack<32>>(serialization).unwrap()
```

where `serialization: &[u8]`. The constant parameter for `ConstStack`
determines how deep objects within the serialization are allowed to be. To
support objects of unbounded depth, `Vec` may be used, but this is not
recommended due to denial of service concerns.

Serialization to a `String` may occur as follows.

```rs
use core_json_traits::*;
my_struct.serialize().collect::<String>()
```

### `key` Attribute

We support (de)serializing fields with a key distinct from their names via the
`key` attribute.

```rs
#[derive(core_json_derive::JsonDeserialize, core_json_derive::JsonSerialize)]
struct MyStruct {
  #[key("abcDef")]
  abc_def: Vec<u8>,
}
```

### `skip` Attribute

We support omitting fields from (de)serialization with the `skip` attribute.

```rs
#[derive(core_json_derive::JsonDeserialize, core_json_derive::JsonSerialize)]
struct MyStruct {
  #[skip]
  abc_def: Vec<u8>,
}
```

The attribute will not be serialized and will not be read when deserializing,
even if present within the serialization.

### Changelog

A changelog may be found
[here](https://github.com/core-json/core-json/tree/master/derive/CHANGELOG.md).