test zlib API for all compatible backends #525
Merged
+277
−126
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
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive capability tests for zlib-specific API functions across all compatible backends (any_zlib and zlib-rs), excluding miniz_oxide which doesn't support these features. The PR builds on #524 which added set_dictionary and set_level support to the zlib-rs backend.
Key Changes:
- New test file tests zlib-specific APIs (window_bits configuration, dictionary support, compression level changes) for both any_zlib and zlib-rs backends
- Extended feature gates from
any_zlibonly toany(feature = "any_zlib", feature = "zlib-rs")for several functions - Implemented set_dictionary and set_level methods for the zlib-rs backend with proper error handling
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/capabilities.rs | New comprehensive test suite for zlib-specific functionality (window_bits, gzip, dictionaries, compression levels) |
| src/mem.rs | Updated feature gates to include zlib-rs, added set_dictionary and set_level method implementations for zlib-rs, removed redundant tests moved to capabilities.rs |
| src/ffi/zlib_rs.rs | Implemented set_dictionary and set_level for zlib-rs backend, added custom total_in/total_out tracking to exclude dictionary bytes |
| Cargo.toml | Bumped zlib-rs dependency from 0.5.3 to 0.5.5 for new API support |
| .github/workflows/main.yml | Enabled zlib-rs tests on mingw platform |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
After all, now it doesn't rely on a C compiler anymore.
…lib-rs` This spells out what was implied before. And it's something that has to be kept in sync with `zlib-rs`, until maybe one day it can return something completely unambiguous.
Some of these tests were previously gated and placed in such a way that `zlib-rs` was able to switch from its C-bindings to using its Rust API without implementing all zlib-implementation specific methods. The exstiing tests were unable to see this, and this commit adds a new capabiltiies test that will test these methods in all implementations but the `miniz_oxide`, which truly doesn't support them.
This release will finally make `zlib-rs` without C bindings public.
joshtriplett
reviewed
Jan 8, 2026
There has been a drift in implementation capabilities that makes the current internal feature toggles less suitable than they initially were. We fix this by introducing `any_c_zlib` to capture all zlib backends that need C bindings. Then there is `any_zlib` which is all backends that are fully zlib compatible.
Member
Author
|
CI is green, great! And I hope nothing more subtle broke. Please do review very carefully, maybe you can find something @joshtriplett . |
Member
|
Wrote a few comments; with those addressed, r=me. |
Member
Author
|
Thanks a lot for the review @joshtriplett, I think it makes it much better. |
joshtriplett
approved these changes
Jan 11, 2026
EliahKagan
added a commit
to EliahKagan/gitoxide
that referenced
this pull request
Jan 12, 2026
Because we no longer depend on it since bc2f339 (GitoxideLabs#2370). For context on the associated TODO this completes and removes, see: - rust-lang/flate2-rs#520 (superseded) - rust-lang/flate2-rs#524 - rust-lang/flate2-rs#525
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Add capabilities test for functions reserved to zlib-implementations.
Some of these tests were previously gated and placed in such a way that
zlib-rswas able to switch from its C-bindings to using its Rust API without implementing all zlib-implementation specific methods.The exstiing tests were unable to see this, and this commit adds a new capabiltiies test that will test these methods in all implementations but the
miniz_oxide, which truly doesn't support them.