Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

rbf

package module

Go to main page

Versions in this module

v0

v0.22.4

Apr 20, 2024

v0.22.3

Apr 17, 2024

Changes in this version

+ const ArrayMaxSize

+ const BitmapN

+ const Magic

+ const MetaPageFlagCommit

+ const MetaPageFlagRollback

+ const PageSize

+ const PageTypeBitmap

+ const PageTypeBitmapHeader

+ const PageTypeBranch

+ const PageTypeLeaf

+ const PageTypeRootRecord

+ const RLEMaxSize

+ const RowValueMask

+ const ShardWidth

+ var Debug bool

+ var ErrBitmapExists = errors.New("bitmap already exists")

+ var ErrBitmapNameRequired = errors.New("bitmap name required")

+ var ErrBitmapNotFound = errors.New("bitmap not found")

+ var ErrClosed = errors.New("rbf: database closed")

+ var ErrTxClosed = errors.New("transaction closed")

+ var ErrTxNotWritable = errors.New("transaction not writable")

+ var ErrTxTooLarge = errors.New("rbf tx too large")

+ func ConvertToLeafArgs(key uint64, c *roaring.Container) (result leafCell)

+ func Dumpdot(tx *Tx, pgno uint32, parent string, writer io.Writer)

+ func IsBitmapHeader(page []byte) bool

+ func IsMetaPage(page []byte) bool

+ func Magic32() uint32

+ func Pagedump(b []byte, indent string, writer io.Writer)

+ func RowValues(b []uint64) []uint64

+ func Walk(tx *Tx, pgno uint32, v func(uint32, []*RootRecord))

+ func WalkPage(tx *Tx, pgno uint32, walker Walker)

+ func WalkRootRecordPages(page []byte) uint32

+ func WriteRootRecord(data []byte, rec *RootRecord) (remaining []byte, err error)

+ type BitmapPage struct

+ Values []uint16

+ type BitmapPageInfo struct

+ Parent uint32

+ Pgno uint32

+ Tree string

+ type BranchCell struct

+ Flags uint32

+ Key uint64

+ Pgno uint32

+ type BranchPage struct

+ Cells []*BranchCell

+ type BranchPageInfo struct

+ CellN int

+ Flags uint32

+ Parent uint32

+ Pgno uint32

+ Tree string

+ type ContainerType int

+ const ContainerTypeArray

+ const ContainerTypeBitmap

+ const ContainerTypeBitmapPtr

+ const ContainerTypeNone

+ const ContainerTypeRLE

+ func (typ ContainerType) String() string

+ type Cursor struct

+ func (c *Cursor) Add(v uint64) (changed bool, err error)

+ func (c *Cursor) AddRoaring(bm *roaring.Bitmap) (changed bool, err error)

+ func (c *Cursor) Close()

+ func (c *Cursor) Contains(v uint64) (exists bool, err error)

+ func (c *Cursor) CurrentPageType() ContainerType

+ func (c *Cursor) Dump(name string)

+ func (c *Cursor) DumpKeys()

+ func (c *Cursor) DumpStack()

+ func (c *Cursor) First() error

+ func (c *Cursor) Key() uint64

+ func (c *Cursor) Last() error

+ func (c *Cursor) Next() error

+ func (c *Cursor) Prev() error

+ func (c *Cursor) Remove(v uint64) (changed bool, err error)

+ func (c *Cursor) RemoveRoaring(bm *roaring.Bitmap) (changed bool, err error)

+ func (c *Cursor) Row(shard, rowID uint64) (*roaring.Bitmap, error)

+ func (c *Cursor) Rows() ([]uint64, error)

+ func (c *Cursor) Seek(key uint64) (exact bool, err error)

+ func (c *Cursor) Values() []uint16

+ type DB struct

+ Path string

+ func NewDB(path string, cfg *rbfcfg.Config) *DB

+ func (db *DB) Begin(writable bool) (_ *Tx, err error)

+ func (db *DB) Check() error

+ func (db *DB) Checkpoint() error

+ func (db *DB) Close() (err error)

+ func (db *DB) DataPath() string

+ func (db *DB) DebugInfo() *DebugInfo

+ func (db *DB) HasData(requireOneHotBit bool) (hasAnyRecords bool, err error)

+ func (db *DB) Open() (err error)

+ func (db *DB) Size() (int64, error)

+ func (db *DB) TxN() int

+ func (db *DB) WALPath() string

+ func (db *DB) WALSize() int64

+ type DebugInfo struct

+ Path string

+ Txs []*TxDebugInfo

+ type ErrorList []error

+ func (a *ErrorList) Append(err error)

+ func (a ErrorList) Err() error

+ func (a ErrorList) Error() string

+ func (a ErrorList) FullError() string

+ type FreePage struct

+ type FreePageInfo struct

+ Pgno uint32

+ type LeafCell struct

+ Key uint64

+ Pgno uint32

+ Type ContainerType

+ Values []uint16

+ type LeafPage struct

+ Cells []*LeafCell

+ type LeafPageInfo struct

+ CellN int

+ Flags uint32

+ Parent uint32

+ Pgno uint32

+ Tree string

+ type MetaPage struct

+ type MetaPageInfo struct

+ FreelistPageNo uint32

+ Magic []byte

+ PageN uint32

+ Pgno uint32

+ RootRecordPageNo uint32

+ WALID int64

+ type Metric struct

+ func NewMetric(name string, interval int) Metric

+ func (m *Metric) Inc(d time.Duration)

+ type Nodetype int

+ const Bitmap

+ const Branch

+ const Leaf

+ type Page interface

+ type PageInfo interface

+ type PageMap struct

+ func NewPageMap() *PageMap

+ func (m *PageMap) Delete(key uint32) *PageMap

+ func (m *PageMap) Get(key uint32) (value int64, ok bool)

+ func (m *PageMap) Iterator() *PageMapIterator

+ func (m *PageMap) Len() int

+ func (m *PageMap) Set(key uint32, value int64) *PageMap

+ type PageMapBuilder struct

+ func NewPageMapBuilder() *PageMapBuilder

+ func (b *PageMapBuilder) Delete(key uint32)

+ func (b *PageMapBuilder) Get(key uint32) (value int64, ok bool)

+ func (b *PageMapBuilder) Iterator() *PageMapIterator

+ func (b *PageMapBuilder) Len() int

+ func (b *PageMapBuilder) Map() *PageMap

+ func (b *PageMapBuilder) Set(key uint32, value int64)

+ type PageMapIterator struct

+ func (itr *PageMapIterator) Done() bool

+ func (itr *PageMapIterator) First()

+ func (itr *PageMapIterator) Next() (key uint32, value int64, ok bool)

+ type RootRecord struct

+ Name string

+ Pgno uint32

+ func ReadRootRecord(data []byte) (rec *RootRecord, remaining []byte, err error)

+ type RootRecordPage struct

+ Records []*RootRecord

+ type RootRecordPageInfo struct

+ Next uint32

+ Pgno uint32

+ type Tx struct

+ DeleteEmptyContainer bool

+ func (tx *Tx) Add(name string, a ...uint64) (changeCount int, err error)

+ func (tx *Tx) AddRoaring(name string, bm *roaring.Bitmap) (changed bool, err error)

+ func (tx *Tx) ApplyFilter(name string, key uint64, filter roaring.BitmapFilter) (err error)

+ func (tx *Tx) ApplyRewriter(name string, key uint64, rewriter roaring.BitmapRewriter) (err error)

+ func (tx *Tx) BitmapExists(name string) (bool, error)

+ func (tx *Tx) BitmapNames() ([]string, error)

+ func (tx *Tx) Check() error

+ func (tx *Tx) Commit() error

+ func (tx *Tx) Container(name string, key uint64) (*roaring.Container, error)

+ func (tx *Tx) ContainerIterator(name string, key uint64) (citer roaring.ContainerIterator, found bool, err error)

+ func (tx *Tx) Contains(name string, v uint64) (bool, error)

+ func (tx *Tx) Count(name string) (uint64, error)

+ func (tx *Tx) CountRange(name string, start, end uint64) (uint64, error)

+ func (tx *Tx) CreateBitmap(name string) error

+ func (tx *Tx) CreateBitmapIfNotExists(name string) error

+ func (tx *Tx) Cursor(name string) (*Cursor, error)

+ func (tx *Tx) DBPath() string

+ func (tx *Tx) DebugInfo() *TxDebugInfo

+ func (tx *Tx) DeleteBitmap(name string) error

+ func (tx *Tx) DeleteBitmapsWithPrefix(prefix string) error

+ func (tx *Tx) Depth(name string) (int, error)

+ func (tx *Tx) FieldViews() []string

+ func (tx *Tx) GetSizeBytesWithPrefix(prefix string) (n uint64, err error)

+ func (tx *Tx) GetSortedFieldViewList() (fvs []txkey.FieldView, _ error)

+ func (tx *Tx) ImportRoaringBits(name string, itr roaring.RoaringIterator, clear bool, log bool, rowSize uint64) (changed int, rowSet map[uint64]int, err error)

+ func (tx *Tx) Max(name string) (uint64, error)

+ func (tx *Tx) Min(name string) (uint64, bool, error)

+ func (tx *Tx) OffsetRange(name string, offset, start, endx uint64) (*roaring.Bitmap, error)

+ func (tx *Tx) PageData(pgno uint32) ([]byte, error)

+ func (tx *Tx) PageInfos() ([]PageInfo, error)

+ func (tx *Tx) PageN() int

+ func (tx *Tx) Pages(pgnos []uint32) ([]Page, error)

+ func (tx *Tx) PutContainer(name string, key uint64, ct *roaring.Container) error

+ func (tx *Tx) Remove(name string, a ...uint64) (changeCount int, err error)

+ func (tx *Tx) RemoveContainer(name string, key uint64) error

+ func (tx *Tx) RenameBitmap(oldname, newname string) error

+ func (tx *Tx) RoaringBitmap(name string) (*roaring.Bitmap, error)

+ func (tx *Tx) Rollback()

+ func (tx *Tx) Root(name string) (uint32, error)

+ func (tx *Tx) RootRecords() (records *immutable.SortedMap[string, uint32], err error)

+ func (tx *Tx) SnapshotReader() (io.Reader, error)

+ func (tx *Tx) Writable() bool

+ type TxDebugInfo struct

+ Ptr string

+ Stack string

+ Writable bool

+ type Walker interface

+ Visit func(pgno uint32, n Nodetype)

+ VisitRoot func(pgno uint32, name string)

+ Visitor func(pgno uint32, records []*RootRecord)

v0.22.2

Apr 17, 2024