serde-this-or-that

github crates.io docs.rs build status

Custom deserialization for fields that can be specified as multiple types.


This crate works with Cargo with a Cargo.toml like:

toml [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:

```rust use serde::Deserialize; use serdejson::fromstr; use serdethisorthat::{asbool, asf64, asu64};

[derive(Deserialize, Debug)]

[serde(rename_all = "camelCase")]

struct MyStruct { #[serde(deserializewith = "asbool")] isactive: bool, #[serde(deserializewith = "asu64")] numattempts: u64, #[serde(deserializewith = "asf64")] grade: f64, }

fn main() -> Result<(), Box> { 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.

Authors