Serialize/Deserialize vector<char> as bytestring
#466
Conversation
There was a problem hiding this comment.
Summary of Changes
Hello @bjia56, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request enhances the rfl serialization library by introducing explicit support for std::vector<char> as a distinct bytestring type. Previously, std::vector<char> might have been implicitly handled or required manual conversion; now, it can be directly serialized and deserialized as binary data across BSON, CBOR, MessagePack, and UBJSON formats. This change improves type safety and clarity for handling raw byte sequences that are represented by char vectors.
Highlights
- New Type Alias: Introduced
rfl::Vectorstringas a type alias forstd::vector<char>ininclude/rfl/Bytestring.hpp. This new alias explicitly represents byte strings composed ofcharelements, distinguishing them fromrfl::Bytestring(which usesstd::byte). - Serialization/Deserialization Support: Extended the
rfllibrary's BSON, CBOR, MessagePack, and UBJSON readers and writers to correctly serialize and deserializerfl::Vectorstringinstances. This ensures thatstd::vector<char>can be treated as raw binary data across these formats. - New Test Cases: Added dedicated test files (
test_vectorstring.cpp) for BSON, CBOR, MessagePack, and UBJSON. These tests verify the correct functionality ofrfl::Vectorstringserialization and deserialization, ensuring the new feature works as expected across different data formats.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request introduces serialization and deserialization support for std::vector<char> (aliased as rfl::Vectorstring) as a bytestring across BSON, CBOR, MessagePack, and UBJSON formats. A critical bug was identified in the BSON writer where object serialization for Vectorstring is not implemented. The new tests for CBOR, MessagePack, and UBJSON could be improved to cover array serialization of Vectorstring for better coverage.
| } else if constexpr (std::is_same<std::remove_cvref_t<T>, | ||
| rfl::Bytestring>()) { | ||
| rfl::Bytestring>() || | ||
| std::is_same<std::remove_cvref_t<T>, | ||
| rfl::Vectorstring>()) { |
There was a problem hiding this comment.
The add_value_to_object function (lines 127-159) has not been updated to handle rfl::Vectorstring. This will result in a compile-time error or incorrect behavior when serializing an object that contains a rfl::Vectorstring field.
Please apply a similar change to add_value_to_object to support rfl::Vectorstring.
|
@bjia56 , thanks for the PR. It is still marked as work in progress. When you want me to review (and merge) it, just mark it as "Ready for review". |
|
@liuzicheng1987 thanks for the reminder, I have marked the PR as ready |
|
Actually my apologies, this is not ready yet - I ran through some tests with my own project and Vectorstring is not yet optimal. I think there are a few specializations I am missing in the parser. Will ping once this is ready. |
|
@liuzicheng1987 ok I think this is ready now, thanks! |
|
@bjia56 , it looks good at first sight. The one thing I have noticed is that I don't think it is necessary to differentiate between Bytestring and Vectorstring in Schema::Type, because to any serialization format these two are the same anyway. |
Resolves #459