Support custom crc parameters #11
Open
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
Enables anyone to BYOP (bring your own parameters). See: awesomized#5
There was a problem hiding this comment.
Pull Request Overview
This PR introduces support for custom CRC parameters in the library and its C-compatible shared library. Key changes include:
- Adding new functions (new_with_params, checksum_with_params, checksum_file_with_params) in Rust to support custom CRC parameters.
- Extending FFI bindings in Rust and updating the C header (libcrc_fast.h) to expose the new API.
- Adding test coverage for the new functionality.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/lib.rs | New functions for custom CRC parameters added, along with corresponding tests. |
| src/ffi.rs | FFI functions added to support the new custom parameter API. |
| libcrc_fast.h | Updated header file exposing the new API for custom parameters. |
Comments suppressed due to low confidence (1)
src/lib.rs:618
- The variable 'digest' is declared but never used in this test. Consider removing it to avoid confusion.
let mut digest = Digest::new(config.get_algorithm());
jg15
reviewed
Jun 11, 2025
- Crc32Custom and Crc64Custom CrcAlgorithms - checksum_combine_with_custom_params() function - get_custom_params() function - test coverage for the above
Enables easier integration for consumers who would like to use custom CRC parameters, such as polynomials.
- Adds the Crc32Custom and Crc64Custom CrcFastAlgorithms - Adds the crc_fast_checksum_combine_with_custom_params() function - Adds the crc_fast_get_custom_params() function
jg15
reviewed
Jun 12, 2025
jg15
reviewed
Jun 12, 2025
Replaces get_custom_params() with CrcParams::new(). awesomized#11 (comment)
jg15
approved these changes
Jun 13, 2025
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.
The Problem
While the list of hardcoded supported CRC variants is comprehensive, covering all the known CRC-32 and CRC-64 variants, it may be useful to support arbitrary custom parameters for future or unknown variants.
The Solution
Add support for custom CRC parameters.
Changes
Planned version bump
MINORLinks