Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  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

tree

package

Go to main page

Versions in this module

v0

v0.5.0

Apr 17, 2026

Changes in this version

+ type OuterLeafReadStats struct

+ BytesTotal uint64

+ IteratorLoadsTotal uint64

+ LoadsTotal uint64

+ PointLoadsTotal uint64

+ Recent1KHitsTotal uint64

+ Recent256HitsTotal uint64

+ Recent4KHitsTotal uint64

+ Recent64HitsTotal uint64

+ SampleMod uint64

+ SamplesTotal uint64

+ func OuterLeafReadStatsSnapshot() OuterLeafReadStats

v0.4.0

Apr 3, 2026

Changes in this version

+ type IteratorMode uint8

+ const IteratorModeFull

+ const IteratorModeKeysOnly

+ const IteratorModePointerProjection

+ type IteratorOptions struct

+ IncludeTombstones bool

+ Mode IteratorMode

+ type ReadPathStats struct

+ GetAppendInlineBytesTotal uint64

+ GetAppendInlineHitsTotal uint64

+ GetAppendPointerBytesTotal uint64

+ GetAppendPointerHitsTotal uint64

+ func ReadPathStatsSnapshot() ReadPathStats

type Tree

+ func (t *Tree) GetAppend(key, dst []byte) ([]byte, error)

+ func (t *Tree) GetEntryExact(key []byte) (node.LeafEntry, error)

+ func (t *Tree) IteratorWithOptions(start, end []byte, opts IteratorOptions) iterator.UnsafeIterator

+ func (t *Tree) ReverseIteratorWithOptions(start, end []byte, opts IteratorOptions) iterator.UnsafeIterator

v0.3.0

Feb 7, 2026

v0.2.0

Jan 24, 2026

v0.1.0

Jan 23, 2026

Changes in this version

+ var ErrKeyNotFound = errors.New("key not found")

+ type CursorItem struct

+ Index int

+ Node node.Node

+ PageID uint64

+ type Iterator struct

+ func (it *Iterator) Close() error

+ func (it *Iterator) Domain() (start, end []byte)

+ func (it *Iterator) Error() error

+ func (it *Iterator) IsDeleted() bool

+ func (it *Iterator) Key() []byte

+ func (it *Iterator) KeyCopy(dst []byte) []byte

+ func (it *Iterator) Next()

+ func (it *Iterator) Seek(key []byte)

+ func (it *Iterator) UnsafeEntry() ([]byte, page.ValuePtr, byte)

+ func (it *Iterator) UnsafeKey() []byte

+ func (it *Iterator) UnsafeValue() []byte

+ func (it *Iterator) Valid() bool

+ func (it *Iterator) Value() []byte

+ func (it *Iterator) ValueCopy(dst []byte) []byte

+ type SlabReader interface

+ Read func(ptr page.ValuePtr) ([]byte, error)

+ ReadUnsafe func(ptr page.ValuePtr) ([]byte, error)

+ type Tree struct

+ func New(p *pager.Pager, sr SlabReader, root uint64) *Tree

+ func (t *Tree) CollectPageIDs() ([]uint64, error)

+ func (t *Tree) Get(key []byte) ([]byte, error)

+ func (t *Tree) GetEntry(key []byte) (node.LeafEntry, error)

+ func (t *Tree) GetUnsafe(key []byte) ([]byte, error)

+ func (t *Tree) Has(key []byte) (bool, error)

+ func (t *Tree) Iterator(start, end []byte) iterator.UnsafeIterator

+ func (t *Tree) Reset(p *pager.Pager, sr SlabReader, root uint64)

+ func (t *Tree) ReverseIterator(start, end []byte) iterator.UnsafeIterator

+ func (t *Tree) SetRoot(root uint64)

+ func (t *Tree) UpdateValuePtrInPlace(key []byte, oldPtr, newPtr page.ValuePtr) (updated bool, leafPageID uint64, err error)

+ func (t *Tree) WalkPages(fn func(pageID uint64, n node.Node) error) error