spacetimedb-bindings-macro 2.4.0

Easy support for interacting between SpacetimeDB and Rust.
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
//! When editing generated code in this module, use `__`-prefixed reserved names
//! for macro-emitted local bindings and helper items to avoid collisions with
//! user-defined items at the expansion site.

extern crate core;
extern crate proc_macro;

use proc_macro2::{Span, TokenStream};
use quote::{quote, quote_spanned, ToTokens};
use syn::punctuated::Pair;
use syn::spanned::Spanned;
use syn::{LitStr, Token};

use crate::sym;
use crate::util::{check_duplicate, match_meta};

pub(crate) struct SatsType<'a> {
    pub ident: &'a syn::Ident,
    pub generics: &'a syn::Generics,
    pub name: LitStr,
    pub krate: TokenStream,
    // may want to use in the future
    #[allow(unused)]
    pub original_attrs: &'a [syn::Attribute],
    pub data: SatsTypeData<'a>,
    /// Was the type marked as `#[repr(C)]`?
    pub is_repr_c: bool,
}

pub(crate) enum SatsTypeData<'a> {
    Product(Vec<SatsField<'a>>),
    Sum(Vec<SatsVariant<'a>>),
}

#[derive(Clone)]
pub(crate) struct SatsField<'a> {
    pub ident: Option<&'a syn::Ident>,
    pub vis: &'a syn::Visibility,
    pub name: Option<String>,
    pub ty: &'a syn::Type,
    pub original_attrs: &'a [syn::Attribute],
}

pub(crate) struct SatsVariant<'a> {
    pub ident: &'a syn::Ident,
    pub name: String,
    pub ty: Option<&'a syn::Type>,
    pub member: Option<syn::Member>,
    // may want to use in the future
    #[allow(unused)]
    pub original_attrs: &'a [syn::Attribute],
}

pub(crate) fn sats_type_from_derive(
    input: &syn::DeriveInput,
    crate_fallback: TokenStream,
) -> syn::Result<SatsType<'_>> {
    let data = match &input.data {
        syn::Data::Struct(struc) => {
            let fields = struc.fields.iter().map(|field| SatsField {
                ident: field.ident.as_ref(),
                vis: &field.vis,
                name: field.ident.as_ref().map(syn::Ident::to_string),
                ty: &field.ty,
                original_attrs: &field.attrs,
            });
            SatsTypeData::Product(fields.collect())
        }
        syn::Data::Enum(enu) => {
            let variants = enu.variants.iter().map(|var| {
                let (member, ty) = variant_data(var)?.unzip();
                Ok(SatsVariant {
                    ident: &var.ident,
                    name: var.ident.to_string(),
                    ty,
                    member,
                    original_attrs: &var.attrs,
                })
            });
            SatsTypeData::Sum(variants.collect::<syn::Result<Vec<_>>>()?)
        }
        syn::Data::Union(u) => return Err(syn::Error::new(u.union_token.span, "unions not supported")),
    };
    extract_sats_type(&input.ident, &input.generics, &input.attrs, data, crate_fallback)
}

fn is_repr_c(attrs: &[syn::Attribute]) -> bool {
    let mut is_repr_c = false;
    for attr in attrs.iter().filter(|a| a.path() == sym::repr) {
        let _ = attr.parse_nested_meta(|meta| {
            is_repr_c |= meta.path.is_ident("C");
            Ok(())
        });
    }
    is_repr_c
}

pub(crate) fn extract_sats_type<'a>(
    ident: &'a syn::Ident,
    generics: &'a syn::Generics,
    attrs: &'a [syn::Attribute],
    data: SatsTypeData<'a>,
    crate_fallback: TokenStream,
) -> syn::Result<SatsType<'a>> {
    let mut name = None;
    let mut krate = None;
    for attr in attrs {
        if attr.path() != sym::sats {
            continue;
        }
        attr.parse_nested_meta(|meta| {
            match_meta!(match meta {
                sym::crate_ => {
                    check_duplicate(&krate, &meta)?;
                    let value = meta.value()?;
                    let v = value.call(syn::Path::parse_mod_style)?;
                    krate = Some(v.into_token_stream());
                }
                sym::name => {
                    check_duplicate(&name, &meta)?;
                    let value = meta.value()?;
                    let v = value.parse::<LitStr>()?;
                    name = Some(v);
                }
            });
            Ok(())
        })?;
    }
    let krate = krate.unwrap_or(crate_fallback);
    let name = name.unwrap_or_else(|| crate::util::ident_to_litstr(ident));

    let is_repr_c = is_repr_c(attrs);

    Ok(SatsType {
        ident,
        generics,
        name,
        krate,
        original_attrs: attrs,
        data,
        is_repr_c,
    })
}

