vellum

package module

Go to main page

Versions in this module

v1

v1.2.1

Nov 2, 2026

v1.2.0

Jan 22, 2026

v1.1.0

Dec 11, 2024

Changes in this version

type FuzzyAutomaton

+ MatchAndDistance func(input string) (bool, uint8)

v1.0.11

Nov 20, 2024

Changes in this version

type FSTIterator

+ func (i *FSTIterator) EditDistance() uint8

+ type FuzzyAutomaton interface

+ EditDistance func(int) uint8

+ type FuzzyIterator interface

+ EditDistance func() uint8

v1.0.10

Jun 30, 2023

v1.0.9

Oct 4, 2022

v1.0.8

May 31, 2022

v1.0.7

Sep 15, 2021

v1.0.6

Sep 15, 2021

v1.0.5

Jun 11, 2021

v1.0.4

May 28, 2021

v1.0.3

Feb 12, 2021

Changes in this version

+ var ErrIteratorDone = errors.New("iterator-done")

+ var ErrOutOfOrder = errors.New("values not inserted in lexicographic order")

+ func AutomatonContains(a Automaton, k []byte) bool

+ func Merge(w io.Writer, opts *BuilderOpts, itrs []Iterator, f MergeFunc) error

+ func MergeMax(vals []uint64) uint64

+ func MergeMin(vals []uint64) uint64

+ func MergeSum(vals []uint64) uint64

+ func TransducerGet(t Transducer, k []byte) (bool, uint64)

+ type AlwaysMatch struct

+ func (m *AlwaysMatch) Accept(int, byte) int

+ func (m *AlwaysMatch) CanMatch(int) bool

+ func (m *AlwaysMatch) IsMatch(int) bool

+ func (m *AlwaysMatch) Start() int

+ func (m *AlwaysMatch) WillAlwaysMatch(int) bool

+ type Automaton interface

+ Accept func(int, byte) int

+ CanMatch func(int) bool

+ IsMatch func(int) bool

+ Start func() int

+ WillAlwaysMatch func(int) bool

+ type Builder struct

+ func New(w io.Writer, opts *BuilderOpts) (*Builder, error)

+ func (b *Builder) Close() error

+ func (b *Builder) Insert(key []byte, val uint64) error

+ func (b *Builder) Reset(w io.Writer) error

+ type BuilderOpts struct

+ Encoder int

+ RegistryMRUSize int

+ RegistryTableSize int

+ type FST struct

+ func Load(data []byte) (*FST, error)

+ func Open(path string) (*FST, error)

+ func (f *FST) Accept(addr int, b byte) int

+ func (f *FST) AcceptWithVal(addr int, b byte) (int, uint64)

+ func (f *FST) CanMatch(addr int) bool

+ func (f *FST) Close() error

+ func (f *FST) Contains(val []byte) (bool, error)

+ func (f *FST) Debug(callback func(int, interface{}) error) error

+ func (f *FST) Get(input []byte) (uint64, bool, error)

+ func (f *FST) GetMaxKey() ([]byte, error)

+ func (f *FST) GetMinKey() ([]byte, error)

+ func (f *FST) IsMatch(addr int) bool

+ func (f *FST) IsMatchWithVal(addr int) (bool, uint64)

+ func (f *FST) Iterator(startKeyInclusive, endKeyExclusive []byte) (*FSTIterator, error)

+ func (f *FST) Len() int

+ func (f *FST) Reader() (*Reader, error)

+ func (f *FST) Search(aut Automaton, startKeyInclusive, endKeyExclusive []byte) (*FSTIterator, error)

+ func (f *FST) Start() int

+ func (f *FST) Type() int

+ func (f *FST) Version() int

+ func (f *FST) WillAlwaysMatch(int) bool

+ type FSTIterator struct

+ func (i *FSTIterator) Close() error

+ func (i *FSTIterator) Current() ([]byte, uint64)

+ func (i *FSTIterator) Next() error

+ func (i *FSTIterator) Reset(f *FST, startKeyInclusive, endKeyExclusive []byte, aut Automaton) error

+ func (i *FSTIterator) Seek(key []byte) error

+ type Iterator interface

+ Close func() error

+ Current func() ([]byte, uint64)

+ Next func() error

+ Reset func(f *FST, startKeyInclusive, endKeyExclusive []byte, aut Automaton) error

+ Seek func(key []byte) error

+ type MergeFunc func([]uint64) uint64

+ type MergeIterator struct

+ func NewMergeIterator(itrs []Iterator, f MergeFunc) (*MergeIterator, error)

+ func (m *MergeIterator) Close() error

+ func (m *MergeIterator) Current() ([]byte, uint64)

+ func (m *MergeIterator) Next() error

+ func (m *MergeIterator) Seek(key []byte) error

+ type Reader struct

+ func (r *Reader) Get(input []byte) (uint64, bool, error)

+ type Transducer interface

+ AcceptWithVal func(int, byte) (int, uint64)

+ IsMatchWithVal func(int) (bool, uint64)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL