Process trait improvements #3716
Conversation
| /// Header, returns 0. | ||
| fn binary_version(&self) -> u32; | ||
| /// in a TBF Program Header; if the binary has no version assigned, return [None] | ||
| fn binary_version(&self) -> Option<BinaryVersion>; |
There was a problem hiding this comment.
Previously, 0 marked the absence of the binary version. This approach works, but Option is the Rust way of doing this in my opinion.
Using a u32 for the binary version is too powerful: several operations defined on the integer type don't make sense, like addition or division. Or do they?
In the end, NonZeroU32 has been chosen as the underlying type of the new BinaryVersion type. This allows code generation optimizations. In my tests, the new version compiles exactly the same to the old code.
| @@ -612,7 +621,7 @@ pub trait Process { | |||
| driver_num: usize, | |||
| size: usize, | |||
| align: usize, | |||
| ) -> bool; | |||
| ) -> Result<(), ()>; | |||
There was a problem hiding this comment.
Result is the Rust way of signaling a function may fail. Additionally, Result triggers a warning when the return value is unused. From my little experiments, the new signature is compiled to the same code as the old one.
| /// `enter_custom_grant()` to get access to the memory and the pointer to | ||
| /// the memory which must be used to initialize the memory. | ||
| fn allocate_custom_grant( | ||
| &self, | ||
| size: usize, | ||
| align: usize, | ||
| ) -> Option<(ProcessCustomGrantIdentifier, NonNull<u8>)>; | ||
| ) -> Result<(ProcessCustomGrantIdentifier, NonNull<u8>), ()>; |
There was a problem hiding this comment.
This follows the pattern of returning a Result as allocate_grant.
Pull Request Overview
This pull request brings little improvements to the
Processtrait.Testing Strategy
This pull request was tested by running
libtock-capplications on STM32F429ZI Nucleo-144.TODO or Help Wanted
No help needed.
Documentation Updated
Formatting
make prepush.