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
//! This crate provides the procedural macro `json_typegen!` which creates Rust
//! types from JSON samples. As an example, the below code generates code for
//! the type Point, including derives for serialization and deserialization
//! (using [serde_derive](https://crates.io/crates/serde_derive)).
//!
//! ```rust
//! #[macro_use]
//! extern crate json_typegen;
//! extern crate serde_json;
//!
//! json_typegen!("Point", r#"{ "x": 1, "y": 2 }"#);
//!
//! fn main() {
//!     let mut p: Point = serde_json::from_str(r#"{ "x": 3, "y": 5 }"#).unwrap();
//!     println!("deserialized = {:?}", p);
//!     p.x = 4;
//!     let serialized = serde_json::to_string(&p).unwrap();
//!     println!("serialized = {}", serialized);
//! }
//! ```
//!
//! ```toml
//! [dependencies]
//! serde = "0.9"
//! serde_json = "0.9"
//! json_typegen = "0.1"
//! ```
//!
//! The sample json can also come from local or remote files, like so:
//!
//! ```rust,ignore
//! json_typegen!("Point", "json_samples/point.json");
//!
//! json_typegen!("Point", "http://example.com/someapi/point.json");
//! ```
//!
//! ### Conditional compilation
//!
//! To avoid incurring the cost of a http request per sample used for every
//! build you can use conditional compilation to only check against remote
//! samples when desired:
//!
//! ```rust,ignore
//! #[cfg(not(feature = "online-samples"))]
//! json_typegen!("Point", r#"{ "x": 1, "y": 2 }"#);
//! #[cfg(feature = "online-samples")]
//! json_typegen!("Point", "http://vestera.as/json_typegen/examples/point.json");
//! ```
//!
//! And in Cargo.toml:
//! ```toml
//! [features]
//! online-samples = []
//! ```
//!
//! You can then verify that remote samples match your expectations in e.g. CI
//! builds as follows:
//!
//! ```sh
//! cargo check --features "online-samples"
//! ```

#[allow(unused_imports)]
#[macro_use]
extern crate json_typegen_derive;
#[allow(unused_imports)]
#[macro_use]
extern crate serde_derive;

pub use json_typegen_derive::*;
pub use serde_derive::*;

/// The main point of this crate
#[macro_export]
macro_rules! json_typegen {
    ($name:expr, $source:expr) => {
        #[derive(json_types)]
        #[json_typegen(name = $name)]
        #[json_typegen(source = $source)]
        #[allow(unused)]
        struct JsonProviderPlaceholder;
    }
}