Repository navigation
feat(kv-ir): Add a function signature C++ concept for the callback called when a new projected schema-tree node is read. #859
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
Merged
LinZhihao-723
merged 4 commits into
y-scope:main
from
LinZhihao-723:projection-resolution-callback
Apr 27, 2025
Merged
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
34 changes: 34 additions & 0 deletions
34
components/core/src/clp/ffi/ir_stream/search/ProjectionResolutionCallbackReq.hpp
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| #ifndef CLP_FFI_IR_STREAM_SEARCH_PROJECTIONRESOLUTIONCALLBACKREQ_HPP | ||
| #define CLP_FFI_IR_STREAM_SEARCH_PROJECTIONRESOLUTIONCALLBACKREQ_HPP | ||
|
|
||
| #include <string_view> | ||
| #include <type_traits> | ||
|
|
||
| #include <outcome/single-header/outcome.hpp> | ||
|
|
||
| #include "../../SchemaTree.hpp" | ||
|
|
||
| namespace clp::ffi::ir_stream::search { | ||
| /** | ||
| * Concept that defines the callback function signature for projection resolution. | ||
| * @tparam ProjectionResolutionCallbackType | ||
| * | ||
| * Callback parameters: | ||
| * - `bool is_auto_generated`: Whether the schema tree node is auto-generated. | ||
| * - `SchemaTree::Node::id_t schema_tree_node_id`: The ID of the resolved schema tree node. | ||
| * - `std::string_view key_path`: The key path of the resolved projection. | ||
| * | ||
| * Callback return values: | ||
| * - A void result on success. | ||
| * - A user-defined error code indicating the failure. | ||
| */ | ||
|
LinZhihao-723 marked this conversation as resolved.
Resolved
|
||
| template <typename ProjectionResolutionCallbackType> | ||
| concept ProjectionResolutionCallbackReq = std::is_invocable_r_v< | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. How about
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. As discussed offline, we decided to use |
||
| outcome_v2::std_result<void>, | ||
| ProjectionResolutionCallbackType, | ||
| bool, | ||
| SchemaTree::Node::id_t, | ||
| std::string_view>; | ||
| } // namespace clp::ffi::ir_stream::search | ||
|
|
||
| #endif // CLP_FFI_IR_STREAM_SEARCH_PROJECTIONRESOLUTIONCALLBACKREQ_HPP | ||
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.
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.
@kirkrodrigues Do u have any suggestions on how to document such a signature?