/
index.html
804 lines (356 loc) · 25.2 KB
/
index.html
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
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
<!DOCTYPE HTML>
<html lang="en" >
<head>
<meta charset="UTF-8">
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<title>Overview · Serde</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="description" content="">
<meta name="generator" content="GitBook 3.2.3">
<link rel="stylesheet" href="gitbook/style.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-codeblock-rust/block.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-checklist/checklist.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-anchors/plugin.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-highlight/website.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-fontsettings/website.css">
<link rel="stylesheet" href="styles/website.css">
<meta name="HandheldFriendly" content="true"/>
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black">
<link rel="apple-touch-icon-precomposed" sizes="152x152" href="gitbook/images/apple-touch-icon-precomposed-152.png">
<link rel="shortcut icon" href="gitbook/images/favicon.ico" type="image/x-icon">
<link rel="next" href="help.html" />
</head>
<body>
<div class="book with-summary font-size-2">
<div class="book-summary">
<nav role="navigation">
<ul class="summary">
<li class="chapter active" data-level="1.1" data-path="./">
<a href="./">
Overview
</a>
</li>
<li class="chapter " data-level="1.2" data-path="help.html">
<a href="help.html">
Help
</a>
</li>
<li class="chapter " data-level="1.3" data-path="data-model.html">
<a href="data-model.html">
Serde data model
</a>
</li>
<li class="chapter " data-level="1.4" data-path="derive.html">
<a href="derive.html">
Using derive
</a>
</li>
<li class="chapter " data-level="1.5" data-path="attributes.html">
<a href="attributes.html">
Attributes
</a>
<ul class="articles">
<li class="chapter " data-level="1.5.1" data-path="container-attrs.html">
<a href="container-attrs.html">
Container attributes
</a>
</li>
<li class="chapter " data-level="1.5.2" data-path="variant-attrs.html">
<a href="variant-attrs.html">
Variant attributes
</a>
</li>
<li class="chapter " data-level="1.5.3" data-path="field-attrs.html">
<a href="field-attrs.html">
Field attributes
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.6" data-path="custom-serialization.html">
<a href="custom-serialization.html">
Custom serialization
</a>
<ul class="articles">
<li class="chapter " data-level="1.6.1" data-path="impl-serialize.html">
<a href="impl-serialize.html">
Implementing Serialize
</a>
</li>
<li class="chapter " data-level="1.6.2" data-path="impl-deserialize.html">
<a href="impl-deserialize.html">
Implementing Deserialize
</a>
</li>
<li class="chapter " data-level="1.6.3" data-path="unit-testing.html">
<a href="unit-testing.html">
Unit testing
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.7" data-path="data-format.html">
<a href="data-format.html">
Writing a data format
</a>
<ul class="articles">
<li class="chapter " data-level="1.7.1" data-path="conventions.html">
<a href="conventions.html">
Conventions
</a>
</li>
<li class="chapter " data-level="1.7.2" data-path="error-handling.html">
<a href="error-handling.html">
Error handling
</a>
</li>
<li class="chapter " data-level="1.7.3" data-path="impl-serializer.html">
<a href="impl-serializer.html">
Implementing a Serializer
</a>
</li>
<li class="chapter " data-level="1.7.4" data-path="impl-deserializer.html">
<a href="impl-deserializer.html">
Implementing a Deserializer
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.8" data-path="lifetimes.html">
<a href="lifetimes.html">
Deserializer lifetimes
</a>
</li>
<li class="chapter " data-level="1.9" data-path="examples.html">
<a href="examples.html">
Examples
</a>
<ul class="articles">
<li class="chapter " data-level="1.9.1" data-path="json.html">
<a href="json.html">
Structs and enums in JSON
</a>
</li>
<li class="chapter " data-level="1.9.2" data-path="enum-representations.html">
<a href="enum-representations.html">
Enum representations
</a>
</li>
<li class="chapter " data-level="1.9.3" data-path="attr-default.html">
<a href="attr-default.html">
Default value for a field
</a>
</li>
<li class="chapter " data-level="1.9.4" data-path="attr-flatten.html">
<a href="attr-flatten.html">
Struct flattening
</a>
</li>
<li class="chapter " data-level="1.9.5" data-path="attr-bound.html">
<a href="attr-bound.html">
Handwritten generic type bounds
</a>
</li>
<li class="chapter " data-level="1.9.6" data-path="deserialize-map.html">
<a href="deserialize-map.html">
Deserialize for custom map type
</a>
</li>
<li class="chapter " data-level="1.9.7" data-path="stream-array.html">
<a href="stream-array.html">
Array of values without buffering
</a>
</li>
<li class="chapter " data-level="1.9.8" data-path="enum-number.html">
<a href="enum-number.html">
Serialize enum as number
</a>
</li>
<li class="chapter " data-level="1.9.9" data-path="attr-rename.html">
<a href="attr-rename.html">
Serialize fields as camelCase
</a>
</li>
<li class="chapter " data-level="1.9.10" data-path="attr-skip-serializing.html">
<a href="attr-skip-serializing.html">
Skip serializing field
</a>
</li>
<li class="chapter " data-level="1.9.11" data-path="remote-derive.html">
<a href="remote-derive.html">
Derive for remote crate
</a>
</li>
<li class="chapter " data-level="1.9.12" data-path="deserialize-struct.html">
<a href="deserialize-struct.html">
Manually deserialize struct
</a>
</li>
<li class="chapter " data-level="1.9.13" data-path="ignored-any.html">
<a href="ignored-any.html">
Discarding data
</a>
</li>
<li class="chapter " data-level="1.9.14" data-path="transcode.html">
<a href="transcode.html">
Transcode into another format
</a>
</li>
<li class="chapter " data-level="1.9.15" data-path="string-or-struct.html">
<a href="string-or-struct.html">
Either string or struct
</a>
</li>
<li class="chapter " data-level="1.9.16" data-path="convert-error.html">
<a href="convert-error.html">
Convert error types
</a>
</li>
<li class="chapter " data-level="1.9.17" data-path="custom-date-format.html">
<a href="custom-date-format.html">
Custom date format
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.10" data-path="no-std.html">
<a href="no-std.html">
No-std support
</a>
</li>
<li class="chapter " data-level="1.11" data-path="feature-flags.html">
<a href="feature-flags.html">
Feature flags
</a>
</li>
</ul>
</nav>
</div>
<div class="book-body">
<div class="body-inner">
<div class="book-header" role="navigation">
<!-- Title -->
<h1>
<i class="fa fa-circle-o-notch fa-spin"></i>
<a href="." >Overview</a>
</h1>
</div>
<div class="page-wrapper" tabindex="-1" role="main">
<div class="page-inner">
<section class="normal markdown-section">
<p><span style="float:right">
<a href="https://github.com/serde-rs/serde" target="_blank"><img src="img/github.svg" alt="GitHub"></a>
<a href="https://docs.rs/serde" target="_blank"><img src="img/rustdoc.svg" alt="rustdoc"></a>
<a href="https://crates.io/crates/serde" target="_blank"><img src="https://img.shields.io/crates/v/serde.svg?style=social" alt="Latest Version"></a>
</span></p>
<div style="clear:both"></div>
<h1 id="serde"><a name="serde" class="plugin-anchor" href="#serde"><i class="fa fa-link" aria-hidden="true"></i></a>Serde</h1>
<p>Serde is a framework for <strong><em>ser</em></strong>ializing and <strong><em>de</em></strong>serializing Rust data
structures efficiently and generically.</p>
<p>The Serde ecosystem consists of data structures that know how to serialize and
deserialize themselves along with data formats that know how to serialize and
deserialize other things. Serde provides the layer by which these two groups
interact with each other, allowing any supported data structure to be serialized
and deserialized using any supported data format.</p>
<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/BI_bHCGRgMY" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
<h3 id="design"><a name="design" class="plugin-anchor" href="#design"><i class="fa fa-link" aria-hidden="true"></i></a>Design</h3>
<p>Where many other languages rely on runtime reflection for serializing data,
Serde is instead built on Rust's powerful trait system. A data structure that
knows how to serialize and deserialize itself is one that implements Serde's
<code>Serialize</code> and <code>Deserialize</code> traits (or uses Serde's derive attribute to
automatically generate implementations at compile time). This avoids any
overhead of reflection or runtime type information. In fact in many situations
the interaction between data structure and data format can be completely
optimized away by the Rust compiler, leaving Serde serialization to perform
the same speed as a handwritten serializer for the specific selection of data
structure and data format.</p>
<h3 id="data-formats"><a name="data-formats" class="plugin-anchor" href="#data-formats"><i class="fa fa-link" aria-hidden="true"></i></a>Data formats</h3>
<p>The following is a partial list of data formats that have been implemented for
Serde by the community.</p>
<ul>
<li><a href="https://github.com/serde-rs/json" target="_blank">JSON</a>, the ubiquitous JavaScript Object Notation used by many HTTP APIs.</li>
<li><a href="https://github.com/jamesmunns/postcard" target="_blank">Postcard</a>, a no_std and embedded-systems friendly compact binary format.</li>
<li><a href="https://github.com/enarx/ciborium" target="_blank">CBOR</a>, a Concise Binary Object Representation designed for small message size
without the need for version negotiation.</li>
<li><a href="https://github.com/dtolnay/serde-yaml" target="_blank">YAML</a>, a self-proclaimed human-friendly configuration language that ain't
markup language.</li>
<li><a href="https://github.com/3Hren/msgpack-rust" target="_blank">MessagePack</a>, an efficient binary format that resembles a compact JSON.</li>
<li><a href="https://docs.rs/toml" target="_blank">TOML</a>, a minimal configuration format used by <a href="http://doc.crates.io/manifest.html" target="_blank">Cargo</a>.</li>
<li><a href="https://github.com/birkenfeld/serde-pickle" target="_blank">Pickle</a>, a format common in the Python world.</li>
<li><a href="https://github.com/ron-rs/ron" target="_blank">RON</a>, a Rusty Object Notation.</li>
<li><a href="https://github.com/mongodb/bson-rust" target="_blank">BSON</a>, the data storage and network transfer format used by MongoDB.</li>
<li><a href="https://docs.rs/apache-avro" target="_blank">Avro</a>, a binary format used within Apache Hadoop, with support for schema
definition.</li>
<li><a href="https://github.com/callum-oakley/json5-rs" target="_blank">JSON5</a>, a superset of JSON including some productions from ES5.</li>
<li><a href="https://docs.rs/serde_qs" target="_blank">URL</a> query strings, in the x-www-form-urlencoded format.</li>
<li><a href="https://github.com/dtolnay/serde-starlark" target="_blank">Starlark</a>, the format used for describing build targets by the Bazel and Buck
build systems. <em>(serialization only)</em></li>
<li><a href="https://github.com/softprops/envy" target="_blank">Envy</a>, a way to deserialize environment variables into Rust structs.
<em>(deserialization only)</em></li>
<li><a href="https://github.com/softprops/envy-store" target="_blank">Envy Store</a>, a way to deserialize <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-parameter-store.html" target="_blank">AWS Parameter Store</a> parameters into Rust
structs. <em>(deserialization only)</em></li>
<li><a href="https://github.com/rotty/lexpr-rs" target="_blank">S-expressions</a>, the textual representation of code and data used by the Lisp
language family.</li>
<li><a href="https://docs.rs/zvariant" target="_blank">D-Bus</a>'s binary wire format.</li>
<li><a href="https://github.com/google/flatbuffers/tree/master/rust/flexbuffers" target="_blank">FlexBuffers</a>, the schemaless cousin of Google's FlatBuffers zero-copy
serialization format.</li>
<li><a href="https://github.com/P3KI/bendy" target="_blank">Bencode</a>, a simple binary format used in the BitTorrent protocol.</li>
<li><a href="https://github.com/oxidecomputer/serde_tokenstream" target="_blank">Token streams</a>, for processing Rust procedural macro input. <em>(deserialization
only)</em></li>
<li><a href="https://docs.rs/serde_dynamo" target="_blank">DynamoDB Items</a>, the format used by <a href="https://docs.rs/rusoto_dynamodb" target="_blank">rusoto_dynamodb</a> to transfer data to
and from DynamoDB.</li>
<li><a href="https://github.com/Canop/deser-hjson" target="_blank">Hjson</a>, a syntax extension to JSON designed around human reading and editing.
<em>(deserialization only)</em></li>
<li><a href="https://docs.rs/csv" target="_blank">CSV</a>, Comma-separated values is a tabular text file format.</li>
</ul>
<h3 id="data-structures"><a name="data-structures" class="plugin-anchor" href="#data-structures"><i class="fa fa-link" aria-hidden="true"></i></a>Data structures</h3>
<p>Out of the box, Serde is able to serialize and deserialize common Rust data
types in any of the above formats. For example <code>String</code>, <code>&str</code>, <code>usize</code>,
<code>Vec<T></code>, <code>HashMap<K,V></code> are all supported. In addition, Serde provides a derive
macro to generate serialization implementations for structs in your own program.
Using the derive macro goes like this:</p>
<pre><a class="playground-link" target="_blank" href="https://play.rust-lang.org/?edition=2018&gist=72755f28f99afc95e01d63174b28c1f5"></a><code class="lang-rust"><span class="hljs-keyword">use</span> serde::{Serialize, Deserialize};
<span class="hljs-meta">#[derive(Serialize, Deserialize, Debug)]</span>
<span class="hljs-class"><span class="hljs-keyword">struct</span> <span class="hljs-title">Point</span></span> {
x: <span class="hljs-keyword">i32</span>,
y: <span class="hljs-keyword">i32</span>,
}
<span class="hljs-function"><span class="hljs-keyword">fn</span> <span class="hljs-title">main</span></span>() {
<span class="hljs-keyword">let</span> point = Point { x: <span class="hljs-number">1</span>, y: <span class="hljs-number">2</span> };
<span class="hljs-comment">// Convert the Point to a JSON string.</span>
<span class="hljs-keyword">let</span> serialized = serde_json::to_string(&point).unwrap();
<span class="hljs-comment">// Prints serialized = {"x":1,"y":2}</span>
<span class="hljs-built_in">println!</span>(<span class="hljs-string">"serialized = {}"</span>, serialized);
<span class="hljs-comment">// Convert the JSON string back to a Point.</span>
<span class="hljs-keyword">let</span> deserialized: Point = serde_json::from_str(&serialized).unwrap();
<span class="hljs-comment">// Prints deserialized = Point { x: 1, y: 2 }</span>
<span class="hljs-built_in">println!</span>(<span class="hljs-string">"deserialized = {:?}"</span>, deserialized);
}
</code></pre>
</section>
</div>
</div>
</div>
<a href="help.html" class="navigation navigation-next navigation-unique" aria-label="Next page: Help">
<i class="fa fa-angle-right"></i>
</a>
</div>
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Overview","level":"1.1","depth":1,"next":{"title":"Help","level":"1.2","depth":1,"path":"help.md","ref":"help.md","articles":[]},"dir":"ltr"},"config":{"plugins":["-search","-sharing","sane-sidebar","codeblock-omit","codeblock-rust","edit-link","ga4","bulk-redirect","checklist","anchors"],"root":"_src","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"checklist":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"codeblock-rust":{},"fontsettings":{"theme":"white","family":"sans","size":2},"highlight":{},"sane-sidebar":{},"codeblock-omit":{},"bulk-redirect":{"redirectsFile":"redirects.json"},"ga4":{"anonymize_ip":true,"cookie_domain":"serde.rs","tag":"G-T5QD1R7FZW"},"edit-link":{"label":"Edit","base":"https://github.com/serde-rs/serde-rs.github.io/edit/master/_src"},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"anchors":{}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Serde","language":"en","gitbook":"*"},"file":{"path":"README.md","mtime":"2023-10-10T02:24:08.404Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2024-03-17T00:07:22.816Z"},"basePath":".","book":{"language":""}});
});
</script>
</div>
<script src="gitbook/gitbook.js"></script>
<script src="gitbook/theme.js"></script>
<script src="gitbook/gitbook-plugin-sane-sidebar/plugin.js"></script>
<script src="gitbook/gitbook-plugin-edit-link/plugin.js"></script>
<script src="gitbook/gitbook-plugin-ga4/plugin.js"></script>
<script src="gitbook/gitbook-plugin-lunr/lunr.min.js"></script>
<script src="gitbook/gitbook-plugin-lunr/search-lunr.js"></script>
<script src="gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script>
</body>
</html>