collections

Documentation

Index

• Variables
• func ArrayElemKey(name string, index uint32) kv.Key
• func MapElemKey(name string, key []byte) kv.Key
• type Array
  • func NewArray(kvStore kv.KVStore, name string) *Array
  • func (a *Array) Erase()
  • func (a *Array) Extend(other *ArrayReadOnly)
  • func (a *Array) Immutable() *ArrayReadOnly
  • func (a *Array) PruneAt(index uint32)
  • func (a *Array) Push(value []byte)
  • func (a *Array) SetAt(index uint32, value []byte)
• type ArrayReadOnly
  • func NewArrayReadOnly(kvReader kv.KVStoreReader, name string) *ArrayReadOnly
  • func (a *ArrayReadOnly) GetAt(index uint32) []byte
  • func (a *ArrayReadOnly) Len() uint32
• type ImmutableMap
  • func NewMapReadOnly(kvReader kv.KVStoreReader, name string) *ImmutableMap
  • func (m *ImmutableMap) GetAt(key []byte) []byte
  • func (m *ImmutableMap) HasAt(key []byte) bool
  • func (m *ImmutableMap) Iterate(f func(elemKey []byte, value []byte) bool)
  • func (m *ImmutableMap) IterateKeys(f func(elemKey []byte) bool)
  • func (m *ImmutableMap) Len() uint32
  • func (m *ImmutableMap) Name() string
• type Map
  • func NewMap(kvStore kv.KVStore, name string) *Map
  • func (m *Map) DelAt(key []byte)
  • func (m *Map) Erase()
  • func (m *Map) Immutable() *ImmutableMap
  • func (m *Map) SetAt(key, value []byte)

Variables

var ErrArrayOverflow = errors.New("Array overflow")

Functions

func ArrayElemKey

func ArrayElemKey(name string, index uint32) kv.Key

func MapElemKey

func MapElemKey(name string, key []byte) kv.Key

Types

type Array

type Array struct {
	*ArrayReadOnly
	// contains filtered or unexported fields
}

Array represents a dynamic array stored in a kv.KVStore

func NewArray

func NewArray(kvStore kv.KVStore, name string) *Array

func (*Array) Erase

func (a *Array) Erase()

TODO implement with DelPrefix

func (*Array) Extend

func (a *Array) Extend(other *ArrayReadOnly)

func (*Array) Immutable

func (a *Array) Immutable() *ArrayReadOnly

func (*Array) PruneAt

func (a *Array) PruneAt(index uint32)

PruneAt deletes the value at the given index, without shifting the rest of the values.

func (*Array) Push

func (a *Array) Push(value []byte)

adds to the end of the list

func (*Array) SetAt

func (a *Array) SetAt(index uint32, value []byte)

type ArrayReadOnly

type ArrayReadOnly struct {
	// contains filtered or unexported fields
}

ArrayReadOnly provides read-only access to an Array in a kv.KVStoreReader.

func NewArrayReadOnly

func NewArrayReadOnly(kvReader kv.KVStoreReader, name string) *ArrayReadOnly

func (*ArrayReadOnly) GetAt

func (a *ArrayReadOnly) GetAt(index uint32) []byte

func (*ArrayReadOnly) Len

func (a *ArrayReadOnly) Len() uint32

Len == 0/empty/non-existent are equivalent

type ImmutableMap

type ImmutableMap struct {
	// contains filtered or unexported fields
}

ImmutableMap provides read-only access to a Map in a kv.KVStoreReader.

func NewMapReadOnly

func NewMapReadOnly(kvReader kv.KVStoreReader, name string) *ImmutableMap

func (*ImmutableMap) GetAt

func (m *ImmutableMap) GetAt(key []byte) []byte

func (*ImmutableMap) HasAt

func (m *ImmutableMap) HasAt(key []byte) bool

func (*ImmutableMap) Iterate

func (m *ImmutableMap) Iterate(f func(elemKey []byte, value []byte) bool)

Iterate non-deterministic

func (*ImmutableMap) IterateKeys

func (m *ImmutableMap) IterateKeys(f func(elemKey []byte) bool)

IterateKeys non-deterministic

func (*ImmutableMap) Len

func (m *ImmutableMap) Len() uint32

func (*ImmutableMap) Name

func (m *ImmutableMap) Name() string

type Map

type Map struct {
	*ImmutableMap
	// contains filtered or unexported fields
}

Map represents a dynamic key-value collection in a kv.KVStore.

func NewMap

func NewMap(kvStore kv.KVStore, name string) *Map

func (*Map) DelAt

func (m *Map) DelAt(key []byte)

func (*Map) Erase

func (m *Map) Erase()

Erase the map.

func (*Map) Immutable

func (m *Map) Immutable() *ImmutableMap

func (*Map) SetAt

func (m *Map) SetAt(key, value []byte)