gotkv

package

Go to main page

Versions in this module

v0

v0.4.0

May 7, 2026

Changes in this version

type Params

+ CacheSize *int

+ Salt [32]byte

+ TreeSeed [16]byte

type Root

+ func (r Root) Equal(r2 Root) bool

v0.3.1

Feb 22, 2026

v0.3.0

Feb 8, 2026

Changes in this version

type Machine

+ func (m *Machine) NewTxEmpty(s stores.RW) *Tx

+ type Params struct

+ DataMach *gdat.Machine

+ MaxSize int

+ MeanSize int

+ Seed [16]byte

type Tx

+ func (tx *Tx) BaseIsZero() bool

+ func (tx *Tx) Queued() int

v0.2.0

Jan 29, 2026

Changes in this version

type Tx

+ func (tx *Tx) IterateFlushed(ctx context.Context, span Span) *Iterator

v0.1.0

Jan 24, 2026

Changes in this version

+ const MaxKeySize

+ var ErrKeyNotFound = fmt.Errorf("key not found")

+ func CopyAll(ctx context.Context, b *Builder, it kvstreams.Iterator) error

+ func DebugTree(ctx context.Context, s stores.Reading, root Root, w io.Writer) error

+ func Get(ctx context.Context, s Getter, x Root, key []byte) ([]byte, error)

+ func GetF(ctx context.Context, s Getter, x Root, key []byte, fn func([]byte) error) error

+ func IsErrKeyNotFound(err error) bool

+ func KeyAfter(x []byte) []byte

+ func PrefixEnd(prefix []byte) []byte

+ type Builder struct

+ func (b *Builder) Finish(ctx context.Context) (*Root, error)

+ func (b *Builder) Put(ctx context.Context, key, value []byte) error

+ type DEntry struct

+ Key []byte

+ Left maybe.Maybe[[]byte]

+ Right maybe.Maybe[[]byte]

+ type Decoder struct

+ func (d *Decoder) Peek(src []byte, ent *Entry) error

+ func (d *Decoder) Read(src []byte, ent *Entry) (int, error)

+ func (d *Decoder) Reset(parent Index)

+ type Differ struct

+ func (d *Differ) Next(ctx context.Context, dst []DEntry) (int, error)

+ func (d *Differ) Seek(ctx context.Context, gteq []byte) error

+ type Edit struct

+ Entries []Entry

+ Span Span

+ type Encoder struct

+ func (e *Encoder) EncodedLen(ent Entry) int

+ func (e *Encoder) Reset()

+ func (e *Encoder) Write(dst []byte, ent Entry) (int, error)

+ type Entry = kvstreams.Entry

+ type Getter = stores.Reading

+ type ID = blobcache.CID

+ type Index = ptree.Index[kvstreams.Entry, gdat.Ref]

+ type IndexDecoder struct

+ func (d *IndexDecoder) Peek(src []byte, dst *Index) error

+ func (d *IndexDecoder) Read(src []byte, dst *Index) (int, error)

+ func (d *IndexDecoder) Reset(parent Index)

+ type IndexEncoder struct

+ func (e *IndexEncoder) EncodedLen(x Index) int

+ func (e *IndexEncoder) Reset()

+ func (e *IndexEncoder) Write(dst []byte, x ptree.Index[Entry, Ref]) (int, error)

+ type Iterator struct

+ func (it *Iterator) Next(ctx context.Context, dst []Entry) (int, error)

+ func (it *Iterator) Peek(ctx context.Context, dst *Entry) error

+ func (it *Iterator) Seek(ctx context.Context, gteq []byte) error

+ type Machine struct

+ func NewMachine(meanSize, maxSize int, opts ...Option) Machine

+ func (a *Machine) AddPrefix(x Root, prefix []byte) Root

+ func (a *Machine) Concat(ctx context.Context, s stores.RW, iters ...kvstreams.Iterator) (*Root, error)

+ func (a *Machine) Delete(ctx context.Context, s stores.RW, x Root, key []byte) (*Root, error)

+ func (a *Machine) DeleteSpan(ctx context.Context, s stores.RW, x Root, span Span) (*Root, error)

+ func (a *Machine) Edit(ctx context.Context, s stores.RW, x Root, edits ...Edit) (*Root, error)

+ func (a *Machine) ForEach(ctx context.Context, s Getter, root Root, span Span, fn func(Entry) error) error

+ func (a *Machine) Get(ctx context.Context, s stores.Reading, x Root, key []byte) ([]byte, error)

+ func (a *Machine) GetF(ctx context.Context, s stores.Reading, x Root, key []byte, ...) error

+ func (a *Machine) HasPrefix(ctx context.Context, s stores.Reading, x Root, prefix []byte) (bool, error)

+ func (a *Machine) MaxEntry(ctx context.Context, s stores.Reading, x Root, span Span) (*Entry, error)

+ func (a *Machine) MaxSize() int

+ func (a *Machine) MeanSize() int

+ func (a *Machine) NewBuilder(s stores.RW) *Builder

+ func (a *Machine) NewEmpty(ctx context.Context, s stores.RW) (*Root, error)

+ func (a *Machine) NewIterator(s stores.Reading, root Root, span Span) *Iterator

+ func (a *Machine) Populate(ctx context.Context, s stores.Reading, x Root, set cadata.Set, ...) error

+ func (a *Machine) Put(ctx context.Context, s stores.RW, x Root, key, value []byte) (*Root, error)

+ func (a *Machine) RemovePrefix(ctx context.Context, s stores.RW, x Root, prefix []byte) (*Root, error)

+ func (a *Machine) Sync(ctx context.Context, src stores.Reading, dst stores.Writing, x Root, ...) error

+ func (ag *Machine) NewDiffer(s stores.Reading, left, right Root, span Span) *Differ

+ func (m *Machine) NewTx(s stores.RW, prev Root) *Tx

+ type Option func(ag *Machine)

+ func WithDataMachine(ro *gdat.Machine) Option

+ func WithSeed(seed *[16]byte) Option

+ type Ref = gdat.Ref

+ type Root struct

+ Depth uint8

+ First []byte

+ Ref gdat.Ref

+ func AddPrefix(x Root, prefix []byte) Root

+ func (r *Root) Unmarshal(data []byte) error

+ func (r Root) Marshal(out []byte) []byte

+ type Span = kvstreams.Span

+ func PrefixSpan(prefix []byte) Span

+ func SingleKeySpan(k []byte) Span

+ func TotalSpan() Span

+ type Store = stores.RWD

+ type Tx struct

+ func (tx *Tx) Delete(ctx context.Context, key []byte) error

+ func (tx *Tx) Flush(ctx context.Context) (*Root, error)

+ func (tx *Tx) Get(ctx context.Context, key []byte, dst *[]byte) (bool, error)

+ func (tx *Tx) Iterate(ctx context.Context, span Span) *TxIterator

+ func (tx *Tx) Put(ctx context.Context, key, value []byte) error

+ type TxIterator struct

+ func (it *TxIterator) Next(ctx context.Context, dst []Entry) (int, error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL