Elaborate on ip_addr bit conversion endianness #118505
Merged
Conversation
This file contains 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
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @cuviper (or someone else) soon. Please see the contribution instructions for more information. Namely, in order to ensure the minimum review times lag, PR authors and assigned reviewers should ensure that the review label (
|
rustbot
added
S-waiting-on-review
cuviper
reviewed
Dec 5, 2023
library/core/src/net/ip_addr.rs
Outdated
| /// Although IPv4 addresses are big-endian, the `u32` value will use the target platform's | ||
| /// native byte order. That is, the `u32` value is an integer representation of the IPv4 | ||
| /// address and not an integer interpretation of the IPv4 address's big-endian bitstring. This | ||
| /// means that the `u32` value `&` with `0xffffff00` will set the last octet in the address to |
There was a problem hiding this comment.
Using the & operator as a verb seems confusing to me -- maybe we can leave that to the example and use "masked" here?
Suggested change
| /// means that the `u32` value `&` with `0xffffff00` will set the last octet in the address to | |
| /// means that the `u32` value masked with `0xffffff00` will set the last octet in the address to |
There was a problem hiding this comment.
That sounds a lot better, thanks. Update pushed.
library/core/src/net/ip_addr.rs
Outdated
| /// Although IPv6 addresses are big-endian, the `u128` value will use the target platform's | ||
| /// native byte order. That is, the `u128` value is an integer representation of the IPv6 | ||
| /// address and not an integer interpretation of the IPv6 address's big-endian bitstring. This | ||
| /// means that the `u128` value `&` with `0xffffffffffffffffffffffffffff0000_u128` will set the |
There was a problem hiding this comment.
Same confusion and suggestion as above.
Suggested change
| /// means that the `u128` value `&` with `0xffffffffffffffffffffffffffff0000_u128` will set the | |
| /// means that the `u128` value masked with `0xffffffffffffffffffffffffffff0000_u128` will set the |
Adds explanation of how endianness is handled when converting `Ipv4Addr` and `Ipv6Addr` to and from bits. Addresses rust-lang#113744
CLEckhardt
force-pushed
the
update_ip_addr_bits_docs
branch
from
73382cb to
c3bb1b5
Compare
|
The job Click to see the possible cause of the failure (guessed by this bot) |
|
@rustbot review |
|
Looks good! @bors r+ rollup |
bors
added
S-waiting-on-bors
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Dec 8, 2023
…iaskrgr Rollup of 8 pull requests Successful merges: - rust-lang#118505 (Elaborate on ip_addr bit conversion endianness) - rust-lang#118581 (OnceLock: Add note about drop and statics) - rust-lang#118677 ([rustdoc] Fix display of features) - rust-lang#118690 (coverage: Avoid unnecessary macros in unit tests) - rust-lang#118693 (Tell MirUsedCollector that the pointer alignment checks calls its panic symbol) - rust-lang#118695 (coverage: Merge refined spans in a separate final pass) - rust-lang#118709 (fix jobserver GLOBAL_CLIENT_CHECKED uninitialized before use) - rust-lang#118722 (rustdoc: remove unused parameter `reversed` from onEach(Lazy)) r? `@ghost` `@rustbot` modify labels: rollup
rust-timer
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Dec 8, 2023
Rollup merge of rust-lang#118505 - CLEckhardt:update_ip_addr_bits_docs, r=cuviper Elaborate on ip_addr bit conversion endianness Adds explanation of how endianness is handled when converting `Ipv4Addr` and `Ipv6Addr` to and from bits. This is intended to unblock stabilization of the affected methods. Addresses rust-lang#113744
5 tasks
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.
Adds explanation of how endianness is handled when converting
Ipv4AddrandIpv6Addrto and from bits. This is intended to unblock stabilization of the affected methods.Addresses #113744