microfts2

package module

Go to main page

Versions in this module

v0

v0.4.4

Aug 5, 2026

v0.4.3

Aug 5, 2026

v0.4.2

Jun 24, 2026

Changes in this version

type Options

+ Timeout time.Duration

v0.4.1

Jun 17, 2026

v0.4.0

Jun 12, 2026

Changes in this version

+ var ErrAppendBoundary = errors.New(...)

+ func DecodeByteRangeLocator(loc []byte) (int, int, bool)

+ func EncodeByteRangeLocator(start, end int) []byte

+ func WithIndexedChunkCallback(fn IndexedChunkCallback) interface

+ func WithRemovedChunkCallback(fn RemovedChunkCallback) interface

+ type AppendAwareChunker interface

+ AppendChunks func(path string, lastLocator []byte, newBytes []byte, yield func(Chunk) bool) (replacedLast bool, err error)

type BracketGroup

+ AllowedInner []string

+ AllowedParent []string

+ Escape string

type CRecord

+ func (c *CRecord) Bucket() *bbolt.Bucket

+ func (c *CRecord) DecFileID(fileid uint64) bool

+ func (c *CRecord) FileIDCountFor(fileid uint64) uint64

+ func (c *CRecord) IncFileID(fileid uint64)

+ func (c *CRecord) RemoveFileID(fileid uint64) bool

+ func (c *CRecord) Tx() *bbolt.Tx

type Chunk

+ Locator []byte

+ type ChunkerMetadata interface

+ CommentSyntax func() string

+ IsWritable func() bool

type DB

+ func (db *DB) DB() *bbolt.DB

+ func (db *DB) ReadCRecord(tx *bbolt.Tx, chunkID uint64) (CRecord, error)

+ func (db *DB) SetFileLength(fileid uint64, length int64) error

type FileChunkEntry

+ Locator []byte

+ type FileIDCount struct

+ Count uint64

+ FileID uint64

+ type IndexedChunk struct

+ CRecord CRecord

+ Chunk Chunk

+ type IndexedChunkCallback func(IndexedChunk)

type LineChunker

+ func (LineChunker) AppendChunks(path string, lastLocator []byte, newBytes []byte, yield func(Chunk) bool) (bool, error)

+ func (LineChunker) CommentSyntax() string

+ func (LineChunker) FileChunks(path string, old [32]byte, yield func(Chunk) bool) ([32]byte, error)

+ func (LineChunker) IsWritable() bool

type MarkdownChunker

+ func (MarkdownChunker) AppendChunks(path string, lastLocator []byte, newBytes []byte, yield func(Chunk) bool) (bool, error)

+ func (MarkdownChunker) CommentSyntax() string

+ func (MarkdownChunker) FileChunks(path string, old [32]byte, yield func(Chunk) bool) ([32]byte, error)

+ func (MarkdownChunker) IsWritable() bool

+ type RemoveOption interface

+ type RemovedChunkCallback func(CRecord)

type TxnHolder

+ Bucket func() *bbolt.Bucket

v0.3.0

Apr 24, 2026

Changes in this version

type CRecord

+ ContentLen int

type ChunkCache

+ func (cc *ChunkCache) ChunkTextWithId(fpath string, chunkID uint64) ([]byte, bool)

type DB

+ func (db *DB) ChunkContentLens(fileid uint64) ([]int, error)

+ func (db *DB) ReindexWithCallback(fpath, strategy string, fn ReindexCallback, opts ...IndexOption) (uint64, error)

+ func (db *DB) RemoveFileWithCallback(fpath string, fn RemoveCallback) error

+ func (db *DB) TmpFileInfos() []TmpFileInfo

+ type FileChunker interface

+ FileChunks func(path string, old [32]byte, yield func(Chunk) bool) ([32]byte, error)

+ type LineChunker struct

+ func (LineChunker) Chunks(path string, content []byte, yield func(Chunk) bool) error

+ func (LineChunker) GetChunk(path string, data []byte, customData *any, chunk *Chunk) error

+ type MarkdownChunker struct

+ func (MarkdownChunker) Chunks(path string, content []byte, yield func(Chunk) bool) error

+ func (MarkdownChunker) GetChunk(path string, data []byte, customData *any, chunk *Chunk) error

