Refactor: make more modules private #772
Merged
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.
This will be the first of a handful of refactoring PRs. The goal is to minimize our API surface and only export what needs to be exported. Hopefully none of these changes are too controversial, I think it should be quite straight-forward.
Starting with some modules: the
commandandelfmodules contain implementation details which are used internally, and don't need to be exposed to users. Additionally, theerrormodules only contains one type which needs to be public,Error, which is now exported at the root of the package.In addition to these changes, I have done some general cleanup and removed some unused code.
I have also decided that we do not need to document the modules/types gated behind the
clifeature. This is all intended for use only for thecargo-espflashandespflashbinaries, it's really of no concern to people usingespflashas a library.