Api alignment: Config alignment #188
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
…ig, and associating it with a native config.
- renaming Config.from to Config.fromFile - Adding tests - Adding or improving KDocs on Config
|
PR missing one of the required labels: breaking-change bug dependencies documentation enhancement new feature internal |
DariusIMP
added
enhancement
sashacmc
reviewed
Sep 2, 2024
| /// | ||
| #[no_mangle] | ||
| #[allow(non_snake_case)] | ||
| pub extern "C" fn Java_io_zenoh_jni_JNIConfig_00024Companion_loadDefaultConfigViaJNI( |
There was a problem hiding this comment.
Is this an automatically generated code? The names look a bit strange.
There was a problem hiding this comment.
No, its not 😅 . It's strange because it's meant to be called from Kotlin through the JNI by a function named loadDefaultConfigViaJNI located at io/zenoh/jni/JNIConfig$Companion. It must have this weird looking signature for Java/Kotlin to locate the corresponding native function.
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
Changes:
Config.FormatenumConfig.from(string, format)withConfig.fromJson(string),Config.fromJson5(string),Config.fromYaml(string), where each of these functions returns aResult<Config>.Config.from(file)withConfig.fromFile(File file): Result<Config>andConfig.fromFile(Path path): Result<Config>.Config.default()still returns a Config (without result, as it's guaranteed it is successfully created by the library).Internally, when creating a config, the value provided is processed natively, associating each Config instance to a native config instance. The native instance of the config is freed when the Kotlin Config is garbage collected.