nojson 0.3.12

A flexible Rust JSON library with no dependencies, no macros, no unsafe and optional no_std support
Documentation
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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
use alloc::{borrow::Cow, borrow::ToOwned, boxed::Box, rc::Rc, string::String, vec::Vec};
use core::fmt::Display;

use crate::JsonFormatter;

/// A variant of the [`Display`] trait for JSON.
///
/// This trait allows Rust types to be formatted as valid JSON.
/// Unlike the standard [`Display`] trait, [`DisplayJson`] is designed for
/// JSON serialization and supports proper escaping,
/// indentation, and other JSON-specific formatting features.
///
/// # Implementation Notes
///
/// `nojson` provides built-in implementations for many common Rust types:
/// - Basic types (booleans, integers, floats, strings)
/// - Collection types (arrays, vectors, sets, maps)
/// - Nullable types (via `Option<T>`)
/// - Reference types
///
/// # Examples
///
/// Implementing `DisplayJson` for a struct:
/// ```
/// struct Person {
///     name: String,
///     age: u32,
///     email: Option<String>,
/// }
///
/// impl nojson::DisplayJson for Person {
///     fn fmt(&self, f: &mut nojson::JsonFormatter<'_, '_>) -> std::fmt::Result {
///         f.object(|f| {
///             f.member("name", &self.name)?;
///             f.member("age", &self.age)?;
///             f.member("email", &self.email)
///         })
///     }
/// }
///
/// // Now you can use it with `Json` wrapper
/// let person = Person {
///     name: "Alice".to_string(),
///     age: 30,
///     email: Some("alice@example.com".to_string()),
/// };
///
/// assert_eq!(
///     nojson::Json(&person).to_string(),
///     r#"{"name":"Alice","age":30,"email":"alice@example.com"}"#
/// );
/// ```
///
/// Generating JSON in-place using [`json()`](crate::json):
/// ```
/// // Build a JSON object with pretty-printing.
/// let object = nojson::json(|f| {
///     f.set_indent_size(2);
///     f.set_spacing(true);
///     f.object(|f| {
///         f.member("name", "Example")?;
///         f.member("counts", &[1, 2, 3])?;
///         f.member("config", nojson::json(|f| f.object(|f| {
///             f.member("enabled", true)?;
///             f.member("visible", false)
///         })))
///     })
/// });
///
/// // Generate a JSON text from the object.
/// let text = format!("\n{}", object);
/// assert_eq!(text, r#"
/// {
///   "name": "Example",
///   "counts": [
///     1,
///     2,
///     3
///   ],
///   "config": {
///     "enabled": true,
///     "visible": false
///   }
/// }"#);
/// ```
pub trait DisplayJson {
    /// Formats the value as JSON into the provided formatter.
    ///
    /// This method is similar to [`Display::fmt()`], but accepts a
    /// [`JsonFormatter`] which provides additional methods for JSON-specific formatting.
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result;
}

impl<T: DisplayJson + ?Sized> DisplayJson for &T {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        (**self).fmt(f)
    }
}

impl<T: DisplayJson + ?Sized> DisplayJson for &mut T {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        (**self).fmt(f)
    }
}

impl<T: DisplayJson + ?Sized> DisplayJson for Box<T> {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        (**self).fmt(f)
    }
}

impl<T: DisplayJson + ?Sized> DisplayJson for Rc<T> {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        (**self).fmt(f)
    }
}

// `alloc::sync::Arc` only exists when the target supports pointer-sized
// atomics, so keep this impl out of builds for targets without that support
// (for example `thumbv6m-none-eabi`).
#[cfg(target_has_atomic = "ptr")]
impl<T: DisplayJson + ?Sized> DisplayJson for alloc::sync::Arc<T> {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        (**self).fmt(f)
    }
}

impl<T: DisplayJson> DisplayJson for Option<T> {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        if let Some(v) = self {
            v.fmt(f)
        } else {
            write!(f.inner_mut(), "null")
        }
    }
}

impl DisplayJson for bool {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        write!(f.inner_mut(), "{self}")
    }
}

impl DisplayJson for i8 {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        write!(f.inner_mut(), "{self}")
    }
}

impl DisplayJson for i16 {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        write!(f.inner_mut(), "{self}")
    }
}

impl DisplayJson for i32 {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        write!(f.inner_mut(), "{self}")
    }
}

impl DisplayJson for i64 {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        write!(f.inner_mut(), "{self}")
    }
}

impl DisplayJson for i128 {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        write!(f.inner_mut(), "{self}")
    }
}

impl DisplayJson for isize {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        write!(f.inner_mut(), "{self}")
    }
}

impl DisplayJson for u8 {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        write!(f.inner_mut(), "{self}")
    }
}

impl DisplayJson for u16 {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        write!(f.inner_mut(), "{self}")
    }
}

impl DisplayJson for u32 {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        write!(f.inner_mut(), "{self}")
    }
}

