strict-yaml-rust 0.2.0

A StrictYAML parser obtained by savagely chopping up the original yaml-rust crate.
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
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
use crate::{
    parser::{Event, Parser},
    serde::error::Error,
    strict_yaml::StrictYaml,
};
use serde::de::{
    Deserialize, DeserializeSeed, EnumAccess, Error as SerdeError, IntoDeserializer, MapAccess,
    SeqAccess, Unexpected, VariantAccess, Visitor,
};
use std::str::{Chars, FromStr};

/// Deserialize an instance of type `T` from [`StrictYaml`](enum@crate::StrictYaml).
///
/// ```
/// use strict_yaml_rust::{StrictYaml, serde::from_strict_yaml};
///
/// let yaml = StrictYaml::Array(
///     vec![
///         StrictYaml::String("1".into()),
///         StrictYaml::String("2".into()),
///         StrictYaml::String("3".into())
///     ]
/// );
///
/// assert_eq!(vec![1, 2, 3], from_strict_yaml::<Vec<u16>>(yaml).unwrap());
/// ```
pub fn from_strict_yaml<'a, T>(yaml: StrictYaml) -> Result<T, Error>
where
    T: Deserialize<'a>,
{
    T::deserialize(yaml)
}

/// A deserializer for the StrictYAML document format.
pub struct Deserializer<'de> {
    parser: Parser<Chars<'de>>,
    // This is used to toggle and keep track of multi-document
    // deserialization. This is only relevant when deserializing a
    // sequence because only sequence types can be deserialized
    // from a StrictYAML stream containing multiple documents.
    is_root: Option<bool>,
}

impl<'de> Deserializer<'de> {
    fn new(input: &'de str, is_root: Option<bool>) -> Self {
        Deserializer {
            parser: Parser::new(input.chars()),
            is_root,
        }
    }

    /// See [`from_str_many`](function@crate::serde::from_str_many) for usage
    /// examples.
    pub fn from_str_many(input: &'de str) -> Self {
        Deserializer::new(input, Some(false))
    }

    /// See [`from_str`](function@crate::serde::from_str) for usage examples.
    pub fn from_str(input: &'de str) -> Self {
        Deserializer::new(input, None)
    }
}

/// Deserialize multiple StrictYAML documents from the same stream into an
/// instance of a container `T`.
///
/// The function serves as a hint to the deserializer to expect a
/// multi-document StrictYAML stream and process it accordingly. The hint from
/// the user is necessary because StrictYAML is not self-describing to the extent
/// that JSON is when it comes to mapping StrictYaml to the `serde` data model.
/// The deserializer needs a way to tell the difference between the
/// following cases when it calls [`serde::Deserializer::deserialize_seq`]:
///
/// ```yaml
/// ---
/// some: example
/// data: 100
/// ---
/// some: example
/// data: 200
/// ---
/// some: example
/// data: 300
/// ```
///
/// ```yaml
/// ---
/// - some: example
///   data: 100
/// - some: example
///   data: 200
/// - some: example
///   data: 300
/// ```
///
/// [`from_str_many`] handles the former case while the latter is the "default
/// mode" when calling [`from_str`].
///
/// # Examples
///
/// As described above the [`from_str_many`] function deserializes a YAML stream containing
/// multiple documents to a container data structure that implements
/// [`serde::Deserialize`] (such as [`Vec`] or [`VecDeque`](struct@std::collections::VecDeque)).
///
///
/// ```rust
/// use strict_yaml_rust::serde::from_str_many;
/// use serde::Deserialize;
///
/// #[derive(Deserialize)]
/// struct Deployment {
///     kind: String,
///     spec: Spec
/// }
///
/// #[derive(Deserialize)]
/// struct Spec {
///     replicas: u16,
///     name: String
/// }
///
/// let yaml = r#"
/// ---
/// kind: deployment
/// spec:
///   replicas: 5
///   name: "nginx"
/// ---
/// kind: container
/// spec:
///   replicas: 1
///   name: "redis"
/// ---
/// kind: deployment
/// spec:
///   replicas: 3
///   name: "webapp"
/// ...
/// "#;
///
/// let deployments: Vec<Deployment> = from_str_many(yaml).unwrap();
///
/// assert!(deployments.len() == 3);
/// assert!(deployments.first().is_some_and(|d| d.spec.name == "nginx".to_string()));
/// ```
pub fn from_str_many<'a, T>(s: &'a str) -> Result<T, Error>
where
    T: Deserialize<'a>,
{
    let mut deserializer = Deserializer::from_str_many(s);

    // Unlike `from_str` this function skips matching the first
    // events (`StreamStart` and `DocumentStart`) as well as their
    // respective ends, because in this case handling multi-document
    // deserialization is shifted to the `deserialize_seq` method instead.

    T::deserialize(&mut deserializer)
}

