Repository navigation
feat(quickcache): make quick_cache features optional - #180
Open
beanow-at-crabnebula wants to merge 2 commits into
Open
beanow-at-crabnebula wants to merge 2 commits into
beanow-at-crabnebula wants to merge 2 commits into
Conversation
Forward parking_lot and custom-hasher through crate features. Keep both enabled by default to preserve existing behavior. Document the opt-out in the README, API docs, mdbook, and changelog. Test default and opt-out configurations in CI. ### Why Downstream users cannot disable quick_cache defaults through this crate. Small, infrequently used caches may prefer standard library primitives. A Tauri updater size study measured 8,912 bytes saved with both features off. The saving depends on the application and build settings. ### Testing Formatting and strict Clippy pass. All nine crate tests pass with defaults and all 16 valid feature combinations. All seven doctests pass with defaults and with QuickCache features disabled. Rust 1.89 checks pass with defaults and with QuickCache features disabled. Nightly docs and doctests pass with the CI feature selection. The Oranda 0.6.5 site build passes. Dependency trees confirm both features are default-on and can be disabled. Assisted-by: gpt-6.1-sol
Remove the duplicate feature section from the mdbook. Place README and API feature documentation after the examples. Select the enabled QuickCache features explicitly in CI. ### Why Keep the documentation focused and follow the existing README layout. The crate workflows use explicit feature selections for tests and Clippy. Retain coverage with both QuickCache features enabled and disabled. ### Testing Formatting, nine crate tests, and strict Clippy pass with the revised CI features. Seven doctests pass with both QuickCache features disabled. The nightly documentation build passes. Assisted-by: gpt-6.1-sol
beanow-at-crabnebula
changed the title
quick_cache features optional
beanow-at-crabnebula
marked this pull request as ready for review
October 29, 2026 13:12
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #180 +/- ##
==========================================
+ Coverage 85.87% 90.45% +4.58%
==========================================
Files 19 19
Lines 7502 11795 +4293
==========================================
+ Hits 6442 10669 +4227
- Misses 1060 1126 +66 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This branch has not been deployed
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.
Forward
parking_lotandcustom-hasherthrough crate features. Keep both enabled by default to preserve existing behavior. Documenting the opt-out in the README and changelog.Why
The smaller size is one of
quick_cache's benefits. The optionalquick_cachefeatures can't be disabled through this crate right now. A minimal Tauri updater size test measured 8,912 bytes saved with both features off. Exact saving depends on the application and build settings.Testing
Existing CI checks seem to have very deliberate feature selection.
Best to confirm if this matches the pattern you had in mind for it.
Assisted-by: gpt-6.1-sol