kv

type Bucket ¶ added in v1.7.0

type Bucket string

Bucket provides logical bucket for kv store.

func (b Bucket) NewGetter(src Getter) Getter

func (b Bucket) NewPutter(src Putter) Putter

func (b Bucket) NewStore(src Store) Store

type Bulk ¶ added in v1.7.0

type Bulk interface {
	Putter
	EnableAutoFlush() // if set, the bulk will be non-atomic
	Write() error
}

Bulk is the bulk putter.

type BulkFunc ¶ added in v1.7.0

type BulkFunc func() Bulk

func (f BulkFunc) Bulk() Bulk

type DeleteFunc ¶ added in v1.3.0

type DeleteFunc func(key []byte) error

func (f DeleteFunc) Delete(key []byte) error

type EnableAutoFlushFunc ¶ added in v1.7.0

type EnableAutoFlushFunc func()

func (f EnableAutoFlushFunc) EnableAutoFlush()

type ErrorFunc ¶ added in v1.7.0

type ErrorFunc func() error

func (f ErrorFunc) Error() error

type FirstFunc ¶ added in v1.7.0

type FirstFunc func() bool

func (f FirstFunc) First() bool

type GetFunc ¶ added in v1.3.0

type GetFunc func(key []byte) ([]byte, error)

func (f GetFunc) Get(key []byte) ([]byte, error)

type Getter ¶

type Getter interface {
	Get(key []byte) ([]byte, error)
	Has(key []byte) (bool, error)
	IsNotFound(err error) bool
}

Getter defines methods to read kv.

type HasFunc ¶ added in v1.3.0

type HasFunc func(key []byte) (bool, error)

func (f HasFunc) Has(key []byte) (bool, error)

type IsNotFoundFunc ¶ added in v1.3.0

type IsNotFoundFunc func(err error) bool

func (f IsNotFoundFunc) IsNotFound(err error) bool

type IterateFunc ¶ added in v1.3.0

type IterateFunc func(r Range) Iterator

func (f IterateFunc) Iterate(r Range) Iterator

type Iterator ¶

type Iterator interface {
	First() bool
	Last() bool
	Next() bool
	Prev() bool
	Key() []byte
	Value() []byte
	Release()
	Error() error
}

Iterator iterates over kv pairs.

type KeyFunc ¶ added in v1.3.0

type KeyFunc func() []byte

func (f KeyFunc) Key() []byte

type LastFunc ¶ added in v1.7.0

type LastFunc func() bool

func (f LastFunc) Last() bool

type NextFunc ¶ added in v1.7.0

type NextFunc func() bool

func (f NextFunc) Next() bool

type PrevFunc ¶ added in v1.7.0

type PrevFunc func() bool

func (f PrevFunc) Prev() bool

type PutFunc ¶ added in v1.3.0

type PutFunc func(key, val []byte) error

func (f PutFunc) Put(key, val []byte) error

type Putter ¶

type Putter interface {
	Put(key, val []byte) error
	Delete(key []byte) error
}

Putter defines methods to write kv.

type Range ¶

type Range struct {
	Start []byte // start of key range (included)
	Limit []byte // limit of key range (excluded)
}

Range is the key range.

type ReleaseFunc ¶ added in v1.7.0

type ReleaseFunc func()

func (f ReleaseFunc) Release()

type Snapshot ¶ added in v1.7.0

type Snapshot interface {
	Getter
	Release()
}

Snapshot is the store's snapshot.

type SnapshotFunc ¶ added in v1.3.0

type SnapshotFunc func() Snapshot

func (f SnapshotFunc) Snapshot() Snapshot

type Store ¶ added in v1.3.0

type Store interface {
	Getter
	Putter

	Snapshot() Snapshot
	Bulk() Bulk
	Iterate(r Range) Iterator
}

Store defines the full functional kv store.

type ValueFunc ¶ added in v1.3.0

type ValueFunc func() []byte

func (f ValueFunc) Value() []byte

type WriteFunc ¶ added in v1.7.0

type WriteFunc func() error

func (f WriteFunc) Write() error