[codec] Add Checksummed type - #4483
Open
crazywriter1 wants to merge 2 commits into
Open
Conversation
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes using high effort and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 08c115b. Configure here.
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
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.

Closes #1704.
Summary
Adds
Checksummed<T, C>, a wrapper that appends a checksum of a value's encoding when writing and verifies it when reading. This lets anyCodectype detect accidental corruption at rest or in transit without each caller hand-rolling the framing.The wrapper is generic over a new
Checksummertrait rather than over a hasher fromcommonware-cryptography, since the hashing crates depend oncommonware-codecand the reverse dependency isn't possible.Checksummer::Digestis anyFixedSizecodec type, so implementations can range from a CRC to a cryptographic digest.Details worth calling out for review:
Read::Cfgforwards toT::Cfg, so wrapping a type doesn't change how it is configured. Config-driven failures (e.g. aRangeCfgrejection) surface before any checksum work.PhantomData<fn() -> C>marker keeps the wrapper's auto traits independent ofC.Testing
encode_sizeagreement with the written bytes, corrupted payload and corrupted checksum rejection, a missing trailing checksum, and thatreadconsumes exactly one value from a buffer holding more.ChecksummerandChecksummed.just pre-prpasses, including theno_stdbuild (the type adds nostdusage).