khepri_tree: Make tree_v*() and keep_while_conds_revidx_v*() opaque types#299
Merged
Conversation
dumbbell
changed the title
tree_v*() and `keep_while_conds_revidx_v*() opaque typestree_v*() and keep_while_conds_revidx_v*() opaque types
…ue types
[Why]
They should only be known by `khepri_tree`.
[How]
The definition of `#tree{}` is moved to the `khepri_tree` module and
accessor functions are added and exported.
The types `tree()` and `keep_while_conds_revidx()` are kept as regular
types because the opaque subtypes they group together are used directly.
Moreover, if the generic types were marked as opaque too, Dialyzer would
enter some infinite loop and never return.
[Why]
It no longer defines `#tree{}` and is now dedicated to the definition of
`#node{}`.
dumbbell
force-pushed
the
make-tree-type-opaque
branch
from
7067602 to
e4b9f4a
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #299 +/- ##
==========================================
+ Coverage 89.69% 89.70% +0.01%
==========================================
Files 22 22
Lines 3259 3263 +4
==========================================
+ Hits 2923 2927 +4
Misses 336 336
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
the-mikedavis
approved these changes
Oct 1, 2024
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Why
They should only be known by
khepri_tree.How
The definition of
#tree{}is moved to thekhepri_treemodule and accessor functions are added and exported.The types
tree()andkeep_while_conds_revidx()are kept as regular types because the opaque subtypes they group together are used directly. Moreover, if the generic types were marked as opaque too, Dialyzer would enter some infinite loop and never return.At the same time, we rename
khepri_tree.hrltokhepri_node.hrl. It no longer defines#tree{}and is now dedicated to the definition of#node{}.