-
Notifications
You must be signed in to change notification settings - Fork 236
/
element.rs
2107 lines (1843 loc) · 86.8 KB
/
element.rs
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
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//! Contains serializer for an XML element
use crate::de::{TEXT_KEY, VALUE_KEY};
use crate::se::content::ContentSerializer;
use crate::se::key::QNameSerializer;
use crate::se::simple_type::{QuoteTarget, SimpleSeq, SimpleTypeSerializer};
use crate::se::text::TextSerializer;
use crate::se::{SeError, WriteResult, XmlName};
use serde::ser::{
Impossible, Serialize, SerializeMap, SerializeSeq, SerializeStruct, SerializeStructVariant,
SerializeTuple, SerializeTupleStruct, SerializeTupleVariant, Serializer,
};
use serde::serde_if_integer128;
use std::fmt::Write;
/// Writes simple type content between [`ElementSerializer::key`] tags.
macro_rules! write_primitive {
($method:ident ( $ty:ty )) => {
fn $method(self, value: $ty) -> Result<Self::Ok, Self::Error> {
self.ser.write_wrapped(self.key, |ser| ser.$method(value))
}
};
}
////////////////////////////////////////////////////////////////////////////////////////////////////
/// A serializer used to serialize element with specified name. Unlike the [`ContentSerializer`],
/// this serializer never uses variant names of enum variants, and because of that
/// it is unable to serialize any enum values, except unit variants.
///
/// Returns the classification of the last written type.
///
/// This serializer is used for an ordinary fields in structs, which are not special
/// fields named `$text` ([`TEXT_KEY`]) or `$value` ([`VALUE_KEY`]). `$text` field
/// should be serialized using [`SimpleTypeSerializer`] and `$value` field should be
/// serialized using [`ContentSerializer`].
///
/// This serializer does the following:
/// - numbers converted to a decimal representation and serialized as `<key>value</key>`;
/// - booleans serialized ether as `<key>true</key>` or `<key>false</key>`;
/// - strings and characters are serialized as `<key>value</key>`. In particular,
/// an empty string is serialized as `<key/>`;
/// - `None` is serialized as `<key/>`;
/// - `Some` and newtypes are serialized as an inner type using the same serializer;
/// - units (`()`) and unit structs are serialized as `<key/>`;
/// - sequences, tuples and tuple structs are serialized as repeated `<key>` tag.
/// In particular, empty sequence is serialized to nothing;
/// - structs are serialized as a sequence of fields wrapped in a `<key>` tag. Each
/// field is serialized recursively using either `ElementSerializer`, [`ContentSerializer`]
/// (`$value` fields), or [`SimpleTypeSerializer`] (`$text` fields).
/// In particular, the empty struct is serialized as `<key/>`;
/// - maps are serialized as a sequence of entries wrapped in a `<key>` tag. If key is
/// serialized to a special name, the same rules as for struct fields are applied.
/// In particular, the empty map is serialized as `<key/>`;
/// - enums:
/// - unit variants are serialized as `<key>variant</key>`;
/// - other variants are not supported ([`SeError::Unsupported`] is returned);
///
/// Usage of empty tags depends on the [`ContentSerializer::expand_empty_elements`] setting.
pub struct ElementSerializer<'w, 'k, W: Write> {
/// The inner serializer that contains the settings and mostly do the actual work
pub ser: ContentSerializer<'w, 'k, W>,
/// Tag name used to wrap serialized types except enum variants which uses the variant name
pub(super) key: XmlName<'k>,
}
impl<'w, 'k, W: Write> Serializer for ElementSerializer<'w, 'k, W> {
type Ok = WriteResult;
type Error = SeError;
type SerializeSeq = Self;
type SerializeTuple = Self;
type SerializeTupleStruct = Self;
type SerializeTupleVariant = Impossible<Self::Ok, Self::Error>;
type SerializeMap = Map<'w, 'k, W>;
type SerializeStruct = Struct<'w, 'k, W>;
type SerializeStructVariant = Struct<'w, 'k, W>;
write_primitive!(serialize_bool(bool));
write_primitive!(serialize_i8(i8));
write_primitive!(serialize_i16(i16));
write_primitive!(serialize_i32(i32));
write_primitive!(serialize_i64(i64));
write_primitive!(serialize_u8(u8));
write_primitive!(serialize_u16(u16));
write_primitive!(serialize_u32(u32));
write_primitive!(serialize_u64(u64));
serde_if_integer128! {
write_primitive!(serialize_i128(i128));
write_primitive!(serialize_u128(u128));
}
write_primitive!(serialize_f32(f32));
write_primitive!(serialize_f64(f64));
write_primitive!(serialize_char(char));
write_primitive!(serialize_bytes(&[u8]));
fn serialize_str(self, value: &str) -> Result<Self::Ok, Self::Error> {
if value.is_empty() {
self.ser.write_empty(self.key)
} else {
self.ser
.write_wrapped(self.key, |ser| ser.serialize_str(value))
}
}
/// By serde contract we should serialize key of [`None`] values. If someone
/// wants to skip the field entirely, he should use
/// `#[serde(skip_serializing_if = "Option::is_none")]`.
///
/// In XML when we serialize field, we write field name as:
/// - element name, or
/// - attribute name
///
/// and field value as
/// - content of the element, or
/// - attribute value
///
/// So serialization of `None` works the same as [serialization of `()`](#method.serialize_unit)
fn serialize_none(self) -> Result<Self::Ok, Self::Error> {
self.serialize_unit()
}
fn serialize_some<T: ?Sized + Serialize>(self, value: &T) -> Result<Self::Ok, Self::Error> {
value.serialize(self)
}
fn serialize_unit(self) -> Result<Self::Ok, Self::Error> {
self.ser.write_empty(self.key)
}
fn serialize_unit_struct(self, _name: &'static str) -> Result<Self::Ok, Self::Error> {
self.ser.write_empty(self.key)
}
/// Writes a tag with name [`Self::key`] and content of unit variant inside.
/// If variant is a special `$text` value, then empty tag `<key/>` is written.
/// Otherwise a `<key>variant</key>` is written.
fn serialize_unit_variant(
self,
name: &'static str,
variant_index: u32,
variant: &'static str,
) -> Result<Self::Ok, Self::Error> {
if variant == TEXT_KEY {
self.ser.write_empty(self.key)
} else {
self.ser.write_wrapped(self.key, |ser| {
ser.serialize_unit_variant(name, variant_index, variant)
})
}
}
fn serialize_newtype_struct<T: ?Sized + Serialize>(
self,
_name: &'static str,
value: &T,
) -> Result<Self::Ok, Self::Error> {
value.serialize(self)
}
/// Always returns [`SeError::Unsupported`]. Newtype variants can be serialized
/// only in `$value` fields, which is serialized using [`ContentSerializer`].
#[inline]
fn serialize_newtype_variant<T: ?Sized + Serialize>(
self,
name: &'static str,
_variant_index: u32,
variant: &'static str,
_value: &T,
) -> Result<Self::Ok, Self::Error> {
Err(SeError::Unsupported(
format!(
"cannot serialize enum newtype variant `{}::{}`",
name, variant
)
.into(),
))
}
#[inline]
fn serialize_seq(self, _len: Option<usize>) -> Result<Self::SerializeSeq, Self::Error> {
Ok(self)
}
#[inline]
fn serialize_tuple(self, len: usize) -> Result<Self::SerializeTuple, Self::Error> {
self.serialize_seq(Some(len))
}
#[inline]
fn serialize_tuple_struct(
self,
_name: &'static str,
len: usize,
) -> Result<Self::SerializeTupleStruct, Self::Error> {
self.serialize_tuple(len)
}
/// Always returns [`SeError::Unsupported`]. Tuple variants can be serialized
/// only in `$value` fields, which is serialized using [`ContentSerializer`].
#[inline]
fn serialize_tuple_variant(
self,
name: &'static str,
_variant_index: u32,
variant: &'static str,
_len: usize,
) -> Result<Self::SerializeTupleVariant, Self::Error> {
Err(SeError::Unsupported(
format!(
"cannot serialize enum tuple variant `{}::{}`",
name, variant
)
.into(),
))
}
fn serialize_map(self, _len: Option<usize>) -> Result<Self::SerializeMap, Self::Error> {
Ok(Map {
ser: self.serialize_struct("", 0)?,
key: None,
})
}
#[inline]
fn serialize_struct(
mut self,
_name: &'static str,
_len: usize,
) -> Result<Self::SerializeStruct, Self::Error> {
self.ser.write_indent()?;
self.ser.indent.increase();
self.ser.writer.write_char('<')?;
self.ser.writer.write_str(self.key.0)?;
Ok(Struct {
ser: self,
children: String::new(),
write_indent: true,
})
}
/// Always returns [`SeError::Unsupported`]. Struct variants can be serialized
/// only in `$value` fields, which is serialized using [`ContentSerializer`].
#[inline]
fn serialize_struct_variant(
self,
name: &'static str,
_variant_index: u32,
variant: &'static str,
_len: usize,
) -> Result<Self::SerializeStructVariant, Self::Error> {
Err(SeError::Unsupported(
format!(
"cannot serialize enum struct variant `{}::{}`",
name, variant
)
.into(),
))
}
}
impl<'w, 'k, W: Write> SerializeSeq for ElementSerializer<'w, 'k, W> {
type Ok = WriteResult;
type Error = SeError;
fn serialize_element<T>(&mut self, value: &T) -> Result<(), Self::Error>
where
T: ?Sized + Serialize,
{
value.serialize(ElementSerializer {
ser: self.ser.new_seq_element_serializer(true),
key: self.key,
})?;
// Write indent for the next element
self.ser.write_indent = true;
Ok(())
}
#[inline]
fn end(self) -> Result<Self::Ok, Self::Error> {
Ok(WriteResult::Element)
}
}
impl<'w, 'k, W: Write> SerializeTuple for ElementSerializer<'w, 'k, W> {
type Ok = WriteResult;
type Error = SeError;
#[inline]
fn serialize_element<T>(&mut self, value: &T) -> Result<(), Self::Error>
where
T: ?Sized + Serialize,
{
SerializeSeq::serialize_element(self, value)
}
#[inline]
fn end(self) -> Result<Self::Ok, Self::Error> {
SerializeSeq::end(self)
}
}
impl<'w, 'k, W: Write> SerializeTupleStruct for ElementSerializer<'w, 'k, W> {
type Ok = WriteResult;
type Error = SeError;
#[inline]
fn serialize_field<T>(&mut self, value: &T) -> Result<(), Self::Error>
where
T: ?Sized + Serialize,
{
SerializeSeq::serialize_element(self, value)
}
#[inline]
fn end(self) -> Result<Self::Ok, Self::Error> {
SerializeSeq::end(self)
}
}
////////////////////////////////////////////////////////////////////////////////////////////////////
/// A serializer for tuple variants. Tuples can be serialized in two modes:
/// - wrapping each tuple field into a tag
/// - without wrapping, fields are delimited by a space
pub enum Tuple<'w, 'k, W: Write> {
/// Serialize each tuple field as an element
Element(ElementSerializer<'w, 'k, W>),
/// Serialize tuple as an `xs:list`: space-delimited content of fields
Text(SimpleSeq<&'w mut W>),
}
impl<'w, 'k, W: Write> SerializeTupleVariant for Tuple<'w, 'k, W> {
type Ok = WriteResult;
type Error = SeError;
#[inline]
fn serialize_field<T>(&mut self, value: &T) -> Result<(), Self::Error>
where
T: ?Sized + Serialize,
{
match self {
Self::Element(ser) => SerializeTuple::serialize_element(ser, value),
Self::Text(ser) => SerializeTuple::serialize_element(ser, value),
}
}
#[inline]
fn end(self) -> Result<Self::Ok, Self::Error> {
match self {
Self::Element(ser) => SerializeTuple::end(ser),
// Do not write indent after `$text` fields because it may be interpreted as
// part of content when deserialize
Self::Text(ser) => SerializeTuple::end(ser).map(|_| WriteResult::SensitiveText),
}
}
}
////////////////////////////////////////////////////////////////////////////////////////////////////
/// A serializer for struct variants, which serializes the struct contents inside
/// of wrapping tags (`<${tag}>...</${tag}>`).
///
/// Returns the classification of the last written type.
///
/// Serialization of each field depends on it representation:
/// - attributes written directly to the higher serializer
/// - elements buffered into internal buffer and at the end written into higher
/// serializer
pub struct Struct<'w, 'k, W: Write> {
ser: ElementSerializer<'w, 'k, W>,
/// Buffer to store serialized elements
// TODO: Customization point: allow direct writing of elements, but all
// attributes should be listed first. Fail, if attribute encountered after
// element. Use feature to configure
children: String,
/// Whether need to write indent after the last written field
write_indent: bool,
}
impl<'w, 'k, W: Write> Struct<'w, 'k, W> {
#[inline]
fn write_field<T>(&mut self, key: &str, value: &T) -> Result<(), SeError>
where
T: ?Sized + Serialize,
{
//TODO: Customization point: allow user to determine if field is attribute or not
if let Some(key) = key.strip_prefix('@') {
let key = XmlName::try_from(key)?;
self.write_attribute(key, value)
} else {
self.write_element(key, value)
}
}
/// Writes `value` as an attribute
#[inline]
fn write_attribute<T>(&mut self, key: XmlName, value: &T) -> Result<(), SeError>
where
T: ?Sized + Serialize,
{
//TODO: Customization point: each attribute on new line
self.ser.ser.writer.write_char(' ')?;
self.ser.ser.writer.write_str(key.0)?;
self.ser.ser.writer.write_char('=')?;
//TODO: Customization point: preferred quote style
self.ser.ser.writer.write_char('"')?;
value.serialize(SimpleTypeSerializer {
writer: &mut self.ser.ser.writer,
target: QuoteTarget::DoubleQAttr,
level: self.ser.ser.level,
})?;
self.ser.ser.writer.write_char('"')?;
Ok(())
}
/// Writes `value` either as a text content, or as an element.
///
/// If `key` has a magic value [`TEXT_KEY`], then `value` serialized as a
/// [simple type].
///
/// If `key` has a magic value [`VALUE_KEY`], then `value` serialized as a
/// [content] without wrapping in tags, otherwise it is wrapped in
/// `<${key}>...</${key}>`.
///
/// [simple type]: SimpleTypeSerializer
/// [content]: ContentSerializer
fn write_element<T>(&mut self, key: &str, value: &T) -> Result<(), SeError>
where
T: ?Sized + Serialize,
{
let ser = ContentSerializer {
writer: &mut self.children,
level: self.ser.ser.level,
indent: self.ser.ser.indent.borrow(),
// If previous field does not require indent, do not write it
write_indent: self.write_indent,
allow_primitive: true,
expand_empty_elements: self.ser.ser.expand_empty_elements,
};
if key == TEXT_KEY {
value.serialize(TextSerializer(ser.into_simple_type_serializer()?))?;
// Text was written so we don't need to indent next field
self.write_indent = false;
} else if key == VALUE_KEY {
// If element was written then we need to indent next field unless it is a text field
self.write_indent = value.serialize(ser)?.allow_indent();
} else {
value.serialize(ElementSerializer {
key: XmlName::try_from(key)?,
ser,
})?;
// Element was written so we need to indent next field unless it is a text field
self.write_indent = true;
}
Ok(())
}
}
impl<'w, 'k, W: Write> SerializeStruct for Struct<'w, 'k, W> {
type Ok = WriteResult;
type Error = SeError;
fn serialize_field<T>(&mut self, key: &'static str, value: &T) -> Result<(), Self::Error>
where
T: ?Sized + Serialize,
{
self.write_field(key, value)
}
fn end(mut self) -> Result<Self::Ok, Self::Error> {
self.ser.ser.indent.decrease();
if self.children.is_empty() {
if self.ser.ser.expand_empty_elements {
self.ser.ser.writer.write_str("></")?;
self.ser.ser.writer.write_str(self.ser.key.0)?;
self.ser.ser.writer.write_char('>')?;
} else {
self.ser.ser.writer.write_str("/>")?;
}
} else {
self.ser.ser.writer.write_char('>')?;
self.ser.ser.writer.write_str(&self.children)?;
if self.write_indent {
self.ser.ser.indent.write_indent(&mut self.ser.ser.writer)?;
}
self.ser.ser.writer.write_str("</")?;
self.ser.ser.writer.write_str(self.ser.key.0)?;
self.ser.ser.writer.write_char('>')?;
}
Ok(WriteResult::Element)
}
}
impl<'w, 'k, W: Write> SerializeStructVariant for Struct<'w, 'k, W> {
type Ok = WriteResult;
type Error = SeError;
#[inline]
fn serialize_field<T>(&mut self, key: &'static str, value: &T) -> Result<(), Self::Error>
where
T: ?Sized + Serialize,
{
SerializeStruct::serialize_field(self, key, value)
}
#[inline]
fn end(self) -> Result<Self::Ok, Self::Error> {
SerializeStruct::end(self)
}
}
////////////////////////////////////////////////////////////////////////////////////////////////////
pub struct Map<'w, 'k, W: Write> {
ser: Struct<'w, 'k, W>,
/// Key, serialized by `QNameSerializer` if consumer uses `serialize_key` +
/// `serialize_value` calls instead of `serialize_entry`
key: Option<String>,
}
impl<'w, 'k, W: Write> Map<'w, 'k, W> {
fn make_key<T>(&mut self, key: &T) -> Result<String, SeError>
where
T: ?Sized + Serialize,
{
key.serialize(QNameSerializer {
writer: String::new(),
})
}
}
impl<'w, 'k, W: Write> SerializeMap for Map<'w, 'k, W> {
type Ok = WriteResult;
type Error = SeError;
fn serialize_key<T>(&mut self, key: &T) -> Result<(), Self::Error>
where
T: ?Sized + Serialize,
{
if let Some(_) = self.key.take() {
return Err(SeError::Custom(
"calling `serialize_key` twice without `serialize_value`".to_string(),
));
}
self.key = Some(self.make_key(key)?);
Ok(())
}
fn serialize_value<T>(&mut self, value: &T) -> Result<(), Self::Error>
where
T: ?Sized + Serialize,
{
if let Some(key) = self.key.take() {
return self.ser.write_field(&key, value);
}
Err(SeError::Custom(
"calling `serialize_value` without call of `serialize_key`".to_string(),
))
}
fn serialize_entry<K, V>(&mut self, key: &K, value: &V) -> Result<(), Self::Error>
where
K: ?Sized + Serialize,
V: ?Sized + Serialize,
{
let key = self.make_key(key)?;
self.ser.write_field(&key, value)
}
fn end(mut self) -> Result<Self::Ok, Self::Error> {
if let Some(key) = self.key.take() {
return Err(SeError::Custom(format!(
"calling `end` without call of `serialize_value` for key `{key}`"
)));
}
SerializeStruct::end(self.ser)
}
}
////////////////////////////////////////////////////////////////////////////////////////////////////
#[cfg(test)]
mod tests {
use super::*;
use crate::se::content::tests::*;
use crate::se::{Indent, QuoteLevel};
use crate::utils::Bytes;
use serde::Serialize;
use std::collections::BTreeMap;
#[derive(Debug, Serialize, PartialEq)]
struct OptionalElements {
a: Option<&'static str>,
#[serde(skip_serializing_if = "Option::is_none")]
b: Option<&'static str>,
}
#[derive(Debug, Serialize, PartialEq)]
struct OptionalAttributes {
#[serde(rename = "@a")]
a: Option<&'static str>,
#[serde(rename = "@b")]
#[serde(skip_serializing_if = "Option::is_none")]
b: Option<&'static str>,
}
mod without_indent {
use super::*;
use crate::se::content::tests::Struct;
use pretty_assertions::assert_eq;
/// Checks that given `$data` successfully serialized as `$expected`
macro_rules! serialize_as {
($name:ident: $data:expr => $expected:expr) => {
#[test]
fn $name() {
let mut buffer = String::new();
let ser = ElementSerializer {
ser: ContentSerializer {
writer: &mut buffer,
level: QuoteLevel::Full,
indent: Indent::None,
write_indent: false,
allow_primitive: true,
expand_empty_elements: false,
},
key: XmlName("root"),
};
let result = $data.serialize(ser).unwrap();
assert_eq!(buffer, $expected);
assert_eq!(result, WriteResult::Element);
}
};
}
/// Checks that attempt to serialize given `$data` results to a
/// serialization error `$kind` with `$reason`
macro_rules! err {
($name:ident: $data:expr => $kind:ident($reason:literal)) => {
#[test]
fn $name() {
let mut buffer = String::new();
let ser = ElementSerializer {
ser: ContentSerializer {
writer: &mut buffer,
level: QuoteLevel::Full,
indent: Indent::None,
write_indent: false,
allow_primitive: true,
expand_empty_elements: false,
},
key: XmlName("root"),
};
match $data.serialize(ser).unwrap_err() {
SeError::$kind(e) => assert_eq!(e, $reason),
e => panic!(
"Expected `Err({}({}))`, but got `{:?}`",
stringify!($kind),
$reason,
e
),
}
// We can write something before fail
// assert_eq!(buffer, "");
}
};
}
serialize_as!(false_: false => "<root>false</root>");
serialize_as!(true_: true => "<root>true</root>");
serialize_as!(i8_: -42i8 => "<root>-42</root>");
serialize_as!(i16_: -4200i16 => "<root>-4200</root>");
serialize_as!(i32_: -42000000i32 => "<root>-42000000</root>");
serialize_as!(i64_: -42000000000000i64 => "<root>-42000000000000</root>");
serialize_as!(isize_: -42000000000000isize => "<root>-42000000000000</root>");
serialize_as!(u8_: 42u8 => "<root>42</root>");
serialize_as!(u16_: 4200u16 => "<root>4200</root>");
serialize_as!(u32_: 42000000u32 => "<root>42000000</root>");
serialize_as!(u64_: 42000000000000u64 => "<root>42000000000000</root>");
serialize_as!(usize_: 42000000000000usize => "<root>42000000000000</root>");
serde_if_integer128! {
serialize_as!(i128_: -420000000000000000000000000000i128 => "<root>-420000000000000000000000000000</root>");
serialize_as!(u128_: 420000000000000000000000000000u128 => "<root>420000000000000000000000000000</root>");
}
serialize_as!(f32_: 4.2f32 => "<root>4.2</root>");
serialize_as!(f64_: 4.2f64 => "<root>4.2</root>");
serialize_as!(char_non_escaped: 'h' => "<root>h</root>");
serialize_as!(char_lt: '<' => "<root><</root>");
serialize_as!(char_gt: '>' => "<root>></root>");
serialize_as!(char_amp: '&' => "<root>&</root>");
serialize_as!(char_apos: '\'' => "<root>'</root>");
serialize_as!(char_quot: '"' => "<root>"</root>");
serialize_as!(str_non_escaped: "non-escaped string" => "<root>non-escaped string</root>");
serialize_as!(str_escaped: "<\"escaped & string'>" => "<root><"escaped & string'></root>");
err!(bytes: Bytes(b"<\"escaped & bytes'>") => Unsupported("`serialize_bytes` not supported yet"));
serialize_as!(option_none: Option::<&str>::None => "<root/>");
serialize_as!(option_some: Some("non-escaped string") => "<root>non-escaped string</root>");
serialize_as!(option_some_empty_str: Some("") => "<root/>");
serialize_as!(unit: () => "<root/>");
serialize_as!(unit_struct: Unit => "<root/>");
serialize_as!(unit_struct_escaped: UnitEscaped => "<root/>");
serialize_as!(enum_unit: Enum::Unit => "<root>Unit</root>");
serialize_as!(enum_unit_escaped: Enum::UnitEscaped => "<root><"&'></root>");
serialize_as!(newtype: Newtype(42) => "<root>42</root>");
err!(enum_newtype: Enum::Newtype(42)
=> Unsupported("cannot serialize enum newtype variant `Enum::Newtype`"));
serialize_as!(seq: vec![1, 2, 3]
=> "<root>1</root>\
<root>2</root>\
<root>3</root>");
serialize_as!(seq_empty: Vec::<usize>::new() => "");
serialize_as!(tuple: ("<\"&'>", "with\t\n\r spaces", 3usize)
=> "<root><"&'></root>\
<root>with\t\n\r spaces</root>\
<root>3</root>");
serialize_as!(tuple_struct: Tuple("first", 42)
=> "<root>first</root>\
<root>42</root>");
err!(enum_tuple: Enum::Tuple("first", 42)
=> Unsupported("cannot serialize enum tuple variant `Enum::Tuple`"));
serialize_as!(map: BTreeMap::from([("_1", 2), ("_3", 4)])
=> "<root>\
<_1>2</_1>\
<_3>4</_3>\
</root>");
serialize_as!(struct_: Struct { key: "answer", val: (42, 42) }
=> "<root>\
<key>answer</key>\
<val>42</val>\
<val>42</val>\
</root>");
err!(enum_struct: Enum::Struct { key: "answer", val: (42, 42) }
=> Unsupported("cannot serialize enum struct variant `Enum::Struct`"));
/// Special field name `$text` should be serialized as text content.
/// Sequences serialized as an `xs:list` content
mod text_field {
use super::*;
/// `$text` key in a map
mod map {
use super::*;
use pretty_assertions::assert_eq;
macro_rules! text {
($name:ident: $data:expr) => {
serialize_as!($name:
BTreeMap::from([("$text", $data)])
=> "<root/>");
};
($name:ident: $data:expr => $expected:literal) => {
serialize_as!($name:
BTreeMap::from([("$text", $data)])
=> concat!("<root>", $expected,"</root>"));
};
}
text!(false_: false => "false");
text!(true_: true => "true");
text!(i8_: -42i8 => "-42");
text!(i16_: -4200i16 => "-4200");
text!(i32_: -42000000i32 => "-42000000");
text!(i64_: -42000000000000i64 => "-42000000000000");
text!(isize_: -42000000000000isize => "-42000000000000");
text!(u8_: 42u8 => "42");
text!(u16_: 4200u16 => "4200");
text!(u32_: 42000000u32 => "42000000");
text!(u64_: 42000000000000u64 => "42000000000000");
text!(usize_: 42000000000000usize => "42000000000000");
serde_if_integer128! {
text!(i128_: -420000000000000000000000000000i128 => "-420000000000000000000000000000");
text!(u128_: 420000000000000000000000000000u128 => "420000000000000000000000000000");
}
text!(f32_: 4.2f32 => "4.2");
text!(f64_: 4.2f64 => "4.2");
text!(char_non_escaped: 'h' => "h");
text!(char_lt: '<' => "<");
text!(char_gt: '>' => ">");
text!(char_amp: '&' => "&");
text!(char_apos: '\'' => "'");
text!(char_quot: '"' => """);
text!(char_space: ' ' => " ");
text!(str_non_escaped: "non-escaped string" => "non-escaped string");
text!(str_escaped: "<\"escaped & string'>" => "<"escaped & string'>");
err!(bytes:
Text {
before: "answer",
content: Bytes(b"<\"escaped & bytes'>"),
after: "answer",
}
=> Unsupported("`serialize_bytes` not supported yet"));
text!(option_none: Option::<&str>::None);
text!(option_some: Some("non-escaped string") => "non-escaped string");
text!(option_some_empty_str: Some(""));
text!(unit: ());
text!(unit_struct: Unit);
text!(unit_struct_escaped: UnitEscaped);
text!(enum_unit: Enum::Unit => "Unit");
text!(enum_unit_escaped: Enum::UnitEscaped => "<"&'>");
text!(newtype: Newtype(42) => "42");
// We have no space where name of a variant can be stored
err!(enum_newtype:
Text {
before: "answer",
content: Enum::Newtype(42),
after: "answer",
}
=> Unsupported("cannot serialize enum newtype variant `Enum::Newtype` as text content value"));
// Sequences are serialized separated by spaces, all spaces inside are escaped
text!(seq: vec![1, 2, 3] => "1 2 3");
text!(seq_empty: Vec::<usize>::new());
text!(tuple: ("<\"&'>", "with\t\n\r spaces", 3usize)
=> "<"&'> \
with	  spaces \
3");
text!(tuple_struct: Tuple("first", 42) => "first 42");
// We have no space where name of a variant can be stored
err!(enum_tuple:
Text {
before: "answer",
content: Enum::Tuple("first", 42),
after: "answer",
}
=> Unsupported("cannot serialize enum tuple variant `Enum::Tuple` as text content value"));
// Complex types cannot be serialized in `$text` field
err!(map:
Text {
before: "answer",
content: BTreeMap::from([("_1", 2), ("_3", 4)]),
after: "answer",
}
=> Unsupported("cannot serialize map as text content value"));
err!(struct_:
Text {
before: "answer",
content: Struct { key: "answer", val: (42, 42) },
after: "answer",
}
=> Unsupported("cannot serialize struct `Struct` as text content value"));
err!(enum_struct:
Text {
before: "answer",
content: Enum::Struct { key: "answer", val: (42, 42) },
after: "answer",
}
=> Unsupported("cannot serialize enum struct variant `Enum::Struct` as text content value"));
}
/// `$text` field inside a struct
mod struct_ {
use super::*;
use pretty_assertions::assert_eq;
macro_rules! text {
($name:ident: $data:expr => $expected:literal) => {
serialize_as!($name:
Text {
before: "answer",
content: $data,
after: "answer",
}
=> concat!(
"<root><before>answer</before>",
$expected,
"<after>answer</after></root>",
));
};
}
text!(false_: false => "false");
text!(true_: true => "true");
text!(i8_: -42i8 => "-42");
text!(i16_: -4200i16 => "-4200");
text!(i32_: -42000000i32 => "-42000000");
text!(i64_: -42000000000000i64 => "-42000000000000");
text!(isize_: -42000000000000isize => "-42000000000000");
text!(u8_: 42u8 => "42");
text!(u16_: 4200u16 => "4200");
text!(u32_: 42000000u32 => "42000000");
text!(u64_: 42000000000000u64 => "42000000000000");
text!(usize_: 42000000000000usize => "42000000000000");
serde_if_integer128! {
text!(i128_: -420000000000000000000000000000i128 => "-420000000000000000000000000000");
text!(u128_: 420000000000000000000000000000u128 => "420000000000000000000000000000");
}
text!(f32_: 4.2f32 => "4.2");
text!(f64_: 4.2f64 => "4.2");
text!(char_non_escaped: 'h' => "h");
text!(char_lt: '<' => "<");
text!(char_gt: '>' => ">");
text!(char_amp: '&' => "&");
text!(char_apos: '\'' => "'");
text!(char_quot: '"' => """);
text!(char_space: ' ' => " ");
text!(str_non_escaped: "non-escaped string" => "non-escaped string");
text!(str_escaped: "<\"escaped & string'>" => "<"escaped & string'>");
err!(bytes:
Text {
before: "answer",
content: Bytes(b"<\"escaped & bytes'>"),
after: "answer",
}
=> Unsupported("`serialize_bytes` not supported yet"));
text!(option_none: Option::<&str>::None => "");
text!(option_some: Some("non-escaped string") => "non-escaped string");
text!(option_some_empty_str: Some("") => "");
text!(unit: () => "");
text!(unit_struct: Unit => "");
text!(unit_struct_escaped: UnitEscaped => "");
text!(enum_unit: Enum::Unit => "Unit");
text!(enum_unit_escaped: Enum::UnitEscaped => "<"&'>");
text!(newtype: Newtype(42) => "42");
// We have no space where name of a variant can be stored
err!(enum_newtype:
Text {
before: "answer",
content: Enum::Newtype(42),
after: "answer",
}
=> Unsupported("cannot serialize enum newtype variant `Enum::Newtype` as text content value"));
// Sequences are serialized separated by spaces, all spaces inside are escaped
text!(seq: vec![1, 2, 3] => "1 2 3");
text!(seq_empty: Vec::<usize>::new() => "");
text!(tuple: ("<\"&'>", "with\t\n\r spaces", 3usize)
=> "<"&'> \
with	  spaces \
3");
text!(tuple_struct: Tuple("first", 42) => "first 42");
// We have no space where name of a variant can be stored
err!(enum_tuple:
Text {
before: "answer",
content: Enum::Tuple("first", 42),
after: "answer",
}
=> Unsupported("cannot serialize enum tuple variant `Enum::Tuple` as text content value"));
// Complex types cannot be serialized in `$text` field
err!(map:
Text {
before: "answer",
content: BTreeMap::from([("_1", 2), ("_3", 4)]),
after: "answer",
}
=> Unsupported("cannot serialize map as text content value"));
err!(struct_: