feat: make hash families opt-in - #23
Merged
Merged
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Make
cityhash,fnv,md5,murmur, andxxhashopt-in Cargo features matching their public modules. No features are enabled by default. Each family remains usable withoutstd, dependencies, or allocation.Existing consumers must select the families they use and enable
stdexplicitly for standard I/O adapters and XXH3 runtime CPU detection, for examplehashcrew = { version = "0.1", features = ["std", "xxhash", "md5"] }. Share the optionalWriteadapter methods through a private macro, using only public streaming APIs. Update consumers, migration guidance, and rustdoc links; build documentation with all features and automatic feature availability badges using the docs.rs configuration.Centralize native and cross-target feature checks and Miri in
cargo x, with hash families discovered from Cargo metadata. Run stable/MSRV tests on Linux, macOS, and Windows, and aggregate all CI jobs inRequired. Keep the workflows usable on Windows and AArch64 by avoiding a rebuild of the running xtask executable and skipping NEON's scheduling-only assembly barrier under Miri.