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 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
//! Json String Literal Generator //! //! Write json with Rust syntax instead of hard to read inline strings. //! This crate doesn't evaluate any expressions, it just converts a Rust _token tree_ into a //! minified json string. //! //! # Usage //! //! This crate is on [crates.io](https://crates.io/crates/json_str). //! //! There are two ways to reference `json_str` in your projects, depending on whether you're on //! the `stable`/`beta` or `nightly` channels. //! //! ## Stable //! //! To get started, add `json_str` to your `Cargo.toml`: //! //! ```ignore //! [dependencies] //! json_str = "*" //! ``` //! //! And reference it in your crate root: //! //! ```ignore //! #[macro_use] //! extern crate json_str; //! ``` //! //! ## Nightly //! //! To get started, add `json_str` to your `Cargo.toml`: //! //! ```ignore //! [dependencies] //! json_str = { version = "*", features = "nightly" } //! ``` //! //! And reference it in your crate root: //! //! ```ignore //! #![feature(plugin)] //! #![plugin(json_str)] //! ``` //! //! If you're on the `nightly` channel, it's better to use the above `plugin` version with the `nightly` //! feature because the conversion and sanitisation takes place at compile-time instead of runtime, //! saving precious runtime cycles. //! //! ## Examples //! //! The `json_str!` macro will take an inline token tree and return a sanitised json `String`: //! //! ``` //! # #![feature(plugin)] //! # #![plugin(json_str)] //! # fn main() { //! let json = json_str!({ //! "query": { //! "filtered": { //! "query": { //! "match_all": {} //! }, //! "filter": { //! "geo_distance": { //! "distance": "20km", //! "location": { //! "lat": 37.776, //! "lon": -122.41 //! } //! } //! } //! } //! } //! }); //! # } //! ``` //! //! This will also work for unquoted keys for something a bit more `rusty`: //! //! ``` //! # #![feature(plugin)] //! # #![plugin(json_str)] //! # fn main() { //! let json = json_str!({ //! query: { //! filtered: { //! query: { //! match_all: {} //! }, //! filter: { //! geo_distance: { //! distance: "20km", //! location: { //! lat: 37.776, //! lon: -122.41 //! } //! } //! } //! } //! } //! }); //! # } //! ``` //! //! On `nightly`, there's an additional plugin called `json_lit` that returns a `&'static str` //! instead of a `String`, so you can avoid allocating each time. The syntax is otherwise the same //! as `json_str`: //! //! ``` //! # #![feature(plugin)] //! # #![plugin(json_str)] //! # fn main() { //! let json = json_lit!({ //! "query": { //! "filtered": { //! "query": { //! "match_all": {} //! }, //! "filter": { //! "geo_distance": { //! "distance": "20km", //! "location": { //! "lat": 37.776, //! "lon": -122.41 //! } //! } //! } //! } //! } //! }); //! # } //! ``` //! //! For json values that can't be fully determined at compile-time, //! use [json_macros](https://github.com/tomjakubowski/json_macros) instead. #![doc(html_root_url = "http://kodraus.github.io/rustdoc/json_str/")] #![cfg_attr(feature = "nightly", crate_type="dylib")] #![cfg_attr(feature = "nightly", feature(plugin_registrar, rustc_private, quote, plugin, stmt_expr_attributes))] #[doc(hidden)] pub mod parse; #[cfg(feature = "nightly")] include!("lib.rs.in"); #[cfg_attr(not(feature = "nightly"), macro_export)] #[cfg(not(feature = "nightly"))] macro_rules! json_str { ($j:tt) => ({ let json_raw = stringify!($j); let mut json = String::with_capacity(json_raw.len()); $crate::parse::sanitise(json_raw.as_bytes(), &mut json); json }) }