Documentation
¶
Overview ¶
Package groundstrike provides typed, transport-independent source indexing and retrieval. Callers own workspace policy and lifecycle scheduling.
Index ¶
- Variables
- type Batch
- type Chunk
- type Engine
- type File
- type FileBatchSource
- type FileRecord
- type Generation
- type IndexedFile
- type MatchKind
- type ModeClass
- type Options
- type Report
- type RootID
- type SearchHit
- type SearchQuery
- type Skip
- type SkipReason
- type Snapshot
- type Source
- type State
- type Status
- type Store
- type Symbol
Constants ¶
This section is empty.
Variables ¶
View Source
var ( ErrStorageExhausted = errors.New("disk storage exhausted") ErrWriterOwned = errors.New("code index writer is owned by another process") ErrStale = errors.New("code index stale") ErrCapacity = errors.New("code index capacity exceeded") ErrPathDenied = errors.New("code index path denied") )
Functions ¶
This section is empty.
Types ¶
type Batch ¶
type Batch struct {
RootID RootID
SnapshotDigest string
Files []FileRecord
Stream FileBatchSource
Retain []string
Deleted []string
Skipped []Skip
}
type Engine ¶
type Engine struct {
// contains filtered or unexported fields
}
type FileBatchSource ¶
type FileBatchSource func(ctx context.Context, yield func([]FileRecord) error) error
FileBatchSource synchronously prepares bounded record batches before a Store enters its writer transaction. Each slice is borrowed only for the duration of yield; implementations must consume or copy it before yield returns. Each yielded batch independently must satisfy the Store's batch-byte limit.
type FileRecord ¶
type IndexedFile ¶
type Report ¶
type Report struct {
Generation Generation
Scanned int
Changed int
Retained int
Deleted int
Skipped map[SkipReason]int
}
type SearchQuery ¶
type Skip ¶
type Skip struct {
Path string
Reason SkipReason
Detail string
}
type SkipReason ¶
type SkipReason string
const ( SkipIgnored SkipReason = "ignored" SkipBinary SkipReason = "binary" SkipOversized SkipReason = "oversized" SkipUnreadable SkipReason = "unreadable" SkipPathDenied SkipReason = "path_denied" SkipSecret SkipReason = "secret" SkipCapacity SkipReason = "capacity" SkipParseError SkipReason = "parse_error" SkipSpecialFile SkipReason = "special_file" )
type Store ¶
type Store interface {
Files(ctx context.Context, rootID RootID) ([]IndexedFile, error)
Reconcile(ctx context.Context, batch Batch) (Generation, error)
Search(ctx context.Context, query SearchQuery) ([]SearchHit, error)
Outline(ctx context.Context, rootID RootID, path string) ([]Symbol, error)
Status(ctx context.Context, rootID RootID) (Status, error)
}
Click to show internal directories.
Click to hide internal directories.