annotated-derive 0.1.0

The derive macros of annotated; use them through the annotated 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
use proc_macro2::{Literal, Span, TokenStream, TokenTree};
use quote::{ToTokens, format_ident, quote, quote_spanned};
use syn::ext::IdentExt;
use syn::spanned::Spanned;
use syn::{DeriveInput, GenericParam, Generics, Ident, Lifetime, LifetimeParam, Type, parse_quote};

use crate::deserialized_struct::DeserializedStruct;
use crate::expansion::{Expansion, validity_of};
use crate::validated_struct::{ValidatedField, option_content};

pub fn deserialize_impl(deserialized_struct: &DeserializedStruct) -> TokenStream {
    DeserializeExpansion::new(deserialized_struct).deserialize_impl()
}

struct DeserializeExpansion<'a> {
    deserialized_struct: &'a DeserializedStruct<'a>,
    rules: Expansion,
    serde: TokenStream,
    deserializer: Ident,
    formatter: Ident,
    map: Ident,
    seq: Ident,
    key: Ident,
    deserialized: Ident,
    has_finished: Ident,
    visitor_lifetime: Lifetime,
    field_checks_label: Lifetime,
    struct_checks_label: Lifetime,
}

impl<'a> DeserializeExpansion<'a> {
    fn new(deserialized_struct: &'a DeserializedStruct<'a>) -> Self {
        let local = |name| Ident::new(name, Span::mixed_site());
        let field_checks_label = Lifetime::new("'field_checks", Span::mixed_site());
        let finishing_the_field_checks = quote!(break #field_checks_label true);
        Self {
            deserialized_struct,
            rules: Expansion::new(
                deserialized_struct.validated.is_reporting_all,
                finishing_the_field_checks,
            ),
            serde: quote!(::annotated::__private::serde),
            deserializer: local("deserializer"),
            formatter: local("formatter"),
            map: local("map"),
            seq: local("seq"),
            key: local("key"),
            deserialized: local("deserialized"),
            has_finished: local("has_finished"),
            visitor_lifetime: Lifetime::new("'__visitor", Span::call_site()),
            field_checks_label,
            struct_checks_label: Lifetime::new("'struct_checks", Span::mixed_site()),
        }
    }

    fn input(&self) -> &'a DeriveInput {
        self.deserialized_struct.validated.input
    }

