Skip to content

Implemented type-safe primary keys #3476

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
+44 −11
Draft

Implemented type-safe primary keys #3476

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2a16a17
Implemented newtype pattern support for tuples.
egormanga Jul 19, 2025
0425895
Removed duplicate/outdated code.
egormanga Oct 22, 2025
879ee2c
Implemented type-safe primary keys.
egormanga Oct 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions crates/bindings-macro/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ proc-macro2.workspace = true
quote.workspace = true
syn.workspace = true
heck.workspace = true
proc-macro-type-name = "0.1.0"

[lints]
workspace = true
17 changes: 9 additions & 8 deletions crates/bindings-macro/src/sats.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -380,8 +380,9 @@ pub(crate) fn derive_deserialize(ty: &SatsType<'_>) -> TokenStream {

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_members = fields.iter().enumerate().map(|(ii, f)| f.ident.map_or_else(|| ii.into(), |v| v.clone().into())).collect::<Vec<syn::Member>>();
let field_names = fields.iter().enumerate().map(|(ii, f)| f.ident.map_or_else(|| syn::Ident::new(("_".to_owned() + &ii.to_string()).as_ref(), Span::call_site()), |v| v.clone())).collect::<Vec<_>>();
let field_strings = fields.iter().enumerate().map(|(ii, f)| f.name.clone().unwrap_or_else(|| ii.to_string())).collect::<Vec<_>>();
let field_types = fields.iter().map(|f| &f.ty);
let field_types2 = field_types.clone();
quote! {
Expand Down Expand Up @@ -414,7 +415,7 @@ pub(crate) fn derive_deserialize(ty: &SatsType<'_>) -> TokenStream {

fn visit_seq_product<A: #spacetimedb_lib::de::SeqProductAccess<'de>>(self, mut tup: A) -> Result<Self::Output, A::Error> {
Ok(#name {
#(#field_names:
#(#field_members:
tup.next_element::<#field_types>()?
.ok_or_else(|| #spacetimedb_lib::de::Error::invalid_product_length(#iter_n, &self))?,)*
})
Expand All @@ -434,7 +435,7 @@ pub(crate) fn derive_deserialize(ty: &SatsType<'_>) -> TokenStream {
}
}
Ok(#name {
#(#field_names:
#(#field_members:
#field_names.ok_or_else(|| #spacetimedb_lib::de::Error::missing_field(#iter_n3, Some(#field_strings), &self))?,)*
})
}
Expand Down Expand Up @@ -595,13 +596,13 @@ pub(crate) fn derive_serialize(ty: &SatsType) -> TokenStream {
});
}

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 field_members = fields.iter().enumerate().map(|(ii, f)| f.ident.map_or_else(|| ii.into(), |v| v.clone().into())).collect::<Vec<syn::Member>>();
let field_strings = fields.iter().enumerate().map(|(ii, f)| f.name.clone().unwrap_or_else(|| ii.to_string())).collect::<Vec<_>>();
let field_types = fields.iter().map(|f| &f.ty);
let nfields = fields.len();
quote! {
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::serialize_element::<#field_types>(&mut __prod, Some(#field_strings), &self.#field_members)?;)*
#spacetimedb_lib::ser::SerializeNamedProduct::end(__prod)
}
}
Expand Down
17 changes: 17 additions & 0 deletions crates/bindings-macro/src/table.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ use crate::sym;
use crate::util::{check_duplicate, check_duplicate_msg, ident_to_litstr, match_meta};
use core::slice;
use heck::ToSnakeCase;
use proc_macro_type_name::ToTypeName;
use proc_macro2::{Span, TokenStream};
use quote::{format_ident, quote, quote_spanned, ToTokens};
use std::borrow::Cow;
Expand Down Expand Up @@ -784,6 +785,9 @@ pub(crate) fn table_impl(mut args: TableArgs, item: &syn::DeriveInput) -> syn::R
}
};

