Rename FodId::hash to FodId::match_key (match-key vocabulary) - #19
Merged
Conversation
The stable, comparable part of a 51Did is now called the match key, mirroring the Model Terms for Marketing vocabulary. Rename the FodId::hash accessor to FodId::match_key (and the backing field), keep hash() as a #[deprecated] alias forwarding to match_key() for backward compatibility, and update the docs, examples and tests. Add a test that the deprecated alias returns the match key.
jwrosewell
marked this pull request as ready for review
August 31, 2026 10:43
This was referenced Aug 31, 2026
Merged
Merged
Merged
Merged
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.
The stable, comparable part of a 51Did is now called the match key, mirroring the Model Terms for Marketing vocabulary. The reader previously exposed it as
FodId::hash.Change
FodId::hash()accessor toFodId::match_key()(and the backing field).hash()as a#[deprecated]alias forwarding tomatch_key(), so existing callers keep compiling (with a deprecation warning) and get the same bytes.fodid-cloudas well asfodid.hash()alias returns the match key.The branch was brought up over the 51Did hardening and OWID vendoring change (#27) by merging main and re-applying the rename on top of the reworked files, so main's error variants, vendored
fodid::owidmodule and README doctests are the base and only the match-key rename sits above them.Tests
cargo test -p fodid -p fiftyone-fodid-cloud --all-features: 106 passed, 2 ignored (the live-cloud tests), which is main's 105 plus the new alias test.cargo clippyfor both crates with-D warningsandcargo fmt --checkare clean, and thewasm32-wasip1build offiftyone-fodid-cloudcompiles.Part of the cross-repo match-key vocabulary rename (documentation, Website, .NET reader (51Degrees/pipeline-dotnet#348) and cloud internals in separate PRs).
Produced with AI assistance under James Rosewell's direction and needs human review.