kv

Documentation

Index

• Constants
• func MustGet(kvs KVStore, key Key) []byte
• func MustHas(kvs KVStore, key Key) bool
• func MustIterate(kvs KVStore, prefix Key, f func(key Key, value []byte) bool)
• func MustIterateKeys(kvs KVStore, prefix Key, f func(key Key) bool)
• type KVStore
• type KVStoreReader
• type KVStoreWriter
• type Key
  • func (k Key) HasPrefix(prefix Key) bool

Constants

const EmptyPrefix = Key("")

Functions

func MustGet

func MustGet(kvs KVStore, key Key) []byte

func MustHas

func MustHas(kvs KVStore, key Key) bool

func MustIterate

func MustIterate(kvs KVStore, prefix Key, f func(key Key, value []byte) bool)

func MustIterateKeys

func MustIterateKeys(kvs KVStore, prefix Key, f func(key Key) bool)

Types

type KVStore

type KVStore interface {
	KVStoreWriter
	KVStoreReader
}

KVStore represents a key-value store where both keys and values are arbitrary byte slices.

type KVStoreReader

type KVStoreReader interface {
	// Get returns the value, or nil if not found
	Get(key Key) ([]byte, error)
	Has(key Key) (bool, error)
	Iterate(prefix Key, f func(key Key, value []byte) bool) error
	IterateKeys(prefix Key, f func(key Key) bool) error

	// MustGet returns the value, or nil if not found
	MustGet(key Key) []byte
	MustHas(key Key) bool
	MustIterate(prefix Key, f func(key Key, value []byte) bool)
	MustIterateKeys(prefix Key, f func(key Key) bool)
}

type KVStoreWriter

type KVStoreWriter interface {
	Set(key Key, value []byte)
	Del(key Key)
}

type Key

type Key string

Since map cannot have []byte as key, to avoid unnecessary conversions between string and []byte, we use string as key data type, but it does not necessarily have to be a valid UTF-8 string.

func (Key) HasPrefix

func (k Key) HasPrefix(prefix Key) bool