uefi-raw: move types to new net module, improve convenience #1699
Conversation
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
We have enough network-related types to justify
a dedicated module:
- IpAddress
- Ipv4Address
- Ipv6Address
- MacAddress
And lots of corresponding impl{} blocks, tests, etc.
The union makes some things hard to work with, and we can simply remove it. We get multiple advantages from that: - no more chance to have uninitialized bytes - We can `Debug`-print the type - Some implementations become simpler
This helps to better understand why something fails.
check-raw is very strict. Relaxing it gives uefi-raw more freedom, which is especially needed for the more high-level IpAddress type changes.
|
|
||
| ## Changed | ||
| - Types `MacAddress`, `IpAddress`, `Ipv4Address`, and `Ipv6Address` were moved | ||
| from `uefi_raw::*` to `uefi_raw::net::*`. |
There was a problem hiding this comment.
I think moving the implementation to a new module makes sense, but I think for the public API it might make sense to let that be an internal detail, i.e. keep the net module private and pub-export the types from the crate root. These types are listed in the Common UEFI Data Types portion of the spec, which to mind means they fit best at the top level (and this would also avoid making the change API breaking).
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.
This prepares my vision for #1575, a split-out from #1645, and a change to uefi-raw in the sense that some types now have slightly more higher-level logic. This "higher-level" logic is still low-level enough that I think it is perfectly fine to keep it. It will also not hinder Rust-based UEFI implementations.
TL;DR: My vision is that in
uefiwe only exposecore::net::{IpAddr, Ipv4Addr, Ipv6Addr}and protocol implementations can useFrom/Intoto do all the necessary work under the hood.Let me know what you think!
List of Changes
IpAddresstype to be more convenient, more memory-safe, and pleasant to useFromimplementationscargo xtask check-rawrequirementsChecklist