-
-
Notifications
You must be signed in to change notification settings - Fork 2.5k
fix(huffman): Handle edge cases and improve error handling #912
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
- Change HuffmanDictionary::new() to return Option<Self> for safer API - Add proper handling for empty alphabet (returns None) - Add special case handling for single-symbol alphabets - Replace unwrap() calls with ? operator in decode() for better error handling - Add #[inline(always)] optimization for frequently called get_bit() - Add comprehensive tests for edge cases - Improve documentation with usage examples BREAKING CHANGE: HuffmanDictionary::new() now returns Option<Self>
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #912 +/- ##
==========================================
+ Coverage 95.32% 95.33% +0.01%
==========================================
Files 319 319
Lines 20807 20890 +83
==========================================
+ Hits 19834 19916 +82
- Misses 973 974 +1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Adds two new test cases to ensure 100% patch coverage for HuffmanEncoding::decode: 1. test_decode_empty_encoding_struct: Covers the edge case where num_bits == 0. 2. minimal_decode_end_check: Ensures the final 'if self.num_bits > 0' check in the multi-symbol decode path is fully covered.
Corrects 'char-lit-as-u8' and 'unnecessary-cast' lints in the newly added coverage tests to satisfy GitHub Actions.
vil02
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The change looks good. One minor thing below.
Description
This PR improves the robustness of the Huffman encoding implementation by properly handling edge cases that previously caused undefined behavior or panics.
Summary of changes:
HuffmanDictionary::new()to returnOption<Self>for safer API designNoneinstead of panicking)decode()by replacingunwrap()calls with?operator#[inline(always)]optimization for the frequently-calledget_bit()methodThe Huffman encoding algorithm is a well-known lossless data compression algorithm. More details: https://en.wikipedia.org/wiki/Huffman_coding
Note: During development, I observed intermittent heap corruption errors in the test suite that occur even without these changes, suggesting pre-existing issues in the codebase.
Type of change
Please delete options that are not relevant.
Checklist:
cargo clippy --all -- -D warningsjust before my last commit and fixed any issue that was found.cargo fmtjust before my last commit.cargo testjust before my last commit and all tests passed.mod.rsfile within its own folder, and in any parent folder(s).DIRECTORY.mdwith the correct link.CONTRIBUTING.mdand my code follows its guidelines.Please make sure that if there is a test that takes too long to run ( > 300ms), you
#[ignore]that ortry to optimize your code or make the test easier to run. We have this rule because we have hundreds of
tests to run; If each one of them took 300ms, we would have to wait for a long time.