-
Notifications
You must be signed in to change notification settings - Fork 144
Add support for reading from a byte-container for cbor and ubjson #469
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.
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @Ian-Flury, 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 significantly enhances the flexibility of the rfl library's CBOR and UBJSON deserialization capabilities. By introducing C++20 concepts for byte containers, the read functions can now seamlessly process data from various contiguous byte sources, making the library more adaptable to different data storage patterns and potentially improving performance by avoiding unnecessary data conversions.
Highlights
- New C++20 Concepts: Introduced a new
rfl/concepts.hppheader defining C++20 concepts such asByteLike,ContiguousByteContainer,MutableContiguousByteContainer,BackInsertableByteContainer, andByteSpanLike. These concepts provide a robust way to specify requirements for byte-oriented data structures. - Generalized Read Functions: The
readfunctions for CBOR and UBJSON deserialization have been updated to leverage the newContiguousByteContainerconcept. This change allows these functions to accept a wider variety of input types beyondstd::vector<char>, such asstd::array,std::string_view, andstd::span, improving flexibility and reducing the need for data copies. - Expanded Test Coverage: New test files (
tests/cbor/test_read_byte_containers.cpp,tests/ubjson/test_read_byte_containers.cpp,tests/generic/test_byte_containers.cpp) have been added to validate the new byte container concepts and demonstrate the generalizedreadfunctionality with different container types likestd::array<std::byte, ...>andstd::basic_string_view<std::byte>.
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 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 or fill out our survey 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request introduces a ContiguousByteContainer concept to allow cbor and ubjson read functions to work with a variety of byte containers, not just std::vector<char>. This enhances API flexibility. The changes include new concepts, updated function signatures, and tests. The feedback focuses on refining the C++ concepts for improved clarity.
| concept MutableContiguousByteContainer = ContiguousByteContainer<Container> && requires(Container& c) { | ||
| { c.data() } -> std::convertible_to<typename Container::value_type*>; | ||
| { c.begin() } -> std::output_iterator<typename Container::value_type>; | ||
| { c.end() } -> std::output_iterator<typename Container::value_type>; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The MutableContiguousByteContainer concept extends ContiguousByteContainer and adds requirements for mutable access. However, the checks for std::output_iterator on c.begin() and c.end() might be redundant and semantically confusing, as one cannot typically write to an end iterator. Relying on the non-const data() method on line 42 might be a clearer way to ensure mutability.
7209222 to
8a75449
Compare
|
@Ian-Flury thanks for your contribution. |
ContiguousByteContainerconcept.ContiguousByteContainer.jsonconslibrary's type traits, maybe ininclude/thirdparty/jsoncons_config.hpp.