key

Documentation

Index

• Constants
• type Key
  • func From(key fmt.Stringer) Key
  • func FromBz(key []byte) Key
  • func FromBzHashed(key []byte) Key
  • func FromHashed(key fmt.Stringer) Key
  • func FromStr(key string) Key
  • func FromStrHashed(key string) Key
  • func FromUInt[T constraints.Unsigned](key T) Key
  • func RegisterStaticKey(namespace string, prefix uint) Key

Constants

const DefaultDelimiter = "_"

DefaultDelimiter represents the default delimiter used for the KV store keys when concatenating them together

Types

type Key

type Key interface {
	Append(Key) Key
	Bytes() []byte
	String() string
}

Key provides a type safe way to interact with the store

func From

func From(key fmt.Stringer) Key

From creates a new Key from a fmt.Stringer interface Deprecated: use FromHashed instead

func FromBz

func FromBz(key []byte) Key

FromBz creates a new Key from bytes Deprecated: use FromBzHashed instead

func FromBzHashed

func FromBzHashed(key []byte) Key

FromBzHashed creates a new Key from bytes

func FromHashed

func FromHashed(key fmt.Stringer) Key

FromHashed creates a new Key from a fmt.Stringer interface

func FromStr

func FromStr(key string) Key

FromStr creates a new Key from a string Deprecated: use FromStrHashed instead

func FromStrHashed

func FromStrHashed(key string) Key

FromStrHashed creates a new Key from a string

func FromUInt

func FromUInt[T constraints.Unsigned](key T) Key

FromUInt creates a new Key from any unsigned integer type

func RegisterStaticKey

func RegisterStaticKey(namespace string, prefix uint) Key

RegisterStaticKey registers a static key particle for the data store to ensure uniqueness per namespace. Panics if two prefixes with the same value for the same namespace are registered.