Implement Serialize/Deserialize for Hashed<V, S> #18786
Open
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.
Objective
This allows users to serialize and deserialize both prehashed values and maps/sets with prehashed keys, avoiding the need for a conversion.
Solution
When serializing, only the inner stored value (of type
V) is serialized. The struct acts as a transparent wrapper around it, so theHashedstruct is invisible toserde.When deserializing, the reverse happens: the inner value is deserialized, then the
Hashedstruct is initialized from the deserialized value, computing the hash at that time. This means that the computed hash may differ between what was serialized and what was deserialized if the hasher produces two different values at those times - for example, across different runs of the application using different versions ofbevy. This should normally not matter since the hash usually only needs to be consistent in the same run of the application.Testing
There are unit tests added for both
Hashed<V, FixedHasher>andHashMap<Hashed<K, FixedHasher>, V, PreHash>. The tests for the hashmap are to ensure thatPreHashMapcan be serialized/deserialized as well, and serializes in the expected format.Some other
bevycrates depend onserde_test, but that crate appears to be unmaintained now, so I'm usingserde_jsonfor testing instead.