let pk_type = primary_key_column.clone().map(|x| x.ty);
let pk_type_ident = primary_key_column.clone().map(|x| Ident::new(&(original_struct_ident.to_string() + &(&x.ident).to_type_ident(x.ident.span()).to_string()), x.ident.span()));

let (schedule, schedule_typecheck) = args
.scheduled
.as_ref()
Expand Down Expand Up @@ -887,6 +891,18 @@ pub(crate) fn table_impl(mut args: TableArgs, item: &syn::DeriveInput) -> syn::R
};

// Output all macro data

let trait_def_pk = pk_type.map(|pk_type| quote_spanned! {table_ident.span()=>
#[allow(dead_code)]
#[derive(SpacetimeType)]
struct #pk_type_ident(#pk_type);
impl std::borrow::Borrow<#pk_type> for #pk_type_ident {
fn borrow(&self) -> &#pk_type {
&self.0
}
}
});

let trait_def = quote_spanned! {table_ident.span()=>
#[allow(non_camel_case_types, dead_code)]
#vis trait #table_ident {
Expand Down Expand Up @@ -931,6 +947,7 @@ pub(crate) fn table_impl(mut args: TableArgs, item: &syn::DeriveInput) -> syn::R
#default_type_check
};

#trait_def_pk
#trait_def
#trait_def_view

Expand Down
4 changes: 2 additions & 2 deletions crates/sats/src/ser/impls.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,8 +102,8 @@ impl Serialize for u8 {

impl_serialize!([] F32, (self, ser) => f32::from(*self).serialize(ser));
impl_serialize!([] F64, (self, ser) => f64::from(*self).serialize(ser));
impl_serialize!([T: Serialize] Vec<T>, (self, ser) => (**self).serialize(ser));
impl_serialize!([T: Serialize, const N: usize] SmallVec<[T; N]>, (self, ser) => (**self).serialize(ser));
impl_serialize!([T: Serialize] Vec<T>, (self, ser) => (**self).serialize(ser));
impl_serialize!([T: Serialize, const N: usize] SmallVec<[T; N]>, (self, ser) => (**self).serialize(ser));
impl_serialize!([T: Serialize] [T], (self, ser) => T::__serialize_array(self, ser));
impl_serialize!([T: Serialize, const N: usize] [T; N], (self, ser) => T::__serialize_array(self, ser));
impl_serialize!([T: Serialize + ?Sized] Box<T>, (self, ser) => (**self).serialize(ser));
Expand Down
6 changes: 5 additions & 1 deletion crates/sats/src/typespace.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -399,9 +399,10 @@ impl_primitives! {
String => String,
}

impl_st!([](), AlgebraicType::unit());
impl_st!([] (), AlgebraicType::unit());
impl_st!([] str, AlgebraicType::String);
impl_st!([T] [T], ts => AlgebraicType::array(T::make_type(ts)));
impl_st!([T, const N: usize] [T; N], ts => AlgebraicType::array(T::make_type(ts)));
impl_st!([T: ?Sized] &T, ts => T::make_type(ts));
impl_st!([T: ?Sized] Box<T>, ts => T::make_type(ts));
impl_st!([T: ?Sized] Rc<T>, ts => T::make_type(ts));
Expand All @@ -410,6 +411,9 @@ impl_st!([T] Vec<T>, ts => <[T]>::make_type(ts));
impl_st!([T, const N: usize] SmallVec<[T; N]>, ts => <[T]>::make_type(ts));
impl_st!([T] Option<T>, ts => AlgebraicType::option(T::make_type(ts)));

impl_st!([U] (U,), ts => AlgebraicType::product([U::make_type(ts)]));
impl_st!([U, V: SpacetimeType] (U, V), ts => AlgebraicType::product([U::make_type(ts), V::make_type(ts)]));

impl_st!([] spacetimedb_primitives::ColId, AlgebraicType::U16);
impl_st!([] spacetimedb_primitives::TableId, AlgebraicType::U32);
impl_st!([] spacetimedb_primitives::ViewId, AlgebraicType::U32);
Expand Down