Expose more dictionary APIs in the C API #6235
Merged
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
ironage
approved these changes
Jan 25, 2023
| * @param out_keys the list of keys in the dictionary | ||
| * @return True if no exception occurred. | ||
| */ | ||
| RLM_API bool realm_dictionary_get_keys(realm_dictionary_t*, size_t* out_size, realm_results_t** out_keys); |
There was a problem hiding this comment.
Maybe this is conventional in the C API, but returning ownership of newly allocated memory to the caller seems dangerous and IMO at least warrants a note about this in the doc string.
There was a problem hiding this comment.
It is dangerous, I agree. But it is how the C-API works. The memory has to be freed once it is not used any more. The issue is always the same, we don't have a way to tell the caller if there was a problem due to some exception or if the dictionary was simply empty. We can't use nullptr for both.
I will add a comment in the doc string.
Co-authored-by: James Stone <james.stone@mongodb.com>
…realm-core into nc/add_support_dictionaries_c_api
|
Merging this PR since failures are unrelated to the change. There is something odd with the Sync Tests, and most of the tasks timed out. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
What, How & Why?
Fixes: #6181
☑️ ToDos