    fn fields(&self) -> &'a [ValidatedField<'a>] {
        &self.deserialized_struct.validated.fields
    }

    fn deserialize_impl(&self) -> TokenStream {
        let Self {
            serde, deserializer, ..
        } = self;
        let Expansion { at, found, .. } = &self.rules;
        let input = self.input();
        let name = &input.ident;
        let generics = self.generics_reading_fields();
        let (impl_generics, _, where_clause) = generics.split_for_impl();
        let (_, type_generics, _) = input.generics.split_for_impl();
        let turbofish = type_generics.as_turbofish();
        let struct_name = &self.deserialized_struct.serde.name;
        let field_identifier = self.field_identifier();
        let visitor = self.visitor();
        quote! {
            impl #impl_generics ::annotated::Deserialize<'de> for #name #type_generics #where_clause {
                fn deserialize_at<__D: #serde::Deserializer<'de>>(
                    #deserializer: __D,
                    #at: &::annotated::Location<'_>,
                    #found: &mut ::annotated::Report,
                ) -> ::core::result::Result<::core::option::Option<Self>, __D::Error> {
                    #field_identifier
                    #visitor
                    #serde::Deserializer::deserialize_struct(
                        #deserializer,
                        #struct_name,
                        __FIELDS,
                        __Visitor #turbofish {
                            #at,
                            #found,
                            marker: ::core::marker::PhantomData,
                        },
                    )
                }
            }

            impl #impl_generics #serde::Deserialize<'de> for #name #type_generics #where_clause {
                fn deserialize<__D: #serde::Deserializer<'de>>(
                    #deserializer: __D,
                ) -> ::core::result::Result<Self, __D::Error> {
                    ::annotated::__private::deserialize_for_serde(#deserializer)
                }
            }
        }
    }

    fn generics_reading_fields(&self) -> Generics {
        let serde = &self.serde;
        let input = self.input();
        let parameters = type_and_const_parameters(&input.generics);
        let mut generics = input.generics.clone();
        generics.params.insert(0, parse_quote!('de));
        let where_clause = generics.make_where_clause();
        for field in self.fields() {
            let field_type = field.field_type;
            if !mentions_any(field_type.to_token_stream(), &parameters) {
                continue;
            }
            if field.has_nested_values() {
                where_clause
                    .predicates
                    .push(parse_quote!(#field_type: ::annotated::Deserialize<'de>));
            } else {
                where_clause
                    .predicates
                    .push(parse_quote!(#field_type: #serde::Deserialize<'de>));
            }
        }
        generics
    }

    fn field_identifier(&self) -> TokenStream {
        let Self { serde, formatter, .. } = self;
        let value = &self.rules.value;
        let serde_fields = &self.deserialized_struct.serde.fields;
        let variants = (0..serde_fields.len()).map(|index| format_ident!("Field{index}"));
        let names_read = serde_fields.iter().map(|field| &field.names_read);
        let index_arms = variants.clone().enumerate().map(|(index, variant)| {
            let index = index as u64;
            quote!(#index => ::core::result::Result::Ok(__Field::#variant),)
        });
        let name_arms = variants
            .clone()
            .zip(names_read.clone())
            .map(|(variant, names)| quote!(#(#names)|* => ::core::result::Result::Ok(__Field::#variant),));
        let byte_arms = variants.clone().zip(names_read).map(|(variant, names)| {
            let names = names.iter().map(|name| Literal::byte_string(name.as_bytes()));
            quote!(#(#names)|* => ::core::result::Result::Ok(__Field::#variant),)
        });
        let unknown = self.unknown_field(serde_fields.len());
        let UnknownField {
            variant: unknown_variant,
            by_index,
            by_name,
            by_bytes,
        } = &unknown;
        quote! {
            enum __Field {
                #(#variants,)*
                #unknown_variant
            }

            struct __FieldVisitor;

            impl<'de> #serde::de::Visitor<'de> for __FieldVisitor {
                type Value = __Field;

                fn expecting(&self, #formatter: &mut ::core::fmt::Formatter<'_>) -> ::core::fmt::Result {
                    ::core::fmt::Formatter::write_str(#formatter, "field identifier")
                }

                fn visit_u64<__E: #serde::de::Error>(self, #value: u64) -> ::core::result::Result<__Field, __E> {
                    match #value {
                        #(#index_arms)*
                        _ => #by_index,
                    }
                }

                fn visit_str<__E: #serde::de::Error>(self, #value: &str) -> ::core::result::Result<__Field, __E> {
                    match #value {
                        #(#name_arms)*
                        _ => #by_name,
                    }
                }

                fn visit_bytes<__E: #serde::de::Error>(self, #value: &[u8]) -> ::core::result::Result<__Field, __E> {
                    match #value {
                        #(#byte_arms)*
                        _ => #by_bytes,
                    }
                }
            }

            impl<'de> #serde::Deserialize<'de> for __Field {
                #[inline]
                fn deserialize<__D: #serde::Deserializer<'de>>(
                    deserializer: __D,
                ) -> ::core::result::Result<Self, __D::Error> {
                    #serde::Deserializer::deserialize_identifier(deserializer, __FieldVisitor)
                }
            }
        }
    }

    fn unknown_field(&self, field_count: usize) -> UnknownField {
        let serde = &self.serde;
        let value = &self.rules.value;
        if !self.deserialized_struct.serde.is_denying_unknown_fields {
            let ignored = quote!(::core::result::Result::Ok(__Field::Unknown));
            return UnknownField {
                variant: quote!(Unknown,),
                by_index: ignored.clone(),
                by_name: ignored.clone(),
                by_bytes: ignored,
            };
        }
        let indices_expected = format!("field index 0 <= i < {field_count}");
        UnknownField {
            variant: TokenStream::new(),
            by_index: quote! {
                ::core::result::Result::Err(<__E as #serde::de::Error>::invalid_value(
                    #serde::de::Unexpected::Unsigned(#value),
                    &#indices_expected,
                ))
            },
            by_name: quote!(::core::result::Result::Err(<__E as #serde::de::Error>::unknown_field(#value, __FIELDS))),
            by_bytes: quote! {
                {
                    let #value = &::std::string::String::from_utf8_lossy(#value);
                    ::core::result::Result::Err(<__E as #serde::de::Error>::unknown_field(#value, __FIELDS))
                }
            },
        }
    }

    fn visitor(&self) -> TokenStream {
        let Self {
            serde,
            formatter,
            visitor_lifetime,
            ..
        } = self;
        let Expansion { at, found, .. } = &self.rules;
        let input = self.input();
        let name = &input.ident;
        let (_, type_generics, _) = input.generics.split_for_impl();
        let visitor_generics = with_lifetime(&input.generics, visitor_lifetime);
        let (visitor_definition_generics, visitor_type_generics, visitor_where_clause) =
            visitor_generics.split_for_impl();
        let generics_reading_fields = with_lifetime(&self.generics_reading_fields(), visitor_lifetime);
        let (impl_generics, _, where_clause) = generics_reading_fields.split_for_impl();
        let expecting = self
            .deserialized_struct
            .serde
            .expecting
            .clone()
            .unwrap_or_else(|| format!("struct {name}"));
        let visit_seq = self.visit_seq();
        let visit_map = self.visit_map();
        let checked_value = self.checked_value();
        let names_read = self
            .deserialized_struct
            .serde
            .fields
            .iter()
            .flat_map(|field| &field.names_read);
        quote! {
            const __FIELDS: &[&str] = &[#(#names_read),*];

            struct __Visitor #visitor_definition_generics #visitor_where_clause {
                #at: &#visitor_lifetime ::annotated::Location<#visitor_lifetime>,
                #found: &#visitor_lifetime mut ::annotated::Report,
                marker: ::core::marker::PhantomData<fn() -> #name #type_generics>,
            }

            impl #impl_generics #serde::de::Visitor<'de> for __Visitor #visitor_type_generics #where_clause {
                type Value = ::core::option::Option<#name #type_generics>;

                fn expecting(&self, #formatter: &mut ::core::fmt::Formatter<'_>) -> ::core::fmt::Result {
                    ::core::fmt::Formatter::write_str(#formatter, #expecting)
                }

                #visit_seq

                #visit_map
            }

            impl #visitor_definition_generics __Visitor #visitor_type_generics #visitor_where_clause {
                #checked_value
            }
        }
    }

    fn visit_seq(&self) -> TokenStream {
        let Self { serde, seq, .. } = self;
        let Expansion { found, .. } = &self.rules;
        let elements = self.fields().iter().map(|field| {
            let slot = slot_of(field);
            let slot_type = self.slot_type_of(field);
            let field_type = field.field_type;
            if !self.is_read_with_issues(field) {
                return quote! {
                    let #slot: #slot_type = #serde::de::SeqAccess::next_element::<#field_type>(&mut #seq)?;
                };
            }
            let read_issues = read_issues_of(field);
            let reading_with_its_issues = self.reading_with_its_issues(field);
            let element = quote_spanned! {field_type.span()=>
                ::annotated::__private::serde::de::SeqAccess::next_element_seed(
                    &mut #seq,
                    #reading_with_its_issues,
                )?
            };
            quote! {
                let mut #read_issues = self.#found.new_alike();
                let #slot: #slot_type = #element;
            }
        });
        let slots = self.fields().iter().map(slot_of);
        let read_issues = self.fields_read_with_issues().map(read_issues_of);
        quote! {
            #[inline]
            fn visit_seq<__A: #serde::de::SeqAccess<'de>>(
                self,
                mut #seq: __A,
            ) -> ::core::result::Result<Self::Value, __A::Error> {
                #(#elements)*
                ::core::result::Result::Ok(self.checked_value((#(#slots,)*), (#(#read_issues,)*)))
            }
        }
    }

    fn reading_with_its_issues(&self, field: &ValidatedField) -> TokenStream {
        let Expansion { at, .. } = &self.rules;
        let field_type = field.field_type;
        let name = &field.name;
        let read_issues = read_issues_of(field);
        let at_the_field = quote!(&self.#at.field(#name));
        if !self.deserialized_struct.collects_type_errors {
            return quote_spanned! {field_type.span()=>
                ::annotated::__private::DeserializeAt::<#field_type>::new(#at_the_field, &mut #read_issues)
            };
        }
        let type_name = type_name_of(field_type);
        let seed = if field.has_nested_values() {
            quote!(NestedCollectingTypeErrorsAt)
        } else {
            quote!(CollectingTypeErrorsAt)
        };
        quote_spanned! {field_type.span()=>
            ::annotated::__private::#seed::<#field_type>::new(#type_name, #at_the_field, &mut #read_issues)
        }
    }

    fn is_read_with_issues(&self, field: &ValidatedField) -> bool {
        field.has_nested_values() || self.deserialized_struct.collects_type_errors
    }

    fn fields_read_with_issues(&self) -> impl Iterator<Item = &'a ValidatedField<'a>> {
        self.fields().iter().filter(|field| self.is_read_with_issues(field))
    }

    fn visit_map(&self) -> TokenStream {
        let Self { serde, map, key, .. } = self;
        let Expansion { found, .. } = &self.rules;
        let fields = self.fields();
        let slots = fields.iter().map(slot_of);
        let slot_types = fields.iter().map(|field| self.slot_type_of(field));
        let field_arms = fields.iter().enumerate().map(|(index, field)| {
            let variant = format_ident!("Field{index}");
            let slot = slot_of(field);
            let field_type = field.field_type;
            let name = &field.name;
            let value = if self.is_read_with_issues(field) {
                let reading_with_its_issues = self.reading_with_its_issues(field);
                quote_spanned! {field_type.span()=>
                    ::annotated::__private::serde::de::MapAccess::next_value_seed(
                        &mut #map,
                        #reading_with_its_issues,
                    )?
                }
            } else {
                quote!(#serde::de::MapAccess::next_value::<#field_type>(&mut #map)?)
            };
            quote! {
                __Field::#variant => {
                    if ::core::option::Option::is_some(&#slot) {
                        return ::core::result::Result::Err(
                            <__A::Error as #serde::de::Error>::duplicate_field(#name),
                        );
                    }
                    #slot = ::core::option::Option::Some(#value);
                }
            }
        });
        let unknown_field_arm = (!self.deserialized_struct.serde.is_denying_unknown_fields).then(|| {
            quote! {
                __Field::Unknown => {
                    #serde::de::MapAccess::next_value::<#serde::de::IgnoredAny>(&mut #map)?;
                }
            }
        });
        let read_slots = fields.iter().map(slot_of);
        let read_issues: Vec<_> = self.fields_read_with_issues().map(read_issues_of).collect();
        quote! {
            #[inline]
            fn visit_map<__A: #serde::de::MapAccess<'de>>(
                self,
                mut #map: __A,
            ) -> ::core::result::Result<Self::Value, __A::Error> {
                #(let mut #slots: #slot_types = ::core::option::Option::None;)*
                #(let mut #read_issues = self.#found.new_alike();)*
                while let ::core::option::Option::Some(#key) =
                    #serde::de::MapAccess::next_key::<__Field>(&mut #map)?
                {
                    match #key {
                        #(#field_arms)*
                        #unknown_field_arm
                    }
                }
                ::core::result::Result::Ok(self.checked_value((#(#read_slots,)*), (#(#read_issues,)*)))
            }
        }
    }

    // Always inlined into `visit_map` and `visit_seq`: left a call taking every slot, reading a valid 8-field body
    // without LTO ran 7987 instructions against 7918, and `serde_json::from_str` then `validate()` 7977. Emitting the
    // checks in each instead would compile every `pattern` twice.
    fn checked_value(&self) -> TokenStream {
        let Self {
            deserialized,
            has_finished,
            field_checks_label,
            struct_checks_label,
            ..
        } = self;
        let Expansion { at, found, .. } = &self.rules;
        let input = self.input();
        let name = &input.ident;
        let (_, type_generics, _) = input.generics.split_for_impl();
        let fields = self.fields();
        let slots = fields.iter().map(slot_of);
        let slot_types = fields.iter().map(|field| self.slot_type_of(field));
        let read_issues = self.fields_read_with_issues().map(read_issues_of);
        let read_issues_types = self.fields_read_with_issues().map(|_| quote!(::annotated::Report));
        let values_of_slots = fields.iter().map(|field| self.value_of_slot(field));
        let validities = self.fields_keeping_their_validity().map(validity_of);
        let field_checks = self.field_checks();
        let build = self.build();
        let struct_checks = self
            .rules
            .stopping_with(quote!(break #struct_checks_label))
            .struct_checks(
                &self.deserialized_struct.validated,
                &quote!(&#deserialized),
                &quote!(#name #type_generics),
            );
        let (finishing, struct_checks_unless_finished) = if struct_checks.is_empty() {
            (quote!(let _ =), TokenStream::new())
        } else {
            (
                quote!(let #has_finished =),
                quote! {
                    if !#has_finished {
                        #struct_checks_label: {
                            #(#struct_checks)*
                        }
                    }
                },
            )
        };
        quote! {
            #[inline(always)]
            fn checked_value(
                self,
                (#(#slots,)*): (#(#slot_types,)*),
                (#(mut #read_issues,)*): (#(#read_issues_types,)*),
            ) -> ::core::option::Option<#name #type_generics> {
                let #at = self.#at;
                let #found = self.#found;
                #(#values_of_slots)*
                #(let mut #validities = false;)*
                #finishing #field_checks_label: {
                    #(#field_checks)*
                    false
                };
                #build
                #struct_checks_unless_finished
                ::core::option::Option::Some(#deserialized)
            }
        }
    }

    fn field_checks(&self) -> Vec<TokenStream> {
        let validated_struct = &self.deserialized_struct.validated;
        self.fields()
            .iter()
            .enumerate()
            .map(|(index, field)| {
                let keeps_validity = self.rules.keeps_validity_of(validated_struct, index);
                if field.is_optional && !self.is_read_with_issues(field) {
                    let slot = slot_of(field);
                    let value_of_field = quote!(&#slot);
                    if keeps_validity {
                        return self.optional_field_validity(field, &value_of_field);
                    }
                    return self.rules.field_checks(field, &value_of_field);
                }
                if keeps_validity {
                    return self.read_field_validity(field);
                }
                self.read_field_checks(field)
            })
            .collect()
    }

    fn read_field_checks(&self, field: &ValidatedField) -> TokenStream {
        let slot = slot_of(field);
        let SlotStates {
            built,
            not_built,
            missing,
        } = self.slot_states(field);
        if field.rules.is_empty() && !self.is_read_with_issues(field) {
            return quote! {
                if ::core::option::Option::is_none(&#slot) {
                    #missing
                }
            };
        }
        let checks = if field.rules.is_empty() {
            TokenStream::new()
        } else {
            self.rules_of(field).field_rule_checks(field)
        };
        let waiting_for_the_elements = waiting_for_the_elements(field);
        let not_built_arm = not_built.map(|(pattern, not_built)| quote!(#pattern => { #not_built }));
        let missing_arm = (!field.is_optional).then(|| quote!(::core::option::Option::None => { #missing }));
        quote! {
            match &#slot {
                #built => {
                    #waiting_for_the_elements
                    #checks
                }
                #not_built_arm
                #missing_arm
            }
        }
    }

    fn fields_keeping_their_validity(&self) -> impl Iterator<Item = &'a ValidatedField<'a>> {
        let validated_struct = &self.deserialized_struct.validated;
        let rules = self.rules.clone();
        self.fields()
            .iter()
            .enumerate()
            .filter(move |(index, _)| rules.keeps_validity_of(validated_struct, *index))
            .map(|(_, field)| field)
    }

    fn optional_field_validity(&self, field: &ValidatedField, value_of_field: &TokenStream) -> TokenStream {
        let is_valid = validity_of(field);
        let value = &self.rules.value;
        if field.rules.is_empty() {
            return quote!(#is_valid = true;);
        }
        let passes_every_rule = self.rules.field_passes_every_rule(field);
        quote! {
            #is_valid = {
                let #value = #value_of_field;
                #passes_every_rule
            };
        }
    }

    fn read_field_validity(&self, field: &ValidatedField) -> TokenStream {
        let slot = slot_of(field);
        let is_valid = validity_of(field);
        let SlotStates {
            built,
            not_built,
            missing,
        } = self.slot_states(field);
        let passes_every_rule = if field.rules.is_empty() {
            quote!(true)
        } else {
            self.rules_of(field).field_passes_every_rule(field)
        };
        let waiting_for_the_elements = waiting_for_the_elements(field);
        let not_built_arm = not_built.map(|(pattern, not_built)| quote!(#pattern => { #not_built false }));
        let missing_arm = (!field.is_optional).then(|| quote!(::core::option::Option::None => { #missing false }));
        quote! {
            #is_valid = match &#slot {
                #built => {
                    #waiting_for_the_elements
                    #passes_every_rule
                }
                #not_built_arm
                #missing_arm
            };
        }
    }

    fn rules_of(&self, field: &ValidatedField) -> Expansion {
        if !field.has_nested_values() {
            return self.rules.clone();
        }
        self.rules.reading_nested_issues_from(&read_issues_of(field))
    }

    fn slot_states(&self, field: &ValidatedField) -> SlotStates {
        let value = if field.rules.is_empty() {
            quote!(_)
        } else {
            self.rules.value.to_token_stream()
        };
        let found = &self.rules.found;
        let missing = self.missing(field);
        if !self.is_read_with_issues(field) {
            return SlotStates {
                built: quote!(::core::option::Option::Some(#value)),
                not_built: None,
                missing,
            };
        }
        let read_issues = read_issues_of(field);
        let stop_if_finished = self.rules.stop_if_finished();
        let not_built = quote! {
            #found.append(&mut #read_issues);
            #stop_if_finished
        };
        let (built, not_built_pattern) = if field.is_optional {
            (
                quote!(::core::option::Option::Some(#value)),
                quote!(::core::option::Option::None),
            )
        } else {
            (
                quote!(::core::option::Option::Some(::core::option::Option::Some(#value))),
                quote!(::core::option::Option::Some(::core::option::Option::None)),
            )
        };
        SlotStates {
            built,
            not_built: Some((not_built_pattern, not_built)),
            missing,
        }
    }

    fn missing(&self, field: &ValidatedField) -> TokenStream {
        let found = &self.rules.found;
        let missing_at = self.rules.field_location(field);
        let stop_if_finished = self.rules.stop_if_finished();
        quote! {
            ::annotated::__private::record_issue(
                #found,
                #missing_at,
                ::annotated::Problem::Missing,
                ::core::option::Option::None,
            );
            #stop_if_finished
        }
    }

    fn build(&self) -> TokenStream {
        let deserialized = &self.deserialized;
        let fields = self.fields().iter().map(|field| {
            let member = field.member;
            let slot = slot_of(field);
            match (self.is_read_with_issues(field), field.is_optional) {
                (false, true) => quote!(#member: #slot),
                (false, false) | (true, true) => quote!(#member: #slot?),
                (true, false) => quote!(#member: ::core::option::Option::flatten(#slot)?),
            }
        });
        let name = &self.input().ident;
        quote! {
            let #deserialized = #name { #(#fields,)* };
        }
    }

    fn slot_type_of(&self, field: &ValidatedField) -> TokenStream {
        let field_type = field.field_type;
        if self.is_read_with_issues(field) {
            return quote!(::core::option::Option<::core::option::Option<#field_type>>);
        }
        quote!(::core::option::Option<#field_type>)
    }

    fn value_of_slot(&self, field: &ValidatedField) -> TokenStream {
        let slot = slot_of(field);
        match (self.is_read_with_issues(field), field.is_optional) {
            (_, false) => TokenStream::new(),
            (false, true) => quote!(let #slot = ::core::option::Option::flatten(#slot);),
            (true, true) => quote! {
                let #slot = ::core::option::Option::unwrap_or(
                    #slot,
                    ::core::option::Option::Some(::core::option::Option::None),
                );
            },
        }
    }
}

struct SlotStates {
    built: TokenStream,
    not_built: Option<(TokenStream, TokenStream)>,
    missing: TokenStream,
}

struct UnknownField {
    variant: TokenStream,
    by_index: TokenStream,
    by_name: TokenStream,
    by_bytes: TokenStream,
}

fn slot_of(field: &ValidatedField) -> Ident {
    format_ident!("{}_slot", field.member, span = Span::mixed_site())
}

fn waiting_for_the_elements(field: &ValidatedField) -> TokenStream {
    if !field.joins_nested_issues_element_by_element() {
        return TokenStream::new();
    }
    let read_issues = read_issues_of(field);
    quote! {
        let mut #read_issues = ::annotated::__private::ElementIssues::new(#read_issues);
    }
}

fn type_name_of(field_type: &Type) -> String {
    if let Some(content) = option_content(field_type) {
        return type_name_of(content);
    }
    match field_type {
        Type::Path(type_path) => type_path
            .path
            .segments
            .last()
            .map_or_else(String::new, |last_segment| last_segment.ident.unraw().to_string()),
        Type::Group(group) => type_name_of(&group.elem),
        Type::Paren(parenthesized) => type_name_of(&parenthesized.elem),
        Type::Reference(reference) => type_name_of(&reference.elem),
        other => other.to_token_stream().to_string(),
    }
}

fn read_issues_of(field: &ValidatedField) -> Ident {
    format_ident!("{}_read_issues", field.member, span = Span::mixed_site())
}

fn with_lifetime(generics: &Generics, lifetime: &Lifetime) -> Generics {
    let mut generics = generics.clone();
    let position = generics
        .params
        .iter()
        .take_while(|parameter| matches!(parameter, GenericParam::Lifetime(_)))
        .count();
    generics
        .params
        .insert(position, GenericParam::Lifetime(LifetimeParam::new(lifetime.clone())));
    generics
}

fn type_and_const_parameters(generics: &Generics) -> Vec<&Ident> {
    generics
        .params
        .iter()
        .filter_map(|parameter| match parameter {
            GenericParam::Type(type_parameter) => Some(&type_parameter.ident),
            GenericParam::Const(const_parameter) => Some(&const_parameter.ident),
            GenericParam::Lifetime(_) => None,
        })
        .collect()
}

fn mentions_any(tokens: TokenStream, parameters: &[&Ident]) -> bool {
    tokens.into_iter().any(|token| match token {
        TokenTree::Ident(ident) => parameters.iter().any(|parameter| ident == **parameter),
        TokenTree::Group(group) => mentions_any(group.stream(), parameters),
        TokenTree::Punct(_) | TokenTree::Literal(_) => false,
    })
}