/// Deserialize an instance of type `T` from a StrictYAML document.
///
/// # Examples
///
/// The [`from_str`] function deserializes a data structure that
/// implements [`serde::Deserialize`] from a StrictYAML document.
///
/// ```rust
/// use strict_yaml_rust::serde::from_str;
/// use serde::Deserialize;
///
/// #[derive(Deserialize)]
/// struct Deployment {
///     kind: String,
///     spec: Spec
/// }
///
/// #[derive(Deserialize)]
/// struct Spec {
///     replicas: u16,
///     name: String
/// }
///
/// let yaml = r#"
/// ---
/// kind: deployment
/// spec:
///   replicas: 5
///   name: nginx
/// ...
/// "#;
///
/// let deployment: Deployment = from_str(yaml).unwrap();
///
/// assert_eq!(deployment.spec.name, "nginx".to_string());
/// ```
pub fn from_str<'a, T>(s: &'a str) -> Result<T, Error>
where
    T: Deserialize<'a>,
{
    let mut deserializer = Deserializer::from_str(s);

    // This function expects only a single document inside a
    // stream. Thus it tries to match the expected end events
    // from the loader after deserializing the data "in between".

    let (ev, mark) = deserializer.parser.next()?;

    if ev != Event::StreamStart {
        return Err(Error::from_event(ev, mark, "the start of the stream"));
    }

    let (ev, _mark) = deserializer.parser.peek()?;

    if *ev == Event::DocumentStart {
        deserializer.parser.next()?;
    }

    let res = T::deserialize(&mut deserializer)?;

    let (ev, _mark) = deserializer.parser.peek()?;

    if *ev == Event::DocumentEnd {
        deserializer.parser.next()?;
    }

    let (ev, mark) = deserializer.parser.next()?;

    if ev != Event::StreamEnd {
        return Err(Error::from_event(ev, mark, "the end of the stream"));
    }

    Ok(res)
}

