mirror of
https://github.com/bytedream/serde-inline-default.git
synced 2025-05-12 05:35:11 +02:00
Compare commits
No commits in common. "main" and "v0.2.3" have entirely different histories.
49
README.md
49
README.md
@ -1,4 +1,4 @@
|
|||||||
# serde-inline-default [](https://github.com/ByteDream/serde-inline-default/actions/workflows/ci.yml) [](https://crates.io/crates/serde-inline-default) [](https://crates.io/crates/serde-inline-default) [](https://docs.rs/serde-inline-default/latest/serde_inline_default/)
|
# serde-inline-default [](https://github.com/ByteDream/serde-inline-default/actions/workflows/ci.yml) [](https://crates.io/crates/serde-inline-default) [](https://docs.rs/serde-inline-default/latest/serde_inline_default/)
|
||||||
|
|
||||||
Tiny crate to set default values for serde fields via inline attribute declaration.
|
Tiny crate to set default values for serde fields via inline attribute declaration.
|
||||||
|
|
||||||
@ -19,7 +19,7 @@ fn value_default() -> u32 { 42 }
|
|||||||
|
|
||||||
That can get quiet messy if you have many fields with many (different) default values.
|
That can get quiet messy if you have many fields with many (different) default values.
|
||||||
This crate tries to solve this issue by providing the `#[serde_inline_default]` proc macro.
|
This crate tries to solve this issue by providing the `#[serde_inline_default]` proc macro.
|
||||||
With this macro set at the struct level, you can set default values via `#[serde_inline_default(...)]` for your serde fields inline, without creating an extra function.
|
With this macro set at the struct level (_**before `#[derive(Deserialize)]`/`#[derive(Serialize)]`!, otherwise it's not working correctly**_), you can set default values via `#[serde_inline_default(...)]` for your serde fields inline, without creating an extra function.
|
||||||
|
|
||||||
```rust
|
```rust
|
||||||
#[serde_inline_default]
|
#[serde_inline_default]
|
||||||
@ -30,54 +30,9 @@ struct Test {
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
> [!IMPORTANT]
|
|
||||||
> **`#[serde_inline_default]` must be set before `#[derive(Deserialize)]`/`#[derive(Serialize)]`, otherwise it's not working correctly!**
|
|
||||||
|
|
||||||
Internally, `#[serde_inline_default(...)]` gets expanded to a function which returns the set value and the attribute is replaced with `#[serde(default = "<function name>")]`.
|
Internally, `#[serde_inline_default(...)]` gets expanded to a function which returns the set value and the attribute is replaced with `#[serde(default = "<function name>")]`.
|
||||||
So this macro is just some syntax sugar for you, but can get quiet handy if you want to keep your code clean or write declarative macros / `macro_rules!`.
|
So this macro is just some syntax sugar for you, but can get quiet handy if you want to keep your code clean or write declarative macros / `macro_rules!`.
|
||||||
|
|
||||||
## Alternatives
|
|
||||||
|
|
||||||
This crate isn't perfect. Thus, you might be more satisfied with alternatives `serde` provides.
|
|
||||||
|
|
||||||
With `#[serde(default)]` + `impl Default` on a struct, `serde` uses the default implementation of the struct to get default values for each field ([docs](https://serde.rs/container-attrs.html#default)):
|
|
||||||
```rust
|
|
||||||
#[derive(Deserialize)]
|
|
||||||
#[serde(default)]
|
|
||||||
struct Test {
|
|
||||||
value: u32
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Default for Test {
|
|
||||||
fn default() -> Self {
|
|
||||||
Self {
|
|
||||||
value: 42
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
If you still need/want `serde-inline-default` features, you also can combine them with `#[serde(default))` and `impl Default`:
|
|
||||||
```rust
|
|
||||||
#[serde_inline_default]
|
|
||||||
#[derive(Deserialize)]
|
|
||||||
#[serde(default)]
|
|
||||||
struct Test {
|
|
||||||
value: u32,
|
|
||||||
#[serde_inline_default(0)]
|
|
||||||
other_value: u32,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Default for Test {
|
|
||||||
fn default() -> Self {
|
|
||||||
Self {
|
|
||||||
value: 42,
|
|
||||||
other_value: 42
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
This project is licensed under either of the following licenses, at your option:
|
This project is licensed under either of the following licenses, at your option:
|
||||||
|
Loading…
x
Reference in New Issue
Block a user