serde-this-or-that
Custom deserialization for fields that can be specified as multiple types.
This crate works with Cargo with a Cargo.toml like:
[dependencies]
serde-this-or-that = "0.4"
serde = { version = "1", features = ["derive"] }
serde_json = "1"
Getting started
Add some usage to your application.
Here's an example of using serde-this-or-that in code:
use serde::Deserialize;
use serde_json::from_str;
use serde_this_or_that::{as_bool, as_f64, as_u64};
#[derive(Deserialize, Debug)]
#[serde(rename_all = "camelCase")]
struct MyStruct {
#[serde(deserialize_with = "as_bool")]
is_active: bool,
#[serde(deserialize_with = "as_u64")]
num_attempts: u64,
#[serde(deserialize_with = "as_f64")]
grade: f64,
}
fn main() -> Result<(), Box<dyn std::error::Error>> {
let string = r#"
{
"isActive": "True",
"numAttempts": "",
"grade": "81"
}
"#;
let s: MyStruct = from_str(string)?;
println!("{s:#?}");
assert!(s.is_active);
assert_eq!(s.num_attempts, 0);
assert_eq!(s.grade, 81.0);
Ok(())
}
Exported Functions
Examples
You can check out sample usage of this crate in the examples/ folder in the project repo on GitHub.
Performance
The benchmarks suggest that implementing a custom Visitor as serde-this-or-that does, performs on average about 15x better than an approach with an untagged enum.
A separate benchmark compares performance against the serde_with crate: it indicates both crates perform about the same, assuming only DisplayFromStr is used. But when PickFirst is involved, serde-this-or-that appears to perform about 12x better in an average case.
The benchmarks live in the benches/ folder, and can be run with cargo bench.
Contributing
Contributions are welcome! Open a pull request to fix a bug, or open an issue to discuss a new feature or change.
Check out the Contributing section in the docs for more info.
License
This project is proudly licensed under the MIT license (LICENSE or http://opensource.org/licenses/MIT).
serde-this-or-that can be distributed according to the MIT license. Contributions will be accepted under the same license.
2 Dec 27, 2021
1 Feb 4, 2022
73 Aug 4, 2022
55 Jan 22, 2023
3 Jan 31, 2023
5 Jun 4, 2023
3 Mar 30, 2024
136 Dec 21, 2022
43 Dec 17, 2022
97 Jun 26, 2023
483 Jan 7, 2023
6 Dec 14, 2022
5 Jul 30, 2023
3 Nov 12, 2024
1 Sep 19, 2022
7 Jan 2, 2023
4 Jan 4, 2023
3 Dec 12, 2023
1 Oct 26, 2021