impl<'de> serde::de::Deserializer<'de> for &mut Deserializer<'de> {
    type Error = Error;

    /// This is only called by custom visitor implementations when
    /// the target type does not neatly fit into the serde data model.
    ///
    /// The `StrictYaml` enum type calls into this method to deserialize
    /// efficiently by passing a custom visitor, since we know how
    /// the serde data model types fit into the different variants.
    fn deserialize_any<V>(self, visitor: V) -> Result<V::Value, Error>
    where
        V: Visitor<'de>,
    {
        let (ev, mark) = self.parser.peek()?;

        match ev {
            Event::Scalar(_, _, _) => self.deserialize_str(visitor),
            Event::SequenceStart(_) => self.deserialize_seq(visitor),
            Event::MappingStart(_) => self.deserialize_map(visitor),
            _ => {
                return Err(Error::from_event(
                    ev.clone(),
                    mark.clone(),
                    "a sequence, map or scalar",
                ))
            }
        }
    }

    fn deserialize_bool<V>(self, visitor: V) -> Result<V::Value, Error>
    where
        V: Visitor<'de>,
    {
        let (ev, mark) = self.parser.next()?;

        match ev {
            Event::Scalar(value, _style, _anchor_id) => {
                let boolean = bool::from_str(&value)
                    .map_err(|_| Error::invalid_value(Unexpected::Str(&value), &"a boolean"))
                    .map_err(|err| err + mark)?;

                visitor.visit_bool(boolean).map_err(|err: Error| err + mark)
            }
            _ => Err(Error::from_event(ev, mark, "a scalar")),
        }
    }

    fn deserialize_i8<V>(self, visitor: V) -> Result<V::Value, Error>
    where
        V: Visitor<'de>,
    {
        let (ev, mark) = self.parser.next()?;

        match ev {
            Event::Scalar(value, _style, _anchor_id) => {
                let num = i8::from_str_radix(&value, 10)
                    .map_err(|_| {
                        Error::invalid_value(Unexpected::Str(&value), &"an 8-bit signed integer")
                    })
                    .map_err(|err| err + mark)?;

                visitor.visit_i8(num).map_err(|err: Error| err + mark)
            }
            _ => Err(Error::from_event(ev, mark, "a scalar")),
        }
    }

    fn deserialize_i16<V>(self, visitor: V) -> Result<V::Value, Error>
    where
        V: Visitor<'de>,
    {
        let (ev, mark) = self.parser.next()?;

        match ev {
            Event::Scalar(value, _style, _anchor_id) => {
                let num = i16::from_str_radix(&value, 10)
                    .map_err(|_| {
                        Error::invalid_value(Unexpected::Str(&value), &"a 16-bit signed integer")
                    })
                    .map_err(|err| err + mark)?;

                visitor.visit_i16(num).map_err(|err: Error| err + mark)
            }
            _ => Err(Error::from_event(ev, mark, "a scalar")),
        }
    }

    fn deserialize_i32<V>(self, visitor: V) -> Result<V::Value, Error>
    where
        V: Visitor<'de>,
    {
        let (ev, mark) = self.parser.next()?;

        match ev {
            Event::Scalar(value, _style, _anchor_id) => {
                let num = i32::from_str_radix(&value, 10)
                    .map_err(|_| {
                        Error::invalid_value(Unexpected::Str(&value), &"a 32-bit signed integer")
                    })
                    .map_err(|err| err + mark)?;

                visitor.visit_i32(num).map_err(|err: Error| err + mark)
            }
            _ => Err(Error::from_event(ev, mark, "a scalar")),
        }
    }

    fn deserialize_i64<V>(self, visitor: V) -> Result<V::Value, Error>
    where
        V: Visitor<'de>,
    {
        let (ev, mark) = self.parser.next()?;

        match ev {
            Event::Scalar(value, _style, _anchor_id) => {
                let num = i64::from_str_radix(&value, 10)
                    .map_err(|_| {
                        Error::invalid_value(Unexpected::Str(&value), &"a 64-bit signed integer")
                    })
                    .map_err(|err| err + mark)?;

                visitor.visit_i64(num).map_err(|err: Error| err + mark)
            }
            _ => Err(Error::from_event(ev, mark, "a scalar")),
        }
    }

    fn deserialize_i128<V>(self, visitor: V) -> Result<V::Value, Error>
    where
        V: Visitor<'de>,
    {
        let (ev, mark) = self.parser.next()?;

        match ev {
            Event::Scalar(value, _style, _anchor_id) => {
                let num = i128::from_str_radix(&value, 10)
                    .map_err(|_| {
                        Error::invalid_value(Unexpected::Str(&value), &"an 128-bit signed integer")
                    })
                    .map_err(|err| err + mark)?;

                visitor.visit_i128(num).map_err(|err: Error| err + mark)
            }
            _ => Err(Error::from_event(ev, mark, "a scalar")),
        }
    }

    fn deserialize_u8<V>(self, visitor: V) -> Result<V::Value, Error>
    where
        V: Visitor<'de>,
    {
        let (ev, mark) = self.parser.next()?;

        match ev {
            Event::Scalar(value, _style, _anchor_id) => {
                let num = u8::from_str_radix(&value, 10)
                    .map_err(|_| {
                        Error::invalid_value(Unexpected::Str(&value), &"an 8-bit unsigned integer")
                    })
                    .map_err(|err| err + mark)?;

                visitor.visit_u8(num).map_err(|err: Error| err + mark)
            }
            _ => Err(Error::from_event(ev, mark, "a scalar")),
        }
    }

    fn deserialize_u16<V>(self, visitor: V) -> Result<V::Value, Error>
    where
        V: Visitor<'de>,
    {
        let (ev, mark) = self.parser.next()?;

        match ev {
            Event::Scalar(value, _style, _anchor_id) => {
                let num = u16::from_str_radix(&value, 10)
                    .map_err(|_| {
                        Error::invalid_value(Unexpected::Str(&value), &"a 16-bit unsigned integer")
                    })
                    .map_err(|err| err + mark)?;

                visitor.visit_u16(num).map_err(|err: Error| err + mark)
            }
            _ => Err(Error::from_event(ev, mark, "a scalar")),
        }
    }

    fn deserialize_u32<V>(self, visitor: V) -> Result<V::Value, Error>
    where
        V: Visitor<'de>,
    {
        let (ev, mark) = self.parser.next()?;

        match ev {
            Event::Scalar(value, _style, _anchor_id) => {
                let num = u32::from_str_radix(&value, 10)
                    .map_err(|_| {
                        Error::invalid_value(Unexpected::Str(&value), &"a 32-bit unsigned integer")
                    })
                    .map_err(|err| err + mark)?;

                visitor.visit_u32(num).map_err(|err: Error| err + mark)
            }
            _ => Err(Error::from_event(ev, mark, "a scalar")),
        }
    }

    fn deserialize_u64<V>(self, visitor: V) -> Result<V::Value, Error>
    where
        V: Visitor<'de>,
    {
        let (ev, mark) = self.parser.next()?;

        match ev {
            Event::Scalar(value, _style, _anchor_id) => {
                let num = u64::from_str_radix(&value, 10)
                    .map_err(|_| {
                        Error::invalid_value(Unexpected::Str(&value), &"a 64-bit unsigned integer")
                    })
                    .map_err(|err| err + mark)?;

                visitor.visit_u64(num).map_err(|err: Error| err + mark)
            }
            _ => Err(Error::from_event(ev, mark, "a scalar")),
        }
    }

    fn deserialize_u128<V>(self, visitor: V) -> Result<V::Value, Error>
    where
        V: Visitor<'de>,
    {
        let (ev, mark) = self.parser.next()?;

        match ev {
            Event::Scalar(value, _style, _anchor_id) => {
                let num = u128::from_str_radix(&value, 10)
                    .map_err(|_| {
                        Error::invalid_value(
                            Unexpected::Str(&value),
                            &"an 128-bit unsigned integer",
                        )
                    })
                    .map_err(|err| err + mark)?;

                visitor.visit_u128(num).map_err(|err: Error| err + mark)
            }
            _ => Err(Error::from_event(ev, mark, "a scalar")),
        }
    }

    fn deserialize_f32<V>(self, visitor: V) -> Result<V::Value, Error>
    where
        V: Visitor<'de>,
    {
        let (ev, mark) = self.parser.next()?;

        match ev {
            Event::Scalar(value, _style, _anchor_id) => {
                let num = f32::from_str(&value)
                    .map_err(|_| {
                        Error::invalid_value(
                            Unexpected::Str(&value),
                            &"a 32-bit floating point number",
                        )
                    })
                    .map_err(|err| err + mark)?;

                visitor.visit_f32(num).map_err(|err: Error| err + mark)
            }
            _ => Err(Error::from_event(ev, mark, "a scalar")),
        }
    }

    fn deserialize_f64<V>(self, visitor: V) -> Result<V::Value, Error>
    where
        V: Visitor<'de>,
    {
        let (ev, mark) = self.parser.next()?;

        match ev {
            Event::Scalar(value, _style, _anchor_id) => {
                let num = f64::from_str(&value)
                    .map_err(|_| {
                        Error::invalid_value(
                            Unexpected::Str(&value),
                            &"a 64-bit floating point number",
                        )
                    })
                    .map_err(|err| err + mark)?;

                visitor.visit_f64(num).map_err(|err: Error| err + mark)
            }
            _ => Err(Error::from_event(ev, mark, "a scalar")),
        }
    }

    fn deserialize_char<V>(self, visitor: V) -> Result<V::Value, Error>
    where
        V: Visitor<'de>,
    {
        let (ev, mark) = self.parser.next()?;

        match ev {
            Event::Scalar(value, _style, _anchor_id) => {
                let c = char::from_str(&value)
                    .map_err(|_| {
                        Error::invalid_value(Unexpected::Str(&value), &"a single character")
                    })
                    .map_err(|err| err + mark)?;

                visitor.visit_char(c).map_err(|err: Error| err + mark)
            }
            _ => Err(Error::from_event(ev, mark, "a scalar")),
        }
    }

    fn deserialize_str<V>(self, visitor: V) -> Result<V::Value, Error>
    where
        V: Visitor<'de>,
    {
        let (ev, mark) = self.parser.next()?;

        match ev {
            Event::Scalar(value, _style, _anchor_id) => {
                visitor.visit_string(value).map_err(|err: Error| err + mark)
            }
            _ => Err(Error::from_event(ev, mark, "a scalar")),
        }
    }

    fn deserialize_string<V>(self, visitor: V) -> Result<V::Value, Error>
    where
        V: Visitor<'de>,
    {
        self.deserialize_str(visitor)
    }

    fn deserialize_bytes<V>(self, _visitor: V) -> Result<V::Value, Error>
    where
        V: Visitor<'de>,
    {
        Err(Error::UnsupportedType("bytes"))
    }

    fn deserialize_byte_buf<V>(self, visitor: V) -> Result<V::Value, Error>
    where
        V: Visitor<'de>,
    {
        self.deserialize_bytes(visitor)
    }

    fn deserialize_option<V>(self, visitor: V) -> Result<V::Value, Error>
    where
        V: Visitor<'de>,
    {
        let (ev, _mark) = self.parser.peek()?;

        let is_some = match ev {
            Event::MappingStart(_) | Event::SequenceStart(_) | Event::Scalar(_, _, _) => true,
            _ => false,
        };

        if is_some {
            visitor.visit_some(self)
        } else {
            visitor.visit_none()
        }
    }

    /// Allow deserializing the unit type from empty scalars.
    fn deserialize_unit<V>(self, visitor: V) -> Result<V::Value, Error>
    where
        V: Visitor<'de>,
    {
        let (ev, _mark) = self.parser.peek()?;

        if matches!(ev, Event::Scalar(value, _style, _anchor_id) if value.is_empty()) {
            let _ = self.parser.next()?;
        }

        visitor.visit_unit()
    }

    fn deserialize_unit_struct<V>(self, _name: &'static str, visitor: V) -> Result<V::Value, Error>
    where
        V: Visitor<'de>,
    {
        self.deserialize_unit(visitor)
    }

    fn deserialize_newtype_struct<V>(
        self,
        _name: &'static str,
        visitor: V,
    ) -> Result<V::Value, Error>
    where
        V: Visitor<'de>,
    {
        visitor.visit_newtype_struct(self)
    }

    /// This method is somewhat special since it needs to handle
    /// two deserialization modes:
    /// - deserializing a regular StrictYAML array
    /// - deserializing a multi-document StrictYAML stream
    fn deserialize_seq<V>(self, visitor: V) -> Result<V::Value, Error>
    where
        V: Visitor<'de>,
    {
        // This is the expected value when multi-document deserialization
        // is requested, which is driven by the first call into `deserialize_seq`.
        if self.is_root == Some(false) {
            self.is_root = Some(true);
        }

        let (ev, mark) = self.parser.next()?;

        // Match the next event differently depending on the
        // toggled deserialization mode.
        // `ArrayAccess` is responsible for disabling this mode
        // for nested calls into `deserialize_seq` to avoid toggling
        // unintended behaviour.
        let value = match ev {
            Event::SequenceStart(_) => visitor
                .visit_seq(ArrayAccess::new(self))
                .map_err(|err: Error| err + mark)?,
            Event::StreamStart if self.is_root.is_some() => visitor
                .visit_seq(ArrayAccess::new(self))
                .map_err(|err: Error| err + mark)?,
            _ => {
                if self.is_root.is_some() {
                    return Err(Error::from_event(ev, mark, "the start of the stream"));
                } else {
                    return Err(Error::from_event(ev, mark, "the start of a sequence"));
                }
            }
        };

        if self.is_root == Some(true) {
            let (ev, mark) = self.parser.next()?;

            if ev != Event::StreamEnd {
                return Err(Error::from_event(ev, mark, "the end of the stream"));
            }
        } else {
            let (ev, mark) = self.parser.next()?;

            if ev != Event::SequenceEnd {
                return Err(Error::from_event(ev, mark, "the end of a sequence"));
            }
        }

        Ok(value)
    }

    fn deserialize_tuple<V>(self, _len: usize, visitor: V) -> Result<V::Value, Error>
    where
        V: Visitor<'de>,
    {
        self.deserialize_seq(visitor)
    }

    fn deserialize_tuple_struct<V>(
        self,
        _name: &'static str,
        _len: usize,
        visitor: V,
    ) -> Result<V::Value, Error>
    where
        V: Visitor<'de>,
    {
        self.deserialize_seq(visitor)
    }

    fn deserialize_map<V>(self, visitor: V) -> Result<V::Value, Error>
    where
        V: Visitor<'de>,
    {
        let (ev, mark) = self.parser.next()?;

        let value = match ev {
            Event::MappingStart(_) => visitor
                .visit_map(HashAccess::new(self))
                .map_err(|err: Error| err + mark)?,
            _ => return Err(Error::from_event(ev, mark, "the start of a mapping")),
        };

        let (ev, _mark) = self.parser.next()?;

        if ev != Event::MappingEnd {
            Err(Error::from_event(ev, mark, "the end of a mapping"))
        } else {
            Ok(value)
        }
    }

    fn deserialize_struct<V>(
        self,
        _name: &'static str,
        _fields: &'static [&'static str],
        visitor: V,
    ) -> Result<V::Value, Error>
    where
        V: Visitor<'de>,
    {
        self.deserialize_map(visitor)
    }

    fn deserialize_enum<V>(
        self,
        _name: &'static str,
        _variants: &'static [&'static str],
        visitor: V,
    ) -> Result<V::Value, Error>
    where
        V: Visitor<'de>,
    {
        let (ev, mark) = self.parser.next()?;

        match ev {
            Event::Scalar(value, _, _) => visitor
                .visit_enum(value.into_deserializer())
                .map_err(|err: Error| err + mark),
            _ => {
                let v = visitor
                    .visit_enum(Enum::new(self))
                    .map_err(|err: Error| err + mark)?;

                let (ev, mark) = self.parser.next()?;

                if ev != Event::MappingEnd {
                    Err(Error::from_event(ev, mark, "the end of a mapping"))
                } else {
                    Ok(v)
                }
            }
        }
    }

    fn deserialize_identifier<V>(self, visitor: V) -> Result<V::Value, Error>
    where
        V: Visitor<'de>,
    {
        self.deserialize_str(visitor)
    }

    fn deserialize_ignored_any<V>(self, visitor: V) -> Result<V::Value, Error>
    where
        V: Visitor<'de>,
    {
        self.deserialize_any(visitor)
    }
}

