The library is an implementation of Ben Laurie's ObjectHash for protocol buffers.
This implementation is still experimental and until it is stable, protobuf messages are not guaranteed to result in the same value.
Get a new ProtoHasher
instance using the NewHasher
method, then call
HashProto
with a protobuf message to get its ObjectHash:
hasher := protohash.NewHasher()
hash, err := hasher.HashProto(message)
In order to simplify compatibility with other ObjectHash applications, this library exposes the following options that control how the hashing is done:
-
EnumsAsStrings()
: Makes enum values get hashed as strings instead of being hashed as their integer values. -
FieldNamesAsKeys()
: Makes protobuf message fields use their names as keys instead of using the field tag numbers as keys. -
MessageIdentifier(i)
: Instead of hashing protobuf messages as maps, this makes it possible to distinguish them by usingi
as the type-identifier that gets used in calculating the ObjectHash of a message.
Those options can be specified in any order as arguments to the NewHasher
function. Example:
hasher := protohash.NewHasher(EnumsAsStrings(), MessageIdentifier(`m`), FieldNamesAsKeys())