pub(crate) fn derive_satstype(ty: &SatsType<'_>) -> TokenStream {
    let ty_name = &ty.name;
    let name = &ty.ident;
    let krate = &ty.krate;

    let mut add_impls_for_plain_enum = false;
    let typ = match &ty.data {
        SatsTypeData::Product(fields) => {
            let fields = fields.iter().map(|field| {
                let field_name = match &field.name {
                    Some(name) => quote!(Some(#name)),
                    None => quote!(None),
                };
                let ty = field.ty;
                quote!((
                    #field_name,
                    <#ty as #krate::SpacetimeType>::make_type(__typespace)
                ))
            });
            let len = fields.len();
            quote!(
                #krate::sats::AlgebraicType::product::<
                    [(Option<&str>, #krate::sats::AlgebraicType); #len]
                >(
                    [#(#fields),*]
                )
            )
        }
        SatsTypeData::Sum(variants) => {
            // To allow an enum, with all-unit variants, as an index key type,
            // add derive `Filterable` for the enum.
            add_impls_for_plain_enum = variants.iter().all(|var| var.ty.is_none());

            let unit = syn::Type::Tuple(syn::TypeTuple {
                paren_token: Default::default(),
                elems: Default::default(),
            });
            let variants = variants.iter().map(|var| {
                let variant_name = &var.name;
                let ty = var.ty.unwrap_or(&unit);
                quote!((
                    #variant_name,
                    <#ty as #krate::SpacetimeType>::make_type(__typespace)
                ))
            });
            let len = variants.len();
            quote!(
                #krate::sats::AlgebraicType::sum::<
                    [(&str, #krate::sats::AlgebraicType); #len]
                >(
                    [#(#variants),*]
                )
            )
        }
    };

    let mut sats_generics = ty.generics.clone();
    // the 'static here is an unfortunate restriction from TypeId :(
    add_type_bounds(&mut sats_generics, &quote!(#krate::SpacetimeType + 'static));
    let (impl_generics, ty_generics, where_clause) = sats_generics.split_for_impl();

    // TypeId::of() requires all the lifetimes to be 'static
    let mut typeid_generics = sats_generics.clone();
    let static_lt = syn::Lifetime::new("'static", Span::call_site());
    for param in &mut typeid_generics.params {
        if let syn::GenericParam::Lifetime(param) = param {
            param.lifetime = static_lt.clone();
        }
    }
    let (_, typeid_ty_generics, _) = typeid_generics.split_for_impl();

    let impl_plain_enum_extras = if add_impls_for_plain_enum {
        // These will mostly be empty as lifetime and type parameters must be constrained
        // but const parameters don't require constraining.
        let mut generics = ty.generics.clone();
        add_type_bounds(&mut generics, &quote!(#krate::FilterableValue));
        let (impl_generics, ty_generics, where_clause) = generics.split_for_impl();
        // Assume that the type is `Copy`, as most all-unit enums will be.
        let filterable_impl = quote! {
            #[automatically_derived]
            impl #impl_generics #krate::Private for #name #ty_generics #where_clause {}
                #[automatically_derived]
            impl #impl_generics #krate::FilterableValue for #name #ty_generics #where_clause {
                type Column = #name #ty_generics;
            }
            #[automatically_derived]
            impl #impl_generics #krate::Private for &#name #ty_generics #where_clause {}
            #[automatically_derived]
            impl #impl_generics #krate::FilterableValue for &#name #ty_generics #where_clause {
                type Column = #name #ty_generics;
            }
        };

        let mut generics = ty.generics.clone();
        add_type_bounds(&mut generics, &quote!(#krate::DirectIndexKey));
        let (impl_generics, ty_generics, where_clause) = generics.split_for_impl();
        let dik_impl = quote! {
            #[automatically_derived]
            impl #impl_generics #krate::DirectIndexKey for #name #ty_generics #where_clause {}
        };

        Some(quote! {
            #filterable_impl
            #dik_impl
        })
    } else {
        None
    };

    quote! {
        #impl_plain_enum_extras

        #[automatically_derived]
        impl #impl_generics #krate::SpacetimeType for #name #ty_generics #where_clause {
            // __ reserved name for binding to prevent name conflicts. See module-level doc comment.
            fn make_type<S: #krate::sats::typespace::TypespaceBuilder>(__typespace: &mut S) -> #krate::sats::AlgebraicType {
                #krate::sats::typespace::TypespaceBuilder::add(
                    __typespace,
                    core::any::TypeId::of::<#name #typeid_ty_generics>(),
                    Some(#ty_name),
                    // __ reserved name for binding to prevent name conflicts. See module-level doc comment.
                    |__typespace| #typ,
                )
            }
        }
    }
}

fn add_type_bounds(generics: &mut syn::Generics, trait_bound: &TokenStream) {
    for param in &generics.params {
        let syn::GenericParam::Type(param) = param else {
            continue;
        };
        let param_name = &param.ident;
        let where_clause = generics.where_clause.get_or_insert_with(|| syn::WhereClause {
            where_token: Default::default(),
            predicates: Default::default(),
        });
        where_clause
            .predicates
            .push(syn::parse_quote!(#param_name: #trait_bound));
    }
}

/// Returns the list of types if syntactically we see that the `ty`
/// is `#[repr(C)]` of only primitives.
///
/// We later assert semantically in generated code that the list of types
/// actually are primitives.
/// We'll also check that `ty` is paddingless.
fn extract_repr_c_primitive<'a>(ty: &'a SatsType) -> Option<Vec<&'a syn::Ident>> {
    // Ensure we have a `#[repr(C)]` struct.
    if !ty.is_repr_c {
        return None;
    }
    let SatsTypeData::Product(fields) = &ty.data else {
        return None;
    };

    // Ensure every field is a primitive and collect the idents.
    const PRIM_TY: &[sym::Symbol] = &[
        sym::u8,
        sym::i8,
        sym::u16,
        sym::i16,
        sym::u32,
        sym::i32,
        sym::u64,
        sym::i64,
        sym::u128,
        sym::i128,
        sym::f32,
        sym::f64,
    ];
    let mut field_tys = Vec::with_capacity(fields.len());
    for field in fields {
        if let syn::Type::Path(ty) = &field.ty {
            let ident = ty.path.get_ident().filter(|ident| PRIM_TY.iter().any(|p| ident == p))?;
            field_tys.push(ident);
        } else {
            return None;
        }
    }
    Some(field_tys)
}

pub(crate) fn derive_deserialize(ty: &SatsType<'_>) -> TokenStream {
    let (name, tuple_name) = (&ty.ident, &ty.name);
    let spacetimedb_lib = &ty.krate;
    let (impl_generics, ty_generics, where_clause) = ty.generics.split_for_impl();

    let de_lifetime = syn::Lifetime::new("'de", Span::call_site());
    let deserialize_t = quote!(#spacetimedb_lib::de::Deserialize<#de_lifetime>);

    let mut de_generics = ty.generics.clone();

    add_type_bounds(&mut de_generics, &deserialize_t);

    for lp in de_generics.lifetimes_mut() {
        lp.bounds.push(de_lifetime.clone());
    }

    let mut de_lt_param = syn::LifetimeParam::new(de_lifetime);
    de_lt_param.bounds = de_generics
        .lifetimes()
        .map(|lp| Pair::Punctuated(lp.lifetime.clone(), Token![+](Span::call_site())))
        .collect();

    de_generics.params.insert(0, de_lt_param.into());
    let (de_impl_generics, _, de_where_clause) = de_generics.split_for_impl();

    let (iter_n, iter_n2, iter_n3, iter_n4, iter_n5, iter_n6, iter_n7) =
        (0usize.., 0usize.., 0usize.., 0usize.., 0usize.., 0usize.., 0usize..);

    match &ty.data {
        SatsTypeData::Product(fields) => {
            let mut fast_body = None;
            if let Some(fields) = extract_repr_c_primitive(ty) {
                fast_body = Some(quote! {
                    #[inline(always)]
                    fn deserialize_from_bsatn<R: #spacetimedb_lib::buffer::BufReader<'de>>(
                        mut deserializer: #spacetimedb_lib::bsatn::Deserializer<'de, R>
                    ) -> Result<Self, #spacetimedb_lib::bsatn::DecodeError> {
                        const _: () = {
                            #(#spacetimedb_lib::bsatn::assert_is_primitive_type::<#fields>();)*
                        };
                        // This guarantees that `Self` has no padding.
                        if const { core::mem::size_of::<Self>() == #(core::mem::size_of::<#fields>())+* } {
                            let bytes = deserializer.get_slice(core::mem::size_of::<Self>())?;
                            let ptr = bytes as *const [u8] as *const u8 as *const Self;
                            // SAFETY:
                            // - `ptr` is valid for reads, `size_of::<T>()`.
                            // - `ptr` is trivially properly aligned (alignment = 1).
                            // - `ptr` points to a properly initialized `Foo`
                            //   as we've guaranteed that there is no padding.
                            Ok(unsafe { core::ptr::read(ptr) })
                        } else {
                            Self::deserialize(deserializer)
                        }
                    }
                });
            }

            let n_fields = fields.len();

            let field_names = fields.iter().map(|f| f.ident.unwrap()).collect::<Vec<_>>();
            let field_strings = fields.iter().map(|f| f.name.as_deref().unwrap()).collect::<Vec<_>>();
            let field_types = fields.iter().map(|f| f.ty);
            let field_types2 = field_types.clone();
            let field_types3 = field_types.clone();
            let field_types4 = field_types.clone();
            quote! {
                #[allow(non_camel_case_types)]
                #[allow(clippy::all)]
                const _: () = {
                    impl #de_impl_generics #spacetimedb_lib::de::Deserialize<'de> for #name #ty_generics #de_where_clause {
                        #fast_body

                        fn deserialize<D: #spacetimedb_lib::de::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
                            deserializer.deserialize_product(__ProductVisitor {
                                _marker: std::marker::PhantomData::<fn() -> #name #ty_generics>,
                            })
                        }

                        fn validate<D: #spacetimedb_lib::de::Deserializer<'de>>(deserializer: D) -> Result<(), D::Error> {
                            deserializer.validate_product(__ProductVisitor {
                                _marker: std::marker::PhantomData::<fn() -> #name #ty_generics>,
                            })
                        }
                    }

                    // __ reserved name for binding to prevent name conflicts. See module-level doc comment.
                    struct __ProductVisitor #impl_generics #where_clause {
                        _marker: std::marker::PhantomData<fn() -> #name #ty_generics>,
                    }

                    impl #de_impl_generics #spacetimedb_lib::de::ProductVisitor<'de> for __ProductVisitor #ty_generics #de_where_clause {
                        type Output = #name #ty_generics;

                        fn product_name(&self) -> Option<&str> {
                            Some(#tuple_name)
                        }
                        fn product_len(&self) -> usize {
                            #n_fields
                        }

                        fn visit_seq_product<A: #spacetimedb_lib::de::SeqProductAccess<'de>>(self, mut tup: A) -> Result<Self::Output, A::Error> {
                            Ok(#name {
                                #(#field_names:
                                    tup.next_element::<#field_types>()?
                                        .ok_or_else(|| #spacetimedb_lib::de::Error::invalid_product_length(#iter_n, &self))?,)*
                            })
                        }
                        fn validate_seq_product<A: #spacetimedb_lib::de::SeqProductAccess<'de>>(self, mut tup: A) -> Result<(), A::Error> {
                            #(
                                tup.validate_next_element::<#field_types2>()?
                                    .ok_or_else(|| #spacetimedb_lib::de::Error::invalid_product_length(#iter_n2, &self))?;
                            )*
                            Ok(())
                        }
                        // __ reserved name for binding to prevent name conflicts. See module-level doc comment.
                        fn visit_named_product<A: #spacetimedb_lib::de::NamedProductAccess<'de>>(self, mut __prod: A) -> Result<Self::Output, A::Error> {
                            #(let mut #field_names = None;)*
                            // __ reserved name for binding to prevent name conflicts. See module-level doc comment.
                            while let Some(__field) = #spacetimedb_lib::de::NamedProductAccess::get_field_ident(&mut __prod, Self {
                                _marker: std::marker::PhantomData,
                            })? {
                                match __field {
                                    #(__ProductFieldIdent::#field_names => {
                                        if #field_names.is_some() {
                                            return Err(#spacetimedb_lib::de::Error::duplicate_field(#iter_n3, Some(#field_strings), &self))
                                        }
                                        #field_names = Some(#spacetimedb_lib::de::NamedProductAccess::get_field_value::<#field_types3>(&mut __prod)?)
                                    })*
                                }
                            }
                            Ok(#name {
                                #(#field_names:
                                    #field_names.ok_or_else(|| #spacetimedb_lib::de::Error::missing_field(#iter_n4, Some(#field_strings), &self))?,)*
                            })
                        }
                        // __ reserved name for binding to prevent name conflicts. See module-level doc comment.
                        fn validate_named_product<A: #spacetimedb_lib::de::NamedProductAccess<'de>>(self, mut __prod: A) -> Result<(), A::Error> {
                            #(let mut #field_names = false;)*
                            // __ reserved name for binding to prevent name conflicts. See module-level doc comment.
                            while let Some(__field) = #spacetimedb_lib::de::NamedProductAccess::get_field_ident(&mut __prod, Self {
                                _marker: std::marker::PhantomData,
                            })? {
                                match __field {
                                    #(__ProductFieldIdent::#field_names => {
                                        if #field_names {
                                            return Err(#spacetimedb_lib::de::Error::duplicate_field(#iter_n5, Some(#field_strings), &self))
                                        }
                                        #spacetimedb_lib::de::NamedProductAccess::validate_field_value::<#field_types4>(&mut __prod)?;
                                        #field_names = true;
                                    })*
                                }
                            }
                            #(
                                if !#field_names {
                                    return Err(#spacetimedb_lib::de::Error::missing_field(#iter_n6, Some(#field_strings), &self));
                                }
                            )*
                            Ok(())
                        }
                    }

                    impl #de_impl_generics #spacetimedb_lib::de::FieldNameVisitor<'de> for __ProductVisitor #ty_generics #de_where_clause {
                        type Output = __ProductFieldIdent;

                        fn field_names(&self) -> impl '_ + Iterator<Item = Option<&str>> {
                            [#(#field_strings),*].into_iter().map(Some)
                        }

                        // __ reserved name for binding to prevent name conflicts. See module-level doc comment.
                        // __ reserved name for binding to prevent name conflicts. See module-level doc comment.
                        fn visit<__E: #spacetimedb_lib::de::Error>(self, __name: &str) -> Result<Self::Output, __E> {
                            match __name {
                                #(#field_strings => Ok(__ProductFieldIdent::#field_names),)*
                                _ => Err(#spacetimedb_lib::de::Error::unknown_field_name(__name, &self)),
                            }
                        }

                        // __ reserved name for binding to prevent name conflicts. See module-level doc comment.
                        fn visit_seq(self, __index: usize) -> Self::Output {
                            match __index {
                                #(#iter_n7 => __ProductFieldIdent::#field_names,)*
                                _ => core::unreachable!(),
                            }
                        }
                    }

                    #[allow(non_camel_case_types)]
                    // __ reserved name for binding to prevent name conflicts. See module-level doc comment.
                    enum __ProductFieldIdent {
                        #(#field_names,)*
                    }
                };
            }
        }
        SatsTypeData::Sum(variants) => {
            let variant_names = variants.iter().map(|var| &*var.name).collect::<Vec<_>>();
            let variant_idents = variants.iter().map(|var| var.ident).collect::<Vec<_>>();
            let tags = 0u8..;
            let arms = variants.iter().map(|var| {
                let ident = var.ident;
                if let (Some(member), Some(ty)) = (&var.member, var.ty) {
                    quote! {
                        __Variant::#ident => Ok(#name::#ident { #member: #spacetimedb_lib::de::VariantAccess::deserialize::<#ty>(__access)? }),
                    }
                } else {
                    quote! {
                        __Variant::#ident => {
                            let () = #spacetimedb_lib::de::VariantAccess::deserialize(__access)?;
                            Ok(#name::#ident)
                        }
                    }
                }
            });
            let arms_validate = variants.iter().map(|var| {
                let ident = var.ident;
                if let Some(ty) = var.ty {
                    quote! {
                        __Variant::#ident => #spacetimedb_lib::de::VariantAccess::validate::<#ty>(__access)?,
                    }
                } else {
                    quote! {
                        __Variant::#ident => #spacetimedb_lib::de::VariantAccess::validate::<()>(__access)?,
                    }
                }
            });
            quote! {
                #[allow(clippy::all)]
                const _: () = {
                    impl #de_impl_generics #spacetimedb_lib::de::Deserialize<'de> for #name #ty_generics #de_where_clause {
                        fn deserialize<D: #spacetimedb_lib::de::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
                            deserializer.deserialize_sum(__SumVisitor {
                                _marker: std::marker::PhantomData::<fn() -> #name #ty_generics>,
                            })
                        }

                        fn validate<D: #spacetimedb_lib::de::Deserializer<'de>>(deserializer: D) -> Result<(), D::Error> {
                            deserializer.validate_sum(__SumVisitor {
                                _marker: std::marker::PhantomData::<fn() -> #name #ty_generics>,
                            })
                        }
                    }

                    // __ reserved name for binding to prevent name conflicts. See module-level doc comment.
                    struct __SumVisitor #impl_generics #where_clause {
                        _marker: std::marker::PhantomData<fn() -> #name #ty_generics>,
                    }

                    impl #de_impl_generics #spacetimedb_lib::de::SumVisitor<'de> for __SumVisitor #ty_generics #de_where_clause {
                        type Output = #name #ty_generics;

                        fn sum_name(&self) -> Option<&str> {
                            Some(#tuple_name)
                        }

                        // __ reserved name for binding to prevent name conflicts. See module-level doc comment.
                        fn visit_sum<A: #spacetimedb_lib::de::SumAccess<'de>>(self, __data: A) -> Result<Self::Output, A::Error> {
                            // __ reserved name for binding to prevent name conflicts. See module-level doc comment.
                            let (__variant, __access) = __data.variant(self)?;
                            match __variant {
                                #(#arms)*
                            }
                        }

                        // __ reserved name for binding to prevent name conflicts. See module-level doc comment.
                        fn validate_sum<A: #spacetimedb_lib::de::SumAccess<'de>>(self, __data: A) -> Result<(), A::Error> {
                            // __ reserved name for binding to prevent name conflicts. See module-level doc comment.
                            let (__variant, __access) = __data.variant(self)?;
                            match __variant {
                                #(#arms_validate)*
                            }
                            Ok(())
                        }
                    }

                    #[allow(non_camel_case_types)]
                    // __ reserved name for binding to prevent name conflicts. See module-level doc comment.
                    enum __Variant {
                        #(#variant_idents,)*
                    }

                    impl #de_impl_generics #spacetimedb_lib::de::VariantVisitor<'de> for __SumVisitor #ty_generics #de_where_clause {
                        type Output = __Variant;

                        fn variant_names(&self) -> impl '_ + Iterator<Item = &str> {
                            [#(#variant_names,)*].into_iter()
                        }

                        // __ reserved name for binding to prevent name conflicts. See module-level doc comment.
                        fn visit_tag<E: #spacetimedb_lib::de::Error>(self, __tag: u8) -> Result<Self::Output, E> {
                            match __tag {
                                #(#tags => Ok(__Variant::#variant_idents),)*
                                _ => Err(#spacetimedb_lib::de::Error::unknown_variant_tag(__tag, &self)),
                            }
                        }
                        // __ reserved name for binding to prevent name conflicts. See module-level doc comment.
                        fn visit_name<E: #spacetimedb_lib::de::Error>(self, __name: &str) -> Result<Self::Output, E> {
                            match __name {
                                #(#variant_names => Ok(__Variant::#variant_idents),)*
                                _ => Err(#spacetimedb_lib::de::Error::unknown_variant_name(__name, &self)),
                            }
                        }
                    }
                };
            }
        }
    }
}

