mirror of
https://github.com/opentofu/opentofu.git
synced 2024-12-24 08:00:17 -06:00
f3a57db293
Many times now we've seen situations where we need to use addresses as map keys, but not all of our address types are comparable and thus we tend to end up using string representations as keys instead. That's problematic because conversion to string uses type information and some of the address types have string representations that are ambiguous with one another. UniqueKey therefore represents an opaque key that is unique for each functionally-distinct address across all types that implement UniqueKeyer. For this initial commit I've implemented UniqueKeyer only for the Referenceable family of types. These are an easy case because they were all already comparable (intentionally) anyway. Later commits can implement UniqueKeyer for other types that are not naturally comparable, such as any which include a ModuleInstance. This also includes a new type addrs.Set which wraps a map as a set of addresses, using the unique keys to ensure that there can be only one element for each distinct address.
24 lines
868 B
Go
24 lines
868 B
Go
package addrs
|
|
|
|
// UniqueKey is an interface implemented by values that serve as unique map
|
|
// keys for particular addresses.
|
|
//
|
|
// All implementations of UniqueKey are comparable and can thus be used as
|
|
// map keys. Unique keys generated from different address types are always
|
|
// distinct. All functionally-equivalent keys for the same address type
|
|
// always compare equal, and likewise functionally-different values do not.
|
|
type UniqueKey interface {
|
|
uniqueKeySigil()
|
|
}
|
|
|
|
// UniqueKeyer is an interface implemented by types that can be represented
|
|
// by a unique key.
|
|
//
|
|
// Some address types naturally comply with the expectations of a UniqueKey
|
|
// and may thus be their own unique key type. However, address types that
|
|
// are not naturally comparable can implement this interface by returning
|
|
// proxy values.
|
|
type UniqueKeyer interface {
|
|
UniqueKey() UniqueKey
|
|
}
|