fix(huffman): Handle edge cases and improve error handling#912
Merged
vil02 merged 10 commits intoTheAlgorithms:masterfrom Sep 26, 2025
Merged
fix(huffman): Handle edge cases and improve error handling#912vil02 merged 10 commits intoTheAlgorithms:masterfrom
vil02 merged 10 commits intoTheAlgorithms:masterfrom
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
requested changes
Sep 26, 2025
Member
vil02
left a comment
There was a problem hiding this comment.
The change looks good. One minor thing below.
vil02
approved these changes
Sep 26, 2025
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.
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.