refactor(bytes): clarify shared alignment assertions - #841
Merged
Conversation
Replace array-underflow checks with const assert expressions. Add diagnostics that explain the pointer-tagging alignment invariant. Signed-off-by: bestgopher <84328409@qq.com>
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
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.
Summary
This PR replaces the array-underflow-based compile-time checks:
with explicit const assertions:
This change is neither a bug fix nor a new feature. It preserves the
existing behavior and alignment invariant, while expressing that invariant
in a more direct and readable form.
Motivation
The current array-length expression works, but it is not particularly
beginner-friendly. A reader must work out that an odd alignment makes
mem::align_of::() % 2 equal to 1, which then causes 0 - 1 to
fail during const evaluation.
Using assert! states the requirement directly and also provides a clearer
diagnostic if the invariant is ever violated.
MSRV compatibility
Using assert! in a const context is supported starting with Rust 1.57,
as part of the stabilization of [panic! in const
contexts (https://blog.rust-lang.org/2021/12/02/Rust-1.57.0/#panic-in-const-contexts).
The bytes crate already declares Rust 1.57 as its
MSRV (https://github.com/tokio-rs/bytes/blob/master/Cargo.toml#L9), so this
change does not raise the minimum supported Rust version.
Validation
This is intentionally a small readability-only change. If the maintainers
consider it unnecessary or prefer the existing idiom, please feel free to
close this PR.