impl DisplayJson for u64 {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        write!(f.inner_mut(), "{self}")
    }
}

impl DisplayJson for u128 {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        write!(f.inner_mut(), "{self}")
    }
}

impl DisplayJson for usize {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        write!(f.inner_mut(), "{self}")
    }
}

impl DisplayJson for core::num::NonZeroI8 {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        write!(f.inner_mut(), "{self}")
    }
}

impl DisplayJson for core::num::NonZeroI16 {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        write!(f.inner_mut(), "{self}")
    }
}

impl DisplayJson for core::num::NonZeroI32 {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        write!(f.inner_mut(), "{self}")
    }
}

impl DisplayJson for core::num::NonZeroI64 {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        write!(f.inner_mut(), "{self}")
    }
}

impl DisplayJson for core::num::NonZeroI128 {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        write!(f.inner_mut(), "{self}")
    }
}

impl DisplayJson for core::num::NonZeroIsize {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        write!(f.inner_mut(), "{self}")
    }
}

impl DisplayJson for core::num::NonZeroU8 {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        write!(f.inner_mut(), "{self}")
    }
}

impl DisplayJson for core::num::NonZeroU16 {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        write!(f.inner_mut(), "{self}")
    }
}

impl DisplayJson for core::num::NonZeroU32 {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        write!(f.inner_mut(), "{self}")
    }
}

impl DisplayJson for core::num::NonZeroU64 {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        write!(f.inner_mut(), "{self}")
    }
}

impl DisplayJson for core::num::NonZeroU128 {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        write!(f.inner_mut(), "{self}")
    }
}

impl DisplayJson for core::num::NonZeroUsize {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        write!(f.inner_mut(), "{self}")
    }
}

impl DisplayJson for f32 {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        if self.is_finite() {
            write!(f.inner_mut(), "{self}")
        } else {
            write!(f.inner_mut(), "null")
        }
    }
}

impl DisplayJson for f64 {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        if self.is_finite() {
            write!(f.inner_mut(), "{self}")
        } else {
            write!(f.inner_mut(), "null")
        }
    }
}

impl DisplayJson for char {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        f.string(self)
    }
}

impl DisplayJson for str {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        f.string(self)
    }
}

impl DisplayJson for String {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        f.string(self)
    }
}

impl<'a, T: ?Sized + DisplayJson + ToOwned> DisplayJson for Cow<'a, T> {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        f.value(self.as_ref())
    }
}

#[cfg(feature = "std")]
impl DisplayJson for std::path::Path {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        f.string(self.display())
    }
}

#[cfg(feature = "std")]
impl DisplayJson for std::path::PathBuf {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        f.string(self.display())
    }
}

#[cfg(feature = "std")]
impl DisplayJson for std::net::SocketAddr {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        f.string(self)
    }
}

#[cfg(feature = "std")]
impl DisplayJson for std::net::SocketAddrV4 {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        f.string(self)
    }
}

#[cfg(feature = "std")]
impl DisplayJson for std::net::SocketAddrV6 {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        f.string(self)
    }
}

#[cfg(feature = "std")]
impl DisplayJson for std::net::IpAddr {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        f.string(self)
    }
}

#[cfg(feature = "std")]
impl DisplayJson for std::net::Ipv4Addr {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        f.string(self)
    }
}

#[cfg(feature = "std")]
impl DisplayJson for std::net::Ipv6Addr {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        f.string(self)
    }
}

impl<T: DisplayJson, const N: usize> DisplayJson for [T; N] {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        f.array(|f| f.elements(self.iter()))
    }
}

impl<T: DisplayJson> DisplayJson for [T] {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        f.array(|f| f.elements(self.iter()))
    }
}

impl<T: DisplayJson> DisplayJson for Vec<T> {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        f.array(|f| f.elements(self.iter()))
    }
}

impl<T: DisplayJson> DisplayJson for alloc::collections::VecDeque<T> {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        f.array(|f| f.elements(self.iter()))
    }
}

impl<T: DisplayJson> DisplayJson for alloc::collections::BTreeSet<T> {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        f.array(|f| f.elements(self.iter()))
    }
}

#[cfg(feature = "std")]
impl<T: DisplayJson> DisplayJson for std::collections::HashSet<T> {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        f.array(|f| f.elements(self.iter()))
    }
}

impl DisplayJson for () {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        write!(f.inner_mut(), "null")
    }
}

impl<K: Display, V: DisplayJson> DisplayJson for alloc::collections::BTreeMap<K, V> {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        f.object(|f| f.members(self.iter()))
    }
}

#[cfg(feature = "std")]
impl<K: Display, V: DisplayJson> DisplayJson for std::collections::HashMap<K, V> {
    fn fmt(&self, f: &mut JsonFormatter<'_, '_>) -> core::fmt::Result {
        f.object(|f| f.members(self.iter()))
    }
}