+ type RandomAccessChunker interface

+ GetChunk func(path string, data []byte, customData *any, chunk *Chunk) error

+ type ReindexCallback func(txn *lmdb.Txn, orphanedChunkIDs, newChunkIDs []uint64) error

+ type RemoveCallback func(txn *lmdb.Txn, orphanedChunkIDs []uint64) error

+ type TmpChunkInfo struct

+ Location string

+ Size int

+ type TmpFileInfo struct

+ ChunkCount int

+ ChunkSizes []int

+ Chunks []TmpChunkInfo

+ ContentLen int

+ FileID uint64

+ Path string

+ Strategy string

v0.2.0

Apr 12, 2026

Changes in this version

+ const BitsetSize

+ var ErrAlreadyIndexed = errors.New("file already indexed")

+ var ErrNoChunks = errors.New("chunker produced no chunks")

+ var LangC = BracketLang

+ var LangGo = BracketLang

+ var LangJS = BracketLang

+ var LangJava = LangC

+ var LangLisp = BracketLang

+ var LangNginx = BracketLang

+ var LangPascal = BracketLang

+ var LangShell = BracketLang

+ func DecodeFilename(keys [][]byte) string

+ func DecodeTrigram(v uint32) string

+ func FinalKey(filename string) []byte

+ func LineChunkFunc(_ string, content []byte, yield func(Chunk) bool) error

+ func MarkdownChunkFunc(_ string, content []byte, yield func(Chunk) bool) error

+ func PairGet(pairs []Pair, key string) ([]byte, bool)

+ func ScoreOverlap(queryTrigrams []uint32, chunkCounts map[uint32]int, _ int) float64

+ func TrigramValue(a, b, c byte) uint32

+ func UnmarshalTValue(data []byte) ([]uint64, error)

+ func UnmarshalWValue(data []byte) ([]uint64, error)

+ func ValidateAliases(aliases map[byte]byte) error

+ type AppendOption func(*appendConfig)

+ func WithAppendChunkCallback(fn ChunkCallback) AppendOption

+ func WithBaseLine(n int) AppendOption

+ func WithContentHash(hash string) AppendOption

+ func WithFileLength(n int64) AppendOption

+ func WithModTime(t int64) AppendOption

+ type Bitset [BitsetSize]byte

+ func (b *Bitset) Bytes() []byte

+ func (b *Bitset) Count() int

+ func (b *Bitset) ForEach(fn func(uint32))

+ func (b *Bitset) FromBytes(data []byte)

+ func (b *Bitset) Set(trigram uint32)

+ func (b *Bitset) Test(trigram uint32) bool

+ type BracketGroup struct

+ Close []string

+ Open []string

+ Separators []string

+ type BracketLang struct

+ BlockComments [][2]string

+ Brackets []BracketGroup

+ LineComments []string

+ StringDelims []StringDelim

+ func LangByName(name string) (BracketLang, bool)

+ type CRecord struct

+ Attrs []Pair

+ ChunkID uint64

+ FileIDs []uint64

+ Hash [32]byte

+ Tokens []TokenEntry

+ Trigrams []TrigramEntry

+ func UnmarshalCValue(data []byte) (CRecord, error)

+ func (c *CRecord) DB() *DB

+ func (c *CRecord) FileRecord(fileid uint64) (FRecord, error)

+ func (c *CRecord) MarshalValue() []byte

+ func (c *CRecord) Txn() *lmdb.Txn

+ type Chunk struct

+ Attrs []Pair

+ Content []byte

+ Range []byte

+ type ChunkCache struct

+ func (cc *ChunkCache) ChunkText(fpath, rangeLabel string) ([]byte, bool)

+ func (cc *ChunkCache) GetChunks(fpath, targetRange string, before, after int) ([]ChunkResult, error)

+ type ChunkCallback func(chunkText string)

+ type ChunkFilter func(chunk CRecord) bool

+ type ChunkFunc func(path string, content []byte, yield func(Chunk) bool) error

+ func RunChunkerFunc(cmd string) ChunkFunc

+ type ChunkResult struct

+ Attrs []Pair

+ Content string

+ Index int

+ Path string

+ Range string

+ type Chunker interface

