Mark Encoding::BIT_PACKED as deprecated and document its compatibility issues #5348
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.
Which issue does this PR close?
Related to #5338.
Rationale for this change
This marks
Encoding::BIT_PACKED
as deprecated, so that users will get notified if they explicitly use it for a v1LevelEncoder
.We probably can't remove or fix the encoding without a lengthy deprecation cycle since users might want to roundtrip existing files using the incorrect bit order, but they should at least be made aware of the compatibility issues.
The
encoding
module should be behind theexperimental
feature flag, so hopefully not many people are using this api and we might be able to create a spec compliant implementation in the future.What changes are included in this PR?
Are there any user-facing changes?