Skip to main content

manual/
manual.rs

1//! Manual serialization and deserialization — no derive macros.
2//!
3//! Shows both tiers of the API:
4//!
5//! **`std` tier** (`default`): `nanojson::stringify` / `nanojson::parse_as` —
6//! no buffer choices, heap grows as needed.
7//!
8//! **`no_std` tier**: `nanojson::serialize::<N>` / `nanojson::parse::<STR_BUF>` —
9//! all memory on the stack, caller picks sizes.
10//!
11//! The low-level `Serializer` / `Parser` / `SliceWriter` primitives are still
12//! used directly in the final section to show pretty-printing, which has no
13//! convenience wrapper yet.
14
15extern crate std;
16
17use nanojson::{Serializer, Parser, SliceWriter};
18
19fn main() {
20    // ----------------------------------------------------------------
21    // 1. std tier — serialize into a String, no size choice needed
22    // ----------------------------------------------------------------
23
24    let json = nanojson::stringify_as(|s| {
25        s.object_begin()?;
26          s.member("name")?;   s.string("Alice")?;
27          s.member("scores")?;
28            s.array_begin()?;
29              s.integer(95)?;
30              s.integer(87)?;
31              s.integer(100)?;
32            s.array_end()?;
33          s.member("meta")?;
34            s.object_begin()?;
35              s.member("active")?; s.boolean(true)?;
36              s.member("level")?;  s.integer(3)?;
37            s.object_end()?;
38        s.object_end()
39    })
40    .unwrap();
41
42    std::println!("Serialized (std): {json}");
43
44    // ----------------------------------------------------------------
45    // 2. std tier — parse via closure, scratch buffer auto-allocated
46    // ----------------------------------------------------------------
47
48    let mut name_bytes = [0u8; 32];
49    let mut name_len = 0usize;
50    let mut scores = [0i64; 8];
51    let mut score_count = 0usize;
52    let mut active = false;
53    let mut level = 0i64;
54
55    nanojson::parse_as(json.as_bytes(), |p| {
56        p.object_begin()?;
57        while let Some(key) = p.member()? {
58            // key is &'src str — borrows the source, no copy needed.
59            match key {
60                "name" => {
61                    let s = p.string()?;
62                    name_len = s.len();
63                    name_bytes[..name_len].copy_from_slice(s.as_bytes());
64                }
65                "scores" => {
66                    p.array_begin()?;
67                    while p.array_item()? {
68                        scores[score_count] = p.integer()?;
69                        score_count += 1;
70                    }
71                    p.array_end()?;
72                }
73                "meta" => {
74                    p.object_begin()?;
75                    while let Some(mk) = p.member()? {
76                        match mk {
77                            "active" => { active = p.boolean()?; }
78                            "level"  => { level  = p.integer()?; }
79                            other    => panic!("unknown meta field: {other}"),
80                        }
81                    }
82                    p.object_end()?;
83                }
84                other => panic!("unknown field: {other}"),
85            }
86        }
87        p.object_end()?;
88        Ok(())
89    })
90    .unwrap();
91
92    let name = core::str::from_utf8(&name_bytes[..name_len]).unwrap();
93    std::println!("name:    {name}");
94    std::println!("scores:  {:?}", &scores[..score_count]);
95    std::println!("active:  {active}");
96    std::println!("level:   {level}");
97
98    // ----------------------------------------------------------------
99    // 3. no_std tier — serialize into a fixed [u8; 512] stack buffer
100    // ----------------------------------------------------------------
101
102    let mut buf = [0; 512];
103    let json = nanojson::stringify_sized_as(&mut buf, |s| {
104        s.object_begin()?;
105          s.member("name")?;   s.string("Alice")?;
106          s.member("scores")?;
107            s.array_begin()?;
108              s.integer(95)?;
109              s.integer(87)?;
110              s.integer(100)?;
111            s.array_end()?;
112          s.member("meta")?;
113            s.object_begin()?;
114              s.member("active")?; s.boolean(true)?;
115              s.member("level")?;  s.integer(3)?;
116            s.object_end()?;
117        s.object_end()
118    })
119    .unwrap();
120
121    std::println!("\nSerialized (no_std, {} bytes): {}", json.len(), json);
122
123    // ----------------------------------------------------------------
124    // 4. no_std tier — parse with a 64-byte stack scratch buffer
125    //
126    //    The scratch buffer only needs to fit the longest single string
127    //    value after escape-decoding; 64 bytes is ample here.
128    //    Object keys borrow from the source directly — no buffer needed.
129    // ----------------------------------------------------------------
130
131    let mut name_bytes = [0u8; 32];
132    let mut name_len = 0usize;
133    let mut scores = [0i64; 8];
134    let mut score_count = 0usize;
135    let mut active = false;
136    let mut level = 0i64;
137
138    let mut str_buf = [0u8; 64];
139    let mut p = Parser::new(json.as_bytes(), &mut str_buf);
140
141    p.object_begin().unwrap();
142    while let Some(key) = p.member().unwrap() {
143        match key {
144            "name" => {
145                let s = p.string().unwrap();
146                name_len = s.len();
147                name_bytes[..name_len].copy_from_slice(s.as_bytes());
148            }
149            "scores" => {
150                p.array_begin().unwrap();
151                while p.array_item().unwrap() {
152                    scores[score_count] = p.integer().unwrap();
153                    score_count += 1;
154                }
155                p.array_end().unwrap();
156            }
157            "meta" => {
158                p.object_begin().unwrap();
159                while let Some(mk) = p.member().unwrap() {
160                    match mk {
161                        "active" => { active = p.boolean().unwrap(); }
162                        "level"  => { level  = p.integer().unwrap(); }
163                        other    => panic!("unknown meta field: {other}"),
164                    }
165                }
166                p.object_end().unwrap();
167            }
168            other => panic!("unknown field: {other}"),
169        }
170    }
171    p.object_end().unwrap();
172
173    let name = core::str::from_utf8(&name_bytes[..name_len]).unwrap();
174    std::println!("\nParsed (no_std):");
175    std::println!("name:    {name}");
176    std::println!("scores:  {:?}", &scores[..score_count]);
177    std::println!("active:  {active}");
178    std::println!("level:   {level}");
179
180    // ----------------------------------------------------------------
181    // 5. Pretty-printing — uses Serializer directly (no convenience
182    //    wrapper for this yet; SliceWriter is fine for a fixed output)
183    // ----------------------------------------------------------------
184
185    let mut pretty_buf = [0u8; 512];
186    let pretty_len;
187    {
188        let mut w = SliceWriter::new(&mut pretty_buf);
189        let mut ser: Serializer<_, 16> = Serializer::with_pretty(&mut w, 2);
190
191        ser.object_begin().unwrap();
192          ser.member("name").unwrap();   ser.string(name).unwrap();
193          ser.member("active").unwrap(); ser.boolean(active).unwrap();
194          ser.member("level").unwrap();  ser.integer(level).unwrap();
195        ser.object_end().unwrap();
196
197        pretty_len = w.pos();
198    }
199
200    std::println!("\nPretty-printed:\n{}", core::str::from_utf8(&pretty_buf[..pretty_len]).unwrap());
201
202    // ----------------------------------------------------------------
203    // 6. Size estimation — measure before committing to a buffer size
204    // ----------------------------------------------------------------
205
206    let n = nanojson::measure(|s| {
207        s.object_begin()?;
208          s.member("name")?;  s.string("Alice")?;
209          s.member("level")?; s.integer(3)?;
210        s.object_end()
211    });
212    std::println!("\n`{{\"name\":\"Alice\",\"level\":3}}` is {n} bytes.");
213    // Use the measured size to pick N: serialize::<{n}>(...) or similar.
214}
215
216#[cfg(test)] #[test] fn test_main() { main() }