+ ChunkText func(path string, content []byte, rangeLabel string) ([]byte, bool)

+ Chunks func(path string, content []byte, yield func(Chunk) bool) error

+ func BracketChunker(lang BracketLang) Chunker

+ func IndentChunker(lang BracketLang, tabWidth int) Chunker

+ type DB struct

+ func Create(path string, opts Options) (*DB, error)

+ func Open(path string, opts Options) (*DB, error)

+ func (db *DB) AddChunker(name string, c Chunker) error

+ func (db *DB) AddFile(fpath, strategy string, opts ...IndexOption) (uint64, error)

+ func (db *DB) AddFileWithContent(fpath, strategy string, opts ...IndexOption) (uint64, []byte, error)

+ func (db *DB) AddStrategy(name, cmd string) error

+ func (db *DB) AddStrategyFunc(name string, fn ChunkFunc) error

+ func (db *DB) AddTmpFile(path, strategy string, content []byte, opts ...IndexOption) (uint64, error)

+ func (db *DB) AppendChunks(fileid uint64, content []byte, strategy string, opts ...AppendOption) error

+ func (db *DB) AppendTmpFile(path, strategy string, content []byte, opts ...AppendOption) (uint64, error)

+ func (db *DB) BM25Func(queryTrigrams []uint32) (ScoreFunc, error)

+ func (db *DB) CheckFile(fpath string) (FileStatus, error)

+ func (db *DB) Close() error

+ func (db *DB) Copy() *DB

+ func (db *DB) Env() *lmdb.Env

+ func (db *DB) FileIDPaths() (map[uint64]string, error)

+ func (db *DB) FileInfoByID(fileid uint64) (FRecord, error)

+ func (db *DB) GetChunks(fpath, targetRange string, before, after int) ([]ChunkResult, error)

+ func (db *DB) HasTmp() bool

+ func (db *DB) InvalidateCaches()

+ func (db *DB) NewChunkCache() *ChunkCache

+ func (db *DB) NewSearchCache() func()

+ func (db *DB) QueryTrigramCounts(query string) ([]TrigramCount, error)

+ func (db *DB) RecordCounts() (map[byte]RecordStats, error)

+ func (db *DB) RefreshStale(strategy string, opts ...IndexOption) ([]FileStatus, error)

+ func (db *DB) Reindex(fpath, strategy string, opts ...IndexOption) (uint64, error)

+ func (db *DB) ReindexWithContent(fpath, strategy string, opts ...IndexOption) (uint64, []byte, error)

+ func (db *DB) RemoveFile(fpath string) error

+ func (db *DB) RemoveStrategy(name string) error

+ func (db *DB) RemoveTmpFile(path string) error

+ func (db *DB) ScoreFile(query, fpath string, fn ScoreFunc, opts ...SearchOption) ([]ScoredChunk, error)

+ func (db *DB) Search(query string, opts ...SearchOption) (*SearchResults, error)

+ func (db *DB) SearchFuzzy(query string, k int, opts ...SearchOption) (*SearchResults, error)

+ func (db *DB) SearchMulti(query string, strategies map[string]ScoreFunc, k int, opts ...SearchOption) ([]MultiSearchResult, error)

+ func (db *DB) SearchRegex(pattern string, opts ...SearchOption) (*SearchResults, error)

+ func (db *DB) Settings() Settings

+ func (db *DB) StaleFiles() ([]FileStatus, error)

+ func (db *DB) TmpContent(path string) (*bytes.Reader, error)

+ func (db *DB) TmpFileIDs() map[uint64]struct{}

+ func (db *DB) UpdateTmpFile(path, strategy string, content []byte, opts ...IndexOption) error

+ func (db *DB) Version() (string, error)

+ type FRecord struct

+ Chunks []FileChunkEntry

+ ContentHash [32]byte

+ FileID uint64

+ FileLength int64

+ ModTime int64

+ Names []string

+ Strategy string

+ Tokens []TokenEntry

+ func UnmarshalFHeader(data []byte) (FRecord, error)

+ func UnmarshalFValue(data []byte) (FRecord, error)

+ func (f *FRecord) MarshalValue() []byte

+ type FileChunkEntry struct

+ ChunkID uint64

+ Location string

