Skip to content
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

Hide internal modules #605

Open
wenkokke opened this issue Mar 3, 2025 · 0 comments · May be fixed by #606
Open

Hide internal modules #605

wenkokke opened this issue Mar 3, 2025 · 0 comments · May be fixed by #606

Comments

@wenkokke
Copy link
Collaborator

wenkokke commented Mar 3, 2025

We would like to hide the internal modules from the public API. After discussion, there are three options:

  1. Publicly export the internal modules under the Database.LSMTree.Internal namespace.
  2. Migrate the internal modules to a private sub-library.
  3. Migrate all modules to a private sub-library,
    then create modules in the public library that re-export the public modules.

Our consensus is that we should not make any of these changes now, since all of these affect too many files, but that we should settle on which of the three options we should use before we cut our first release.

Overall, we felt positive about options (2) or (3), but were slightly divided between the two options. Option (3) is likely easier for developers and maintainers, but there was a fear that it might have a slightly higher performance impact. Hence, if we choose option (2) or (3) we should benchmark the change to see if there is any performance impact from the potential loss of inlining that might result from this rewrite.

@wenkokke wenkokke linked a pull request Mar 3, 2025 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant