state

Documentation

Index

• Variables
• func NoSyncOption() storeOpt
• type Bucket
  • func NewBucket(id BucketID, opts ...*RangeOptions) Bucket
  • func (b Bucket) NewKey(key []byte) *Key
  • func (b Bucket) WithRangeOptions(opt *RangeOptions) Bucket
• type BucketID
  • func (b BucketID) Bytes() []byte
• type IndexedStore
  • func NewIndexedStoreBadger(prefix string, opts ...storeOpt) (IndexedStore, error)
• type Key
  • func NewKey(bucket BucketID, key []byte) *Key
  • func (k *Key) Bytes() []byte
  • func (k *Key) String() string
  • func (k *Key) Unmarshal(buf []byte) *Key
  • func (k *Key) WithinBucket(b Bucket) *Key
• type KeyFunc
• type ModifyFunc
• type PeekFunc
• type RangeOptions

Variables

var (
	ErrRangeStop = errors.New("range stop")
	ErrScanStop  = ErrRangeStop
)

var ErrNoUpdate = errors.New("no update")

var ErrNotFound = errors.New("not found")

var NoKey = Bucket{}.NewKey(nil)

var OffsetStart = []byte("")

Functions

func NoSyncOption

func NoSyncOption() storeOpt

Types

type Bucket

type Bucket struct {
	ID           BucketID
	RangeOptions RangeOptions
}

func NewBucket

func NewBucket(id BucketID, opts ...*RangeOptions) Bucket

func (Bucket) NewKey

func (b Bucket) NewKey(key []byte) *Key

func (Bucket) WithRangeOptions

func (b Bucket) WithRangeOptions(opt *RangeOptions) Bucket

type BucketID

type BucketID uint16

var (
	BucketRecords   BucketID = 0x10
	BucketBeatTicks BucketID = 0x11
	BucketBeatInfos BucketID = 0x12
)

func (BucketID) Bytes

func (b BucketID) Bytes() []byte

type IndexedStore

type IndexedStore interface {
	View(k *Key, fn PeekFunc) error
	Update(k *Key, fn ModifyFunc) error
	Delete(k *Key) error

	RangeKeys(b Bucket, fn KeyFunc) (*RangeOptions, error)
	RangePeek(b Bucket, fn PeekFunc) (*RangeOptions, error)
	RangeModify(b Bucket, fn ModifyFunc) (*RangeOptions, error)

	Close() error
}

IndexedStore is an interface to internal node state. The state includes file names, version history, in other words it's a collection of indexed metadata. The state must be synchronised across all utility Atlant nodes.

func NewIndexedStoreBadger

func NewIndexedStoreBadger(prefix string, opts ...storeOpt) (IndexedStore, error)

type Key

type Key struct {
	Bucket Bucket
	Key    [26]byte
	TTL    time.Duration
}

func NewKey

func NewKey(bucket BucketID, key []byte) *Key

func (*Key) Bytes

func (k *Key) Bytes() []byte

func (*Key) String

func (k *Key) String() string

func (*Key) Unmarshal

func (k *Key) Unmarshal(buf []byte) *Key

func (*Key) WithinBucket

func (k *Key) WithinBucket(b Bucket) *Key

type KeyFunc

type KeyFunc func(k *Key) error

type ModifyFunc

type ModifyFunc func(k *Key, v []byte) ([]byte, error)

type PeekFunc

type PeekFunc func(k *Key, v []byte) error

type RangeOptions

type RangeOptions struct {
	Prefetch int
	Offset   []byte
	Limit    int
}