struct ArrayAccess<'a, 'de: 'a> {
    de: &'a mut Deserializer<'de>,
}

impl<'a, 'de> ArrayAccess<'a, 'de> {
    fn new(de: &'a mut Deserializer<'de>) -> Self {
        Self { de }
    }
}

impl<'de, 'a> SeqAccess<'de> for ArrayAccess<'a, 'de> {
    type Error = Error;

    fn next_element_seed<T>(&mut self, seed: T) -> Result<Option<T::Value>, Error>
    where
        T: DeserializeSeed<'de>,
    {
        let (ev, mark) = self.de.parser.peek()?;

        // When this instance of `ArrayAccess` is responsible for
        // deserializing multiple documents, it needs to temporarily
        // disable this "mode" for nested calls into `deserialize_*`
        // methods. Otherwise a nested `deserialize_seq` would inherit
        // this behaviour, but it needs to be scoped to the top-level
        // sequence.
        if self.de.is_root == Some(true) {
            let mut old_is_root = self.de.is_root.take();

            let res = match ev {
                Event::StreamEnd => Ok(None),
                Event::DocumentStart => {
                    let _ = self.de.parser.next()?;

                    let v = seed.deserialize(&mut *self.de).map(Some)?;

                    let (ev, _mark) = self.de.parser.peek()?;

                    if *ev == Event::DocumentEnd {
                        let _ = self.de.parser.next()?;
                    }

                    Ok(v)
                }
                _ => Err(Error::from_event(
                    ev.clone(),
                    *mark,
                    "the start of a document or the end of the stream",
                )),
            };

            // Reset to the old value. It does not need to be set to
            // `None`, although it would make no difference to process.
            self.de.is_root = old_is_root.take();

            Ok(res?)
        } else {
            match ev {
                Event::SequenceEnd => Ok(None),
                _ => seed.deserialize(&mut *self.de).map(Some),
            }
        }
    }
}

