Serialization refactor: macros for value/row serialization #851
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
piodul
force-pushed
the
serialization-refactor-macros
branch
from
d076162 to
bcd3b16
Compare
8 tasks
piodul
force-pushed
the
serialization-refactor-macros
branch
from
bcd3b16 to
0b95f92
Compare
|
v2:
|
piodul
force-pushed
the
serialization-refactor-macros
branch
from
0b95f92 to
4ea5a69
Compare
|
v2.1: address clippy's complaint |
piodul
force-pushed
the
serialization-refactor-macros
branch
from
4ea5a69 to
dc58365
Compare
piodul
changed the title
piodul
force-pushed
the
serialization-refactor-macros
branch
from
dc58365 to
571b31c
Compare
|
v2.2:
|
No problem, my bad - the description of the other PR was misleading. |
Lorak-mmk
requested changes
Nov 29, 2023
piodul
force-pushed
the
serialization-refactor-macros
branch
from
571b31c to
cf63068
Compare
|
v3:
|
8 tasks
Lorak-mmk
reviewed
Dec 1, 2023
12 tasks
piodul
force-pushed
the
serialization-refactor-macros
branch
2 times, most recently
from
480b5e2 to
938ed26
Compare
|
v4:
@Lorak-mmk - I manually checked that the test you commented out in your PR now compiles, so you can rebase. |
Lorak-mmk
approved these changes
Dec 9, 2023
Introduce a derive macro which serializes a struct into a UDT. Unlike the previous IntoUserType, the new macro takes care to match the struct fields to UDT fields by their names. It does not assume that the order of the fields in the Rust struct is the same as in the UDT.
Introduce a derive macro which serializes a struct into bind markers of a statement. Unlike the previous ValueList, the new macro takes care to match the struct fields to bind markers/columns by their names.
Some users might not need the additional robustness of `SerializeCql` that comes from sorting the fields before serializing, as they are used to the current behavior of `Value` and properly set the order of the fields in their Rust struct. In order to give them some performance boost, add an additional mode to `SerializeCql` called "enforce_order" which expects that the order of the fields in the struct is kept in sync with the DB definition of the UDT. It's still safe to use because, as the struct fields are serialized, their names are compared with the fields in the UDT definition order and serialization fails if the field name on some position is mismatched.
Like in the case of `SerializeRow`, some people might be used to working with the old `ValueList` and already order their Rust struct fields with accordance to the queries they are used with and don't need the overhead associated with looking up columns by name. The `enforce_order` mode is added to `SerializeRow` which works analogously as in `SerializeCql` - expects the columns to be in the correct order and verifies that this is the case when serializing, but just fails instead of reordering if that expectation is broken.
piodul
force-pushed
the
serialization-refactor-macros
branch
from
938ed26 to
a255d81
Compare
Done. v4.1: added some minimal tests for UDTs/rows with generics in them, mostly to see whether they compile or not |
Lorak-mmk
approved these changes
Dec 9, 2023
This was referenced Dec 21, 2023
7 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Introduce derive macros for both of the new serialization traits:
SerializeCqlandSerializeRow. They allow to serialize given Rust struct either into a UDT value or a list of values for a query.The most significant difference from the previous
IntoUserTypeandValueListis that the new macros match the Rust struct fields to UDT fields or columns by name. This makes the macros less error-prone to use, especially in the UDT case.For users which are already used to the old macros and are willing to guarantee the field order but do not want to pay performance cost associated with sorting the fields, a separate "flavor" is introduced. With that flavor enabled, the generated code expects that the field order is correct. The field names are still checked - if the expectation about the matching fields is broken serialization will just fail.
Depends on #862
Refs: #802
Pre-review checklist
./docs/source/.Fixes:annotations to PR description.