Add a simple file header to binary files created by measureme. #41
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
measureme/src/file_header.rs
Outdated
| bytes: &[u8], | ||
| expected_magic: &[u8; 4] | ||
| ) -> Result<u32, Box<dyn Error>> { | ||
| debug_assert_eq!(FILE_HEADER_SIZE, 8); |
There was a problem hiding this comment.
I'm a bit confused by these asserts -- they don't need to be debug as I expect LLVM to constant-fold them away, and either way I'm not sure what this is intended to do (i.e., because we're comparing against a constant declared in this file). Maybe a comment on the constant that these functions need updating would be better?
There was a problem hiding this comment.
The assertions are meant to be an extra safeguard against accidentally changing something here. I'd like to leave them in (since it's easy to overlook a comment but not so easy to overlook CI going red). I'll add some comments explaining their purpose though.
michaelwoerister
force-pushed
the
file-header
branch
from
0d4bb04 to
b1b16c4
Compare
michaelwoerister
force-pushed
the
file-header
branch
from
b1b16c4 to
ddd0f9c
Compare
|
I've added some comments and tried to address @Mark-Simulacrum's remarks. |
wesleywiser
approved these changes
May 10, 2019
Merged
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 PR implements a minimal version of file format compatibility checking.
r? @wesleywiser
Closes #40