struct HashAccess<'a, 'de: 'a> {
    de: &'a mut Deserializer<'de>,
}

impl<'a, 'de> HashAccess<'a, 'de> {
    fn new(de: &'a mut Deserializer<'de>) -> Self {
        Self { de }
    }
}

impl<'de, 'a> MapAccess<'de> for HashAccess<'a, 'de> {
    type Error = Error;

    fn next_key_seed<T>(&mut self, seed: T) -> Result<Option<T::Value>, Error>
    where
        T: DeserializeSeed<'de>,
    {
        let (ev, _mark) = self.de.parser.peek()?;

        match ev {
            Event::MappingEnd => Ok(None),
            _ => seed.deserialize(&mut *self.de).map(Some),
        }
    }

    fn next_value_seed<T>(&mut self, seed: T) -> Result<T::Value, Error>
    where
        T: DeserializeSeed<'de>,
    {
        seed.deserialize(&mut *self.de)
    }
}

struct Enum<'a, 'de: 'a> {
    de: &'a mut Deserializer<'de>,
}

impl<'a, 'de> Enum<'a, 'de> {
    fn new(de: &'a mut Deserializer<'de>) -> Self {
        Self { de }
    }
}

impl<'de, 'a> EnumAccess<'de> for Enum<'a, 'de> {
    type Error = Error;
    type Variant = Self;

    fn variant_seed<V>(self, seed: V) -> Result<(V::Value, Self::Variant), Self::Error>
    where
        V: DeserializeSeed<'de>,
    {
        let v = seed.deserialize(&mut *self.de)?;
        Ok((v, self))
    }
}

impl<'de, 'a> VariantAccess<'de> for Enum<'a, 'de> {
    type Error = Error;

    fn unit_variant(self) -> Result<(), Self::Error> {
        Ok(())
    }

    fn newtype_variant_seed<T>(self, seed: T) -> Result<T::Value, Self::Error>
    where
        T: DeserializeSeed<'de>,
    {
        seed.deserialize(self.de)
    }

    fn tuple_variant<V>(self, _len: usize, visitor: V) -> Result<V::Value, Self::Error>
    where
        V: Visitor<'de>,
    {
        serde::de::Deserializer::deserialize_seq(self.de, visitor)
    }

    fn struct_variant<V>(
        self,
        _fields: &'static [&'static str],
        visitor: V,
    ) -> Result<V::Value, Self::Error>
    where
        V: Visitor<'de>,
    {
        serde::de::Deserializer::deserialize_map(self.de, visitor)
    }
}