pub(crate) fn derive_serialize(ty: &SatsType) -> TokenStream {
    let spacetimedb_lib = &ty.krate;
    let name = &ty.ident;

    let mut generics = ty.generics.clone();

    let serialize_t = quote!(#spacetimedb_lib::ser::Serialize);
    add_type_bounds(&mut generics, &serialize_t);

    let (impl_generics, ty_generics, where_clause) = generics.split_for_impl();

    let mut fast_body = None;
    let body = match &ty.data {
        SatsTypeData::Product(fields) => {
            if let Some(fields) = extract_repr_c_primitive(ty) {
                fast_body = Some(quote! {
                    #[inline(always)]
                    fn serialize_into_bsatn<W: #spacetimedb_lib::buffer::BufWriter>(
                            &self,
                            serializer: #spacetimedb_lib::bsatn::Serializer<'_, W>
                    ) -> Result<(), #spacetimedb_lib::bsatn::EncodeError> {
                        const _: () = {
                            #(#spacetimedb_lib::bsatn::assert_is_primitive_type::<#fields>();)*
                        };
                        // This guarantees that `Self` has no padding.
                        if const { core::mem::size_of::<Self>() == #(core::mem::size_of::<#fields>())+* } {
                            // SAFETY:
                            // - We know `self` is non-null as it's a shared reference
                            //   and we know it's valid for reads for `core::mem::size_of::<Self>()` bytes.
                            //   Alignment of `u8` is 1, so it's trivially satisfied.
                            //   - The slice is all within `self`, so in the same allocated object.
                            // - `self` does point to `core::mem::size_of::<Self>()` consecutive `u8`s,
                            //    as per `assert_is_primitive_type` above,
                            //    we know none of the fields of `Self` have any padding.
                            // - We're not going to mutate the memory within `bytes`.
                            // - We know `core::mem::size_of::<Self>() < isize::MAX`.
                            let bytes = unsafe { core::slice::from_raw_parts(self as *const _ as *const u8, core::mem::size_of::<Self>()) };
                            serializer.raw_write_bytes(bytes);
                            Ok(())
                        } else {
                            self.serialize(serializer)
                        }
                    }
                });
            }

            let fieldnames = fields.iter().map(|field| field.ident.unwrap());
            let tys = fields.iter().map(|f| &f.ty);
            let fieldnamestrings = fields.iter().map(|field| field.name.as_ref().unwrap());
            let nfields = fields.len();
            quote! {
                // __ reserved name for binding to prevent name conflicts. See module-level doc comment.
                let mut __prod = __serializer.serialize_named_product(#nfields)?;
                #(#spacetimedb_lib::ser::SerializeNamedProduct::serialize_element::<#tys>(&mut __prod, Some(#fieldnamestrings), &self.#fieldnames)?;)*
                #spacetimedb_lib::ser::SerializeNamedProduct::end(__prod)
            }
        }
        SatsTypeData::Sum(variants) => {
            let arms = variants.iter().enumerate().map(|(i, var)| {
                let (name,name_str) = (var.ident, &var.name);
                let tag = i as u8;
                if let (Some(member), Some(ty)) = (&var.member, var.ty) {
                    quote_spanned! {ty.span()=>
                        // __ reserved name for binding to prevent name conflicts. See module-level doc comment.
                        Self::#name { #member: __variant } => __serializer.serialize_variant::<#ty>(#tag, Some(#name_str), __variant),
                    }
                } else {
                    quote! {
                        Self::#name => __serializer.serialize_variant(#tag, Some(#name_str), &()),
                    }
                }
            });
            quote!(match self {
                #(#arms)*
                _ => unreachable!(),
            })
        }
    };
    quote! {
        impl #impl_generics #spacetimedb_lib::ser::Serialize for #name #ty_generics #where_clause {
            #fast_body
            // __ reserved name for binding to prevent name conflicts. See module-level doc comment.
            fn serialize<S: #spacetimedb_lib::ser::Serializer>(&self, __serializer: S) -> Result<S::Ok, S::Error> {
                #body
            }
        }
    }
}

fn variant_data(variant: &syn::Variant) -> syn::Result<Option<(syn::Member, &syn::Type)>> {
    let field = match &variant.fields {
        syn::Fields::Named(f) if f.named.len() == 1 => &f.named[0],
        syn::Fields::Named(_) => {
            return Err(syn::Error::new_spanned(
                &variant.fields,
                "must be a unit variant or a newtype variant",
            ))
        }
        syn::Fields::Unnamed(f) if f.unnamed.len() != 1 => {
            return Err(syn::Error::new_spanned(
                &variant.fields,
                "must be a unit variant or a newtype variant",
            ))
        }
        syn::Fields::Unnamed(f) => &f.unnamed[0],
        syn::Fields::Unit => return Ok(None),
    };
    let member = field
        .ident
        .clone()
        .map(Into::into)
        .unwrap_or_else(|| syn::Member::from(0));
    Ok(Some((member, &field.ty)))
}