refactor: validate Fdt on construction
#23
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
This makes the APIs more ergonomic, as most of the methods that used to return `Result<T, E>`, return `T` now instead, making it much easier to work with, especially in case of iterators. This obviously causes the constructor to run in linear time, which shouldn't be a huge problem considering that any sensible use of the parser will require linear-time traversal time anyway. In case this would be a problem, however, a separate constructor that skips the validation (and causes the traverse methods to panic instead) is added. This also allows us to unify some error handling between in-memory and internal representation APIs, bringing us closer to unifying these two APIs under a common trait, and supporting the "standard nodes & properties" for the internal representation variant.
qwandor
reviewed
Dec 24, 2025
| /// | ||
| /// # Errors | ||
| /// | ||
| /// Returns `FdtError::TooManyCells` if the child-bus-address doesn't fit in |
Collaborator
There was a problem hiding this comment.
This comment needs updating, it is now StandardError rather than FdtError.
| /// | ||
| /// # Errors | ||
| /// | ||
| /// Returns `FdtError::TooManyCells` if the parent-bus-address doesn't fit |
Collaborator
There was a problem hiding this comment.
StandardError rather than FdtError.
| /// | ||
| /// # Errors | ||
| /// | ||
| /// Returns `FdtError::TooManyCells` if the address doesn't fit in `T`. |
| #[error( | ||
| "prop-encoded-array property was {size} bytes, but should have been a multiple of {chunk} cells" | ||
| )] | ||
| PropEncodedArraySizeMismatch { |
Collaborator
There was a problem hiding this comment.
This should be a PropertyError.
| @@ -0,0 +1,238 @@ | |||
| // Copyright 2025 Google LLC | |||
Collaborator
There was a problem hiding this comment.
https://doc.rust-lang.org/reference/items/modules.html#r-items.mod.outlined.search-mod recommends naming module files like src/standard.rs rather than src/standard/mod.rs, since Rust 1.30. It makes it easier to find the right file when searching by filename in an editor or codesearch.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 makes the APIs more ergonomic, as most of the methods that used to return
Result<T, E>, returnTnow instead, making it much easier to work with, especially in case of iterators.This obviously causes the constructor to run in linear time, which shouldn't be a huge problem considering that any sensible use of the parser will require linear-time traversal time anyway. In case this would be a problem, however, a separate constructor that skips the validation (and causes the traverse methods to panic instead) is added.
This also allows us to unify some error handling between in-memory and internal representation APIs, bringing us closer to unifying these two APIs under a common trait, and supporting the "standard nodes & properties" for the internal representation variant.