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

core: Flatten public module structure #190

Merged
merged 1 commit into from
Dec 20, 2024
Merged

core: Flatten public module structure #190

merged 1 commit into from
Dec 20, 2024

Conversation

robin-nitrokey
Copy link
Member

This patch makes some modules of the core crate private and re-exports their contents from the crate root. This has two benefits: It makes it easier to read the crate documentation because the most important types are directly visible from the root. And it makes the imports for the most important types less verbose.

See also: #155


Summary of the changes:

  • client::*Client, interrupt::*, error::* are moved to the top level
  • the mechanism traits are moved to a top-level mechanisms module

This patch makes some modules of the core crate private and re-exports
their contents from the crate root.  This has two benefits:  It makes
it easier to read the crate documentation because the most important
types are directly visible from the root.  And it makes the imports for
the most important types less verbose.

See also: #155
@robin-nitrokey robin-nitrokey merged commit 8a9bb9d into main Dec 20, 2024
2 checks passed
@robin-nitrokey robin-nitrokey deleted the core-modules branch December 20, 2024 09:26
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 this pull request may close these issues.

2 participants