wal

Feb 25, 2023

Changes in this version

+ const SOT128B

+ const SOT1K

+ const SOT256B

+ const SOT2K

+ const SOT4K

+ const SOT512B

+ const SOT64B

+ const SOT8K

type Entry

+ func (entry Entry) Header() (header EntryHeader)

+ func (entry Entry) TEUsLen() (n uint16)

+ type EntryHeader []byte

+ func (header EntryHeader) Committed() (ok bool)

+ func (header EntryHeader) Discarded() (ok bool)

+ func (header EntryHeader) HashCode() (code uint64)

+ func (header EntryHeader) Index() (index uint64)

+ func (header EntryHeader) Removed() (ok bool)

+ func (header EntryHeader) State() (state State)

+ func (header EntryHeader) StateFinished() (ok bool)

+ func (header EntryHeader) String() (s string)

type Option

+ func UseSOT(sot SOT) Option

type Options

+ SOT SOT

+ type SOT uint16

+ func (sot SOT) String() string

+ type TEU []byte

+ func NewTEU(size SOT) (teu TEU)

+ type TEUs []byte

+ func NewTEUs(size SOT, p []byte) (b TEUs)

+ func (s TEUs) Data() (p []byte)

+ func (s TEUs) FirstDataCut(low int, high int) (p []byte)

+ func (s TEUs) Len() (p uint16)

+ func (s TEUs) SOT() (sot SOT)

Feb 24, 2023

Changes in this version

type File

+ func (f *File) Reopen() (err error)

Feb 24, 2023

Changes in this version

+ const ReadCommitted

+ const ReadUncommitted

+ var ErrCommittedOrDiscarded = errors.New("entry was committed or discarded")

+ type Option func(options *Options)

+ func EnableTransaction(level TransactionLevel) Option

+ func WithCacheSize(size int) Option

+ type Options struct

+ CacheSize int

+ TransactionEnabled bool

+ TransactionLevel TransactionLevel

+ type TransactionLevel int

+ func (level TransactionLevel) String() string

type WAL

+ func (wal *WAL[K]) OldestUncommittedKey() (key K, has bool)

Feb 23, 2023

Changes in this version

type WAL

+ func (wal *WAL[K]) UncommittedKey(key K) (ok bool)

Feb 23, 2023

Changes in this version

type Entry

+ func (entry Entry) Remove()

+ func (entry Entry) Removed() (ok bool)

+ type KeyEncoder interface

+ Decode func(p []byte) (key K, err error)

+ Encode func(key K) (p []byte, err error)

+ func Int64KeyEncoder() KeyEncoder[int64]

+ func StringKeyEncoder() KeyEncoder[string]

+ func Unit64KeyEncoder() KeyEncoder[uint64]

type WAL

+ func (wal *WAL[K]) CommitKey(keys ...K) (err error)

+ func (wal *WAL[K]) DiscardKey(keys ...K) (err error)

+ func (wal *WAL[K]) FirstKey() (k K, err error)

+ func (wal *WAL[K]) LastKey() (k K, err error)

+ func (wal *WAL[K]) Remove(index uint64) (err error)

+ func (wal *WAL[K]) RemoveKey(key K) (err error)

Feb 23, 2023

Changes in this version

+ const CommittedState

+ const DiscardedState

+ const UncommittedState

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

type Entry

+ func (entry Entry) Discard()

+ func (entry Entry) Discarded() (ok bool)

+ func (entry Entry) Finished() (ok bool)

+ func (entry Entry) Key() (key []byte)

+ func (entry Entry) State() uint16

+ type State int

+ func (state State) String() string

type WAL

+ func (wal *WAL) Discard(indexes ...uint64) (err error)

+ func (wal *WAL) Key(key []byte) (p []byte, state State, err error)

+ func (wal *WAL) UncommittedSize() (n uint64)

Feb 23, 2023

Changes in this version

+ var ErrClosed = errors.New("wal was closed")

+ var ErrNoFirstIndex = errors.New("wal has no first index")

+ var ErrNoLastIndex = errors.New("wal has no last index")

+ func ExistFile(filePath string) (ok bool)

type File

+ func (f *File) Path() (path string)

+ func (f *File) Truncate(end uint64) (err error)

type WAL

+ func (wal *WAL) Len() (n uint64)

+ func (wal *WAL) TruncateBack(startIndex uint64) (err error)

+ func (wal *WAL) TruncateFront(endIndex uint64) (err error)

Feb 23, 2023

Changes in this version

+ var ErrInvalidEntry = errors.New("invalid entry")

+ type Batch struct

+ func (batch *Batch) Cancel()

+ func (batch *Batch) Close()

+ func (batch *Batch) Flush() (err error)

+ func (batch *Batch) Write(p []byte) (index uint64)

+ type Block []byte

+ func NewBlock() Block

+ func (block Block) Data() (p []byte)

+ func (block Block) Header() (idx uint16, span uint16)

+ func (block Block) Validate() (ok bool)

+ type Entry []byte

+ func DecodeEntries(p []byte) (entries []Entry)

+ func NewEntry(index uint64, p []byte) (entry Entry)

+ func (entry Entry) Blocks() (n uint16)

+ func (entry Entry) Commit()

+ func (entry Entry) Committed() (ok bool)

+ func (entry Entry) Data() (p []byte)

+ func (entry Entry) HashCode() (code uint64)

+ func (entry Entry) Index() (index uint64)

+ func (entry Entry) Validate() (ok bool)

+ type File struct

+ func OpenFile(path string) (file *File, err error)

+ func (f *File) Close()

+ func (f *File) ReadAt(p []byte, start uint64) (err error)

+ func (f *File) Size() (n uint64)

+ func (f *File) WriteAt(p []byte, start uint64) (err error)

+ type IndexTree struct

+ func NewIndexTree() (tree *IndexTree)

+ func (tr *IndexTree) Get(index uint64) (uint64, bool)

+ func (tr *IndexTree) Height() int

+ func (tr *IndexTree) Len() int

+ func (tr *IndexTree) Load(index uint64, pos uint64)

+ func (tr *IndexTree) Max() (uint64, uint64, bool)

+ func (tr *IndexTree) Min() (uint64, uint64, bool)

+ func (tr *IndexTree) Remove(index uint64) bool

+ func (tr *IndexTree) Set(index uint64, pos uint64)

+ type LRU struct

+ func NewLRU(size uint32) (lru *LRU)

+ func (c *LRU) Add(key uint64, value Entry) (evicted bool)

+ func (c *LRU) Get(key uint64) (value Entry, ok bool)

+ func (c *LRU) Keys() []uint64

+ func (c *LRU) Len() int

+ func (c *LRU) Purge()

+ func (c *LRU) Remove(key uint64) (present bool)

+ func (c *LRU) Resize(size int64) (evicted int64)

+ type WAL struct

+ func New(path string) (wal *WAL, err error)

+ func NewWithCacheSize(path string, cacheSize uint32) (wal *WAL, err error)

+ func (wal *WAL) Batch() (batch *Batch)

+ func (wal *WAL) Close()

+ func (wal *WAL) Commit(indexes ...uint64) (err error)

+ func (wal *WAL) CreateSnapshot(sink io.Writer) (err error)

+ func (wal *WAL) FirstIndex() (idx uint64, err error)

+ func (wal *WAL) HasCommitted(index uint64) (ok bool)

+ func (wal *WAL) LastIndex() (idx uint64, err error)

+ func (wal *WAL) OldestUncommitted() (index uint64, has bool)

+ func (wal *WAL) Read(index uint64) (p []byte, has bool, err error)

+ func (wal *WAL) Uncommitted() (n uint64)

+ func (wal *WAL) Write(p []byte) (index uint64, err error)