+ type FileStatus struct

+ FileID uint64

+ Path string

+ Status string

+ Strategy string

+ type FuncChunker struct

+ Fn ChunkFunc

+ func (fc FuncChunker) ChunkText(path string, content []byte, rangeLabel string) ([]byte, bool)

+ func (fc FuncChunker) Chunks(path string, content []byte, yield func(Chunk) bool) error

+ type HRecord struct

+ ChunkID uint64

+ Hash [32]byte

+ type IndexOption func(*indexConfig)

+ func WithChunkCallback(fn ChunkCallback) IndexOption

+ type IndexStatus struct

+ Built bool

+ type KeyPair struct

+ Key []byte

+ Value []byte

+ func EncodeFilename(filename string) []KeyPair

+ type MultiSearchResult struct

+ Results []SearchResult

+ Strategy string

+ type Options struct

+ Aliases map[byte]byte

+ CaseInsensitive bool

+ DBName string

+ MapSize int64

+ MaxDBs int

+ type Pair struct

+ Key []byte

+ Value []byte

+ func CopyPairs(src []Pair) []Pair

+ type RecordStats struct

+ Count int64

+ KeyBytes int64

+ ValueBytes int64

+ type ScoreFunc func(queryTrigrams []uint32, chunkCounts map[uint32]int, chunkTokenCount int) float64

+ var ScoreCoverage ScoreFunc = scoreCoverage

+ var ScoreDensityFunc ScoreFunc = scoreDensity

+ func ScoreBM25(idf map[uint32]float64, avgTokenCount float64) ScoreFunc

+ type ScoredChunk struct

+ Range string

+ Score float64

+ type SearchOption func(*searchConfig)

+ func WithAfter(t time.Time) SearchOption

+ func WithBefore(t time.Time) SearchOption

+ func WithChunkCache(cc *ChunkCache) SearchOption

+ func WithChunkFilter(fn ChunkFilter) SearchOption

+ func WithCoverage() SearchOption

+ func WithDensity() SearchOption

+ func WithExcept(ids map[uint64]struct{}) SearchOption

+ func WithExceptRegex(patterns ...string) SearchOption

+ func WithLoose() SearchOption

+ func WithNoTmp() SearchOption

+ func WithOnly(ids map[uint64]struct{}) SearchOption

+ func WithOverlap() SearchOption

+ func WithProximityRerank(topN int) SearchOption

+ func WithRegexFilter(patterns ...string) SearchOption

+ func WithScoring(fn ScoreFunc) SearchOption

+ func WithTrigramFilter(fn TrigramFilter) SearchOption

+ func WithVerify() SearchOption

+ type SearchResult struct

+ Path string

+ Range string

+ Score float64

+ type SearchResults struct

+ Results []SearchResult

+ Status IndexStatus

+ type Settings struct

+ Aliases map[byte]byte

+ CaseInsensitive bool

+ ChunkingStrategies map[string]string

+ type StringDelim struct

+ Close string

+ Escape string

+ Open string

+ type TRecord struct

+ ChunkIDs []uint64

+ Trigram uint32

+ func (t *TRecord) MarshalValue() []byte

+ type TokenEntry struct

+ Count int

+ Token string

+ type TrigramCount struct

+ Count int

+ Trigram uint32

+ func FilterAll(trigrams []TrigramCount, _ int) []TrigramCount

+ type TrigramEntry struct

+ Count int

+ Trigram uint32

+ type TrigramFilter func(trigrams []TrigramCount, totalChunks int) []TrigramCount

+ func FilterBestN(n int) TrigramFilter

+ func FilterByRatio(maxRatio float64) TrigramFilter

+ type Trigrams struct

+ func NewTrigrams(caseInsensitive bool, aliases map[byte]byte) *Trigrams

+ func (t *Trigrams) EncodeTrigram(s string) (uint32, bool)

+ func (t *Trigrams) ExtractTrigrams(data []byte) []uint32

+ func (t *Trigrams) TrigramCounts(data []byte) map[uint32]int

+ type TxnHolder interface

+ Txn func() *lmdb.Txn

+ type WRecord struct

+ ChunkIDs []uint64

+ TokenHash uint32

+ func (w *WRecord) MarshalValue() []byte

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