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

#![doc(html_root_url = "https://docs.rs/serde-this-or-that/0.4.2")]
#![warn(rust_2018_idioms, missing_docs)]
#![deny(warnings, dead_code, unused_imports, unused_mut)]

//! [![github]](https://github.com/rnag/serde-this-or-that) [![crates-io]](https://crates.io/crates/serde-this-or-that) [![docs-rs]](https://docs.rs/serde-this-or-that)
//!
//! [github]: https://img.shields.io/badge/github-8da0cb?style=for-the-badge&labelColor=555555&logo=github
//! [crates-io]: https://img.shields.io/badge/crates.io-fc8d62?style=for-the-badge&labelColor=555555&logo=rust
//! [docs-rs]: https://img.shields.io/badge/docs.rs-66c2a5?style=for-the-badge&labelColor=555555&logoColor=white&logo=data:image/svg+xml;base64,PHN2ZyByb2xlPSJpbWciIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgdmlld0JveD0iMCAwIDUxMiA1MTIiPjxwYXRoIGZpbGw9IiNmNWY1ZjUiIGQ9Ik00ODguNiAyNTAuMkwzOTIgMjE0VjEwNS41YzAtMTUtOS4zLTI4LjQtMjMuNC0zMy43bC0xMDAtMzcuNWMtOC4xLTMuMS0xNy4xLTMuMS0yNS4zIDBsLTEwMCAzNy41Yy0xNC4xIDUuMy0yMy40IDE4LjctMjMuNCAzMy43VjIxNGwtOTYuNiAzNi4yQzkuMyAyNTUuNSAwIDI2OC45IDAgMjgzLjlWMzk0YzAgMTMuNiA3LjcgMjYuMSAxOS45IDMyLjJsMTAwIDUwYzEwLjEgNS4xIDIyLjEgNS4xIDMyLjIgMGwxMDMuOS01MiAxMDMuOSA1MmMxMC4xIDUuMSAyMi4xIDUuMSAzMi4yIDBsMTAwLTUwYzEyLjItNi4xIDE5LjktMTguNiAxOS45LTMyLjJWMjgzLjljMC0xNS05LjMtMjguNC0yMy40LTMzLjd6TTM1OCAyMTQuOGwtODUgMzEuOXYtNjguMmw4NS0zN3Y3My4zek0xNTQgMTA0LjFsMTAyLTM4LjIgMTAyIDM4LjJ2LjZsLTEwMiA0MS40LTEwMi00MS40di0uNnptODQgMjkxLjFsLTg1IDQyLjV2LTc5LjFsODUtMzguOHY3NS40em0wLTExMmwtMTAyIDQxLjQtMTAyLTQxLjR2LS42bDEwMi0zOC4yIDEwMiAzOC4ydi42em0yNDAgMTEybC04NSA0Mi41di03OS4xbDg1LTM4Ljh2NzUuNHptMC0xMTJsLTEwMiA0MS40LTEwMi00MS40di0uNmwxMDItMzguMiAxMDIgMzguMnYuNnoiPjwvcGF0aD48L3N2Zz4K
//!
//! <br>
//!
//! Custom deserialization for fields that can be specified as multiple types.
//!
//! <br>
//!
//! ## Usage
//!
//! ```rust
//! 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(())
//! }
//! ```
//!
//! ## Examples
//!
//! You can check out sample usage of this crate in the [examples/](https://github.com/rnag/serde-this-or-that/tree/main/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/](https://github.com/rnag/serde-this-or-that/tree/main/benches)
//! folder, and can be run with `cargo bench`.
//!
//! [`Visitor`]: https://docs.serde.rs/serde/de/trait.Visitor.html
//! [untagged enum]: https://stackoverflow.com/a/66961340/10237506
//! [serde_with]: https://docs.rs/serde_with
//! [`DisplayFromStr`]: https://docs.rs/serde_with/latest/serde_with/struct.DisplayFromStr.html
//! [`PickFirst`]: https://docs.rs/serde_with/latest/serde_with/struct.PickFirst.html
//!
//!
//! ## Readme Docs
//!
//! You can find the crate's readme documentation on the
//! [crates.io] page, or alternatively in the [`README.md`] file on the GitHub project repo.
//!
//! [crates.io]: https://crates.io/crates/serde-this-or-that
//! [`README.md`]: https://github.com/rnag/serde-this-or-that
//!

mod de_impl;

pub use de_impl::{as_bool, as_f64, as_i64, as_string, as_u64};
#[doc(hidden)]
pub use serde;
#[doc(hidden)]
pub use serde::*;

#[cfg(test)]
mod tests {
    use super::*;

    use serde::Deserialize;
    use serde_json::from_str;

    #[test]
    fn serde_this_or_that_works() {
        #[derive(Deserialize)]
        #[serde(rename_all = "camelCase")]
        struct MyStruct {
            #[serde(deserialize_with = "as_bool")]
            is_active: bool,
            #[serde(deserialize_with = "as_u64")]
            num_attempts: u64,
        }

        let string = r#"
        {
            "isActive": "True",
            "numAttempts": "3"
        }
        "#;

        let s: MyStruct = from_str(string).unwrap();

        assert!(s.is_active);
        assert_eq!(s.num_attempts, 3)
    }
}