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
- API
  
  Reference documentation for the pkg.go.dev API
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

file

package

Go to main page

Versions in this module

v0

v0.4.0

Nov 14, 2026

v0.3.1

Nov 14, 2026

v0.3.0

Nov 13, 2026

v0.2.1

Nov 7, 2026

v0.2.0

Nov 6, 2026

Changes in this version

type Options

+ Guard *source.RootGuard

+ RulesGeneration func() uint64

type Source

+ func (s *Source) NumericTerms()

v0.1.0

Nov 6, 2026

Changes in this version

+ const ClaimMargin

+ const Kind

+ const MaxAround

+ const MaxFiles

+ const MaxRatio

+ const MaxRecursion

+ const PrefixBytes

+ var ErrNotIndexable = source.ErrNotIndexable

+ type CountQuery = source.CountQuery

+ type CountResult = source.CountResult

+ type CountRow = source.CountRow

+ type Options struct

+ Alternates map[string]string

+ Index *index.Store

+ Name string

+ NoXDev bool

+ Now func() time.Time

+ Parser *parse.Parser

+ Paths []string

+ Recursive bool

+ Roots []string

+ Sensitive func(field, value string) bool

+ Tag string

+ Trusted []string

+ type Source struct

+ func New(opts Options) (*Source, error)

+ func (s *Source) Around(ctx context.Context, ref source.RawRef, before, after int) ([]source.RawRecord, error)

+ func (s *Source) AroundMeasured(ctx context.Context, ref source.RawRef, before, after int) ([]source.RawRecord, int64, error)

+ func (s *Source) Describe(ctx context.Context) (source.Schema, error)

+ func (s *Source) IndexCounts(ctx context.Context, q CountQuery) (CountResult, error)

+ func (s *Source) IndexStep(ctx context.Context, maxBytes int64, upkeep bool) (int64, bool, error)

+ func (s *Source) Kind() string

+ func (s *Source) Name() string

+ func (s *Source) Plan(ctx context.Context, r source.Range, sel source.Selector) (source.Byteplan, error)

+ func (s *Source) Reread(ctx context.Context, ref source.RawRef) (source.RawRecord, error)

+ func (s *Source) Scan(ctx context.Context, c source.Chunk) (source.Iterator, error)