treestamp

package module

Go to main page

Versions in this module

v0

v0.1.5

Sep 20, 2026

Changes in this version

+ const SortDirsFirst

+ const SortFilesFirst

+ const SortLexical

+ const SortNone

+ var SkipThis = walk.ErrSkipThis

+ func ScanPathsFS(ctx context.Context, fsys fs.FS, root string, opts ...Option) ([]string, error)

type Config

+ FollowOutside bool

+ KeepSkipAll bool

+ SortMode SortMode

type DirWalkOptions

+ AllowNonDirectory bool

+ Context context.Context

+ MaxOpen int

+ ScratchBuffer []byte

+ type EntryFilter = walkcfg.EntryFilter

+ func NewEntryFilter() *EntryFilter

type MultiScanReport

+ func (r MultiScanReport) Revision() string

type Options

+ IgnoreRules []string

+ VCSSkips bool

+ func (o Options) WithVCSSkips(enabled bool) Options

type Plan

+ func (p *Plan) EachFileFS(ctx context.Context, fsys fs.FS, root string, ...) (*ScanSummary, error)

+ func (p *Plan) ScanFS(ctx context.Context, fsys fs.FS, root string) (*ScanReport, error)

+ func (p *Plan) ScanPathsFS(ctx context.Context, fsys fs.FS, root string) ([]string, error)

type ScanReport

+ func ScanFS(ctx context.Context, fsys fs.FS, root string, opts ...Option) (*ScanReport, error)

type ScanSummary

+ func EachFileFS(ctx context.Context, fsys fs.FS, root string, ...) (*ScanSummary, error)

+ type SortMode = int

type WalkDirFunc

+ func IgnorePermissionErrors(fn WalkDirFunc) WalkDirFunc

v0.1.4

Sep 19, 2026

v0.1.3

Sep 17, 2026

v0.1.2

Sep 17, 2026

Changes in this version

type Option

+ func WithAdmitTimeout(d time.Duration) Option

type Options

+ AdmitTimeout time.Duration

+ func (o Options) WithAdmitTimeout(d time.Duration) Options

v0.1.0

Sep 17, 2026

Changes in this version

+ const DefaultMaxOpen

+ const ErrorAbort

+ const ErrorContinue

+ const IgnoreCustom

+ const IgnoreDotIgnore

+ const IgnoreExplicit

+ const IgnoreGitExclude

+ const IgnoreGitGlobal

+ const IgnoreGitIgnore

+ const IgnoreGitModules

+ const IgnoreOverride

+ const OpCanonicalize

+ const OpReadDirectory

+ const OpReadEntry

+ const OpReadMetadata

+ const OpScheduleWorker

+ const RepoMatchHidden

+ const RepoMatchIgnore

+ const RepoMatchInclude

+ const RepoMatchNone

+ const RepoOverrideIgnore

+ const RepoOverrideInclude

+ const RootFollow

+ const RootReject

+ const ScanCacheFormatVersion

+ const ScanDescriptorVersion

+ const SelectedFile

+ const SkipBinary

+ const SkipConcurrentModification

+ const SkipExtension

+ const SkipFileSystemBoundary

+ const SkipHidden

+ const SkipIOError

+ const SkipIgnored

+ const SkipMaxDepth

+ const SkipNone

+ const SkipOverride

+ const SkipOversized

+ const SkipPathEscape

+ const SkipScanLimit

+ const SkipStandardDirectory

+ const SkipSymlink

+ const SkipSymlinkLoop

+ const TraverseDirectory

+ const Unselected

+ const Version

+ const WalkContinue

+ const WalkQuit

+ const WalkSkip

+ const WalkSkipFileSystemBoundary

+ const WalkSkipMaxDepth

+ const WalkSkipNone

+ const WalkSkipPathEscape

+ const WalkSkipSymlinkLoop

+ const WalkTraverseLink

+ var ErrAdmitTimeout = runtime.ErrAdmitTimeout

+ var ErrPartial = dx.ErrPartial

+ var ErrSkipFiles = walk.ErrSkipFiles

+ var ErrStop = dx.ErrStop

+ var ErrTerminateWalk = errors.New("treestamp terminated")

+ var ErrTraverseLink = walk.ErrTraverseLink

+ var SkipAll = fs.SkipAll

+ var SkipDir = fs.SkipDir

+ func CollapsePathPrefixes(prefixes []string) []string

+ func DirEntryDepth(entry fs.DirEntry) int

+ func FindRepositoryRoot(start string) string

+ func IsNotImplemented(err error) bool

+ func IsSameOrDescendant(path, prefix string) bool

+ func MinimumScratchBufferSize() int

+ func NameSort(a, b os.DirEntry) int

+ func NewParallelMultiWalker(root string) *parallelMulti

+ func NewScratchBuffer() []byte

+ func NewStatefulWalkBuilder[R, E any](root string, rootState R) *walk.StatefulWalkBuilder[R, E]

+ func PathCoveredByPrefixes(path string, prefixes []string) bool

+ func ReadDirents(dirname string) ([]os.DirEntry, error)

+ func ReadDirentsScratch(dirname string, scratch []byte) ([]os.DirEntry, error)

+ func ReadDirnames(dirname string, scratch []byte) ([]string, error)

+ func SafeCause(err error) string

+ func ScanPaths(ctx context.Context, root string) ([]string, error)

+ func ScanPathsWith(ctx context.Context, root string, opts ...Option) ([]string, error)

+ func StatDirEntry(path string, entry fs.DirEntry) (fs.FileInfo, error)

+ func Walk(root string, fn WalkDirFunc) error

+ func WalkDefault(root string, fn WalkDirFunc) error

+ func WalkDirs(root string, opts DirWalkOptions) error

+ func WalkFS(fsys fs.FS, root string, fn fs.WalkDirFunc) error

+ func WalkParallel(root string, workers int, fn walk.WalkFunc) error

+ func WalkUnsorted(root string, fn WalkDirFunc) error

+ func WalkWithConfig(root string, cfg Config, fn WalkDirFunc) error

+ type ByteLimit = dx.ByteLimit

+ func LimitBytes(n uint64) ByteLimit

+ func UnlimitedBytes() ByteLimit

+ func ZeroBytes() ByteLimit

+ type CacheValidationPolicy int

+ const CacheValidationFast

+ const CacheValidationStrict

+ type CancellationToken struct

+ func NewCancellationToken() *CancellationToken

+ func (t *CancellationToken) Cancel()

+ func (t *CancellationToken) IsCancelled() bool

+ type ChangedContentVisitOutcome struct

+ FullRescanRequired bool

+ Visited *ChangedContentVisitReport

+ type ChangedContentVisitReport struct

+ Content ContentVisitReport

+ Removed []string

+ type CompactContentEvidence struct

+ BinaryChecked bool

+ ContentFingerprint string

+ ContentHash string

+ Version FileVersion

+ type CompactScanReport struct

+ Cache ScanCacheStats

+ Complete bool

+ Descriptor ScanDescriptor

+ Files []CompactScannedFile

+ IgnoreSources []IgnoreSourceEvidence

+ Portable bool

+ Revision string

+ Root string

+ Skipped []SkippedEntry

+ Termination ScanTermination

+ Warnings []ScanWarning

+ func ScanCompact(ctx context.Context, root string) (*CompactScanReport, error)

+ func (r *CompactScanReport) Summary() ScanSummary

+ func (r *CompactScanReport) ToCache() ScanCache

+ func (r CompactScanReport) AbsolutePath(file CompactScannedFile) string

+ func (r CompactScanReport) IntoScanReport() ScanReport

+ type CompactScannedFile struct

+ Bytes uint64

+ Content *CompactContentEvidence

+ ContentHash string

+ Relative string

+ type Config struct

+ ContentsFirst bool

+ DirsFirst bool

+ Follow bool

+ MaxDepth int

+ NumWorkers int

+ Sort bool

+ ToSlash bool

+ type ContentDiscoveryMode int

+ const ContentDiscoveryBufferedParallel

+ const ContentDiscoveryStreaming

+ type ContentFile struct

+ Absolute string

+ Bytes uint64

+ Relative string

+ Root string

+ RootIndex uint

+ Sequence uint64

+ type ContentFileStatus int

+ const ContentFileBinary

+ const ContentFileChanged

+ const ContentFileSelected

+ type ContentValidationPolicy int

+ const ContentValidationFast

+ const ContentValidationStrict

+ type ContentVisitControl int

+ const ContentVisitContinue

+ const ContentVisitQuit

+ const ContentVisitSkipFile

+ type ContentVisitEvent struct

+ Bytes []byte

+ BytesRead uint64

+ Chunk bool

+ ConsumerSkipped bool

+ ContentHash string

+ File ContentFile

+ FileEnd bool

+ FileStart bool

+ Offset uint64

+ Status ContentFileStatus

+ WorkerIndex int

+ type ContentVisitMode int

+ const ContentVisitRevision

+ const ContentVisitStreaming

+ type ContentVisitReport struct

+ BytesEmitted uint64

+ BytesRead uint64

+ Cache ScanCacheStats

+ Chunks uint64

+ Complete bool

+ Completed uint64

+ ConsumerSkipped uint64

+ Discovered uint64

+ IgnoreSources []IgnoreSourceEvidence

+ Mode ContentVisitMode

+ Opened uint64

+ Portable bool

+ Revision string

+ Root string

+ Skipped []SkippedEntry

+ Stopped bool

+ Termination ScanTermination

+ Warnings []ScanWarning

+ type ContentVisitor func(ContentVisitEvent) ContentVisitControl

+ type DeltaQuality int

+ const DeltaContentHash

+ const DeltaMetadata

+ const DeltaPartial

+ type DirEntry = walk.DirEntry

+ type DirScanner struct

+ func NewDirScanner(dirname string) (*DirScanner, error)

+ func NewDirScannerScratch(dirname string, scratch []byte) (*DirScanner, error)

+ func (s *DirScanner) Close() error

+ func (s *DirScanner) Dirent() (os.DirEntry, error)

+ func (s *DirScanner) Err() error

+ func (s *DirScanner) Name() string

+ func (s *DirScanner) Scan() bool

+ type DirWalkOptions struct

+ Callback WalkDirFunc

+ ContentsFirst bool

+ DirsFirst bool

+ ErrorCallback func(path string, err error) error

+ FollowSymbolicLinks bool

+ NumWorkers int

+ PostChildrenCallback WalkDirFunc

+ ToSlash bool

+ Unsorted bool

+ type Error struct

+ Code ErrorCode

+ Err error

+ Op string

+ Path string

+ func (e *Error) Error() string

+ func (e *Error) Unwrap() error

+ type ErrorCode string

+ const CodeAdmission

+ const CodeCache

+ const CodeCallback

+ const CodeCancelled

+ const CodeChanged

+ const CodeInvalid

+ const CodeLimit

+ const CodeNotImplemented

+ const CodePartial

+ const CodePermission

+ const CodeStale

+ const CodeTimeout

+ const CodeUnavailable

+ const CodeUnsupported

+ const CodeWalk

+ type ErrorPolicy = walk.ErrorPolicy

+ type EvidenceMode int

+ const EvidenceComplete

+ const EvidenceSelectedFiles

+ type FSEntry = walkfs.Entry

+ type FSWalker = walkfs.Walker

+ func NewFSWalker(fsys fs.FS, root string) (*FSWalker, error)

+ type File struct

+ Filename string

+ Location string

+ func (f *File) Path() string

+ type FileIdentity = platform.Identity

+ type FileVersion = walk.FileVersion

+ type FileWalker struct

+ CustomIgnore []string

+ CustomIgnorePatterns []string

+ ExcludeDirectory []string

+ ExcludeDirectoryRegex []*regexp.Regexp

+ ExcludeFilename []string

+ ExcludeFilenameRegex []*regexp.Regexp

+ ExcludeListExtensions []string

+ IncludeDirectory []string

+ IncludeDirectoryRegex []*regexp.Regexp

+ IncludeFilename []string

+ IncludeFilenameRegex []*regexp.Regexp

+ LocationExcludePattern []string

+ func NewFileWalker(directory string, queue chan *File) *FileWalker

+ func NewParallelFileWalker(directory string, queue chan *File, workers int) *FileWalker

+ func (w *FileWalker) AddRoot(directory string) *FileWalker

+ func (w *FileWalker) AllowListExtensions(exts ...string) *FileWalker

+ func (w *FileWalker) IgnoreBinaryFiles() *FileWalker

+ func (w *FileWalker) IgnoreGitignore() *FileWalker

+ func (w *FileWalker) IgnoreIgnoreFile() *FileWalker

+ func (w *FileWalker) IncludeHidden(enabled bool) *FileWalker

+ func (w *FileWalker) RespectGitModules() *FileWalker

+ func (w *FileWalker) SetConcurrency(n int) *FileWalker

+ func (w *FileWalker) SetErrorHandler(fn func(error) bool) *FileWalker

+ func (w *FileWalker) SetMaxDepth(n int) *FileWalker

+ func (w *FileWalker) Start() error

+ func (w *FileWalker) Terminate()

+ func (w *FileWalker) Walking() bool

+ type Filters = selection.Filters

+ func CompileFilters(includeNames, excludeNames, includeDirs, excludeDirs []string, ...) (Filters, error)

+ type FullRescanReason int

+ const FullRescanIgnoreInputChanged

+ const FullRescanIncompletePreviousState

+ const FullRescanPolicyChanged

+ const FullRescanStructuralChange

+ type IgnoreFile struct

+ Kind IgnoreSourceKind

+ Location string

+ type IgnorePolicy struct

+ func GitCompatibleIgnorePolicy() IgnorePolicy

+ func NoneIgnorePolicy() IgnorePolicy

+ func RepositoryIgnorePolicy() IgnorePolicy

+ func (p IgnorePolicy) WithCustomIgnore(enabled bool) IgnorePolicy

+ func (p IgnorePolicy) WithDotIgnore(enabled bool) IgnorePolicy

+ func (p IgnorePolicy) WithExplicitFile(path string) IgnorePolicy

+ func (p IgnorePolicy) WithGitExclude(enabled bool) IgnorePolicy

+ func (p IgnorePolicy) WithGitGlobal(enabled bool) IgnorePolicy

+ func (p IgnorePolicy) WithGitIgnore(enabled bool) IgnorePolicy

+ func (p IgnorePolicy) WithParentRules(enabled bool) IgnorePolicy

+ func (p IgnorePolicy) WithRequireGit(enabled bool) IgnorePolicy

+ type IgnoreSourceEvidence struct

+ ContentHash string

+ Kind IgnoreSourceKind

+ Location string

+ type IgnoreSourceKind = ignore.SourceKind

+ type ModifiedFile struct

+ Current ScannedFile

+ Previous ScannedFile

+ type MultiContentVisitReport struct

+ Reports []ContentVisitReport

+ func (r MultiContentVisitReport) IsEmpty() bool

+ func (r MultiContentVisitReport) Len() int

+ type MultiScanReport struct

+ Reports []*ScanReport

+ func (r MultiScanReport) IsEmpty() bool

+ func (r MultiScanReport) Len() int

+ type MultiScanner struct

+ func NewMultiScanner(root string) *MultiScanner

+ func (m *MultiScanner) AddRoot(root string) *MultiScanner

+ func (m *MultiScanner) Options(options Options) *MultiScanner

+ func (m *MultiScanner) Scan(ctx context.Context) (*MultiScanReport, error)

+ func (m *MultiScanner) VisitContent(ctx context.Context, factory func(root, worker int) ContentVisitor) (*MultiContentVisitReport, error)

+ func (m *MultiScanner) WithAdmitTimeout(d time.Duration) *MultiScanner

+ func (m *MultiScanner) WithRootParallelism(n int) *MultiScanner

+ type MultiWalker = walk.MultiWalker

+ type NamedFileTypes = filetypes.NamedFileTypes

+ func DefaultFileTypes() *NamedFileTypes

+ type Option func(*planBuilder) error

+ func Using(opts Options) Option

+ func WithDetectBinary(on bool) Option

+ func WithExcludeGlobs(globs ...string) Option

+ func WithExtensions(exts ...string) Option

+ func WithFailFast() Option

+ func WithFilenameRegex(patterns ...string) Option

+ func WithHashContents(on bool) Option

+ func WithLocationExclude(globs ...string) Option

+ func WithLogger(logger *slog.Logger) Option

+ func WithMaxFileBytes(n uint64) Option

+ func WithNoIgnore() Option

+ func WithProgress(fn func(Progress)) Option

+ func WithReadLimit(lim ByteLimit) Option

+ func WithRequireCache() Option

+ func WithScope(globs ...string) Option

+ type Options struct

+ CacheValidation CacheValidationPolicy

+ Cancellation *CancellationToken

+ ContentDiscovery ContentDiscoveryMode

+ ContentValidation ContentValidationPolicy

+ ContentWorkers int

+ DetectBinaryFiles bool

+ Evidence EvidenceMode

+ EvidenceComplete bool

+ Extensions []string

+ FileTypes *filetypes.NamedFileTypes

+ Filters selection.Filters

+ GitModules bool

+ HashFileContents bool

+ IgnoreCase bool

+ IgnoreFiles []string

+ IgnorePolicy IgnorePolicy

+ Limits ScanLimits

+ MaxFileBytes uint64

+ OverrideRules []string

+ SkipHidden bool

+ StandardSkips bool

+ TraversalWorkers int

+ Walk WalkOptions

+ func DefaultOptions() Options

+ func (o Options) MetadataOnly() Options

+ func (o Options) SelectedFilesOnly() Options

+ func (o Options) WithCacheValidation(policy CacheValidationPolicy) Options

+ func (o Options) WithCancellation(token *CancellationToken) Options

+ func (o Options) WithContentDiscovery(mode ContentDiscoveryMode) Options

+ func (o Options) WithContentParallelism(n int) Options

+ func (o Options) WithContentValidation(policy ContentValidationPolicy) Options

+ func (o Options) WithExcludeDirectories(dirs ...string) Options

+ func (o Options) WithExcludeDirectoryRegex(patterns ...string) Options

+ func (o Options) WithExcludeFilenameRegex(patterns ...string) Options

+ func (o Options) WithExcludeFilenames(names ...string) Options

+ func (o Options) WithExtensions(exts ...string) Options

+ func (o Options) WithFileTypes(types *NamedFileTypes) Options

+ func (o Options) WithFilters(filters selection.Filters) Options

+ func (o Options) WithGitModules(enabled bool) Options

+ func (o Options) WithIgnoreCase(enabled bool) Options

+ func (o Options) WithIgnoreFiles(names ...string) Options

+ func (o Options) WithIgnorePolicy(policy IgnorePolicy) Options

+ func (o Options) WithIncludeFilenameRegex(patterns ...string) Options

+ func (o Options) WithIncludeFilenames(names ...string) Options

+ func (o Options) WithMaxEntries(n uint64) Options

+ func (o Options) WithMaxFileBytes(n uint64) Options

+ func (o Options) WithMaxTotalBytes(n uint64) Options

+ func (o Options) WithOverrideRules(rules ...string) Options

+ func (o Options) WithParallelism(n int) Options

+ func (o Options) WithSkipHidden(enabled bool) Options

+ func (o Options) WithStandardSkips(enabled bool) Options

+ func (o Options) WithTimeout(d time.Duration) Options

+ func (o Options) WithTraversalParallelism(n int) Options

+ type ParallelExecutor = runtime.Executor

+ type ParallelJob = runtime.Job

+ type ParallelMultiVisitReport struct

+ Errors []*WalkError

+ Quit bool

+ Visited uint64

+ type ParallelMultiWalkEvent struct

+ Event WalkEvent

+ RootIndex int

+ type ParallelMultiWalkReport struct

+ Reports []ParallelWalkReport

+ type ParallelMultiWalker = walk.MultiWalker

+ type ParallelRuntime = runtime.Runtime

+ func DedicatedRuntime(n int) ParallelRuntime

+ func GlobalRuntime() ParallelRuntime

+ func OwnedRuntime(exec ParallelExecutor) ParallelRuntime

+ type ParallelVisitReport = walk.ParallelVisitReport

+ type ParallelWalkIter = walk.ParallelWalkIter

+ type ParallelWalkReport = walk.ParallelWalkReport

+ type ParallelWalker = walk.ParallelWalker

+ func NewParallelWalker(root string) *ParallelWalker

+ type PathExplanation struct

+ Line int

+ Outcome string

+ Pattern string

+ Reason string

+ Relative string

+ Source string

+ func Explain(root, relative string, opts ...Option) (PathExplanation, error)

+ type PathQuery = selection.PathQuery

+ type Plan struct

+ func Compile(opts ...Option) (*Plan, error)

+ func (p *Plan) Describe() string

+ func (p *Plan) EachFile(ctx context.Context, root string, consume func(ScannedFile, []byte) error) (*ScanSummary, error)

+ func (p *Plan) Explain(root, relative string) (PathExplanation, error)

+ func (p *Plan) Files(ctx context.Context, root string) iter.Seq2[ScannedFile, error]

+ func (p *Plan) Scan(ctx context.Context, root string) (*ScanReport, error)

+ func (p *Plan) ScanCached(ctx context.Context, root string, cache *ScanCache) (*ScanReport, error)

+ func (p *Plan) ScanPaths(ctx context.Context, root string) ([]string, error)

+ func (p *Plan) WriteDiagnostics(w io.Writer, sum *ScanSummary) error

+ type PortableIgnoreSourceEvidence struct

+ ContentHash string

+ Kind IgnoreSourceKind

+ RepositoryRelative string

+ type PortableScanReport struct

+ Complete bool

+ Descriptor ScanDescriptor

+ Files []PortableScannedFile

+ IgnoreSources []PortableIgnoreSourceEvidence

+ Revision string

+ SelectionPortable bool

+ Skipped []PortableSkippedEntry

+ Termination ScanTermination

+ Warnings []PortableScanWarning

+ type PortableScanWarning struct

+ MessageHash string

+ Relative string

+ type PortableScannedFile struct

+ BinaryChecked bool

+ Bytes uint64

+ ContentHash string

+ Relative string

+ type PortableSkippedEntry struct

+ DetailHash string

+ Kind SkipKind

+ Relative string

+ type Progress = dx.Progress

+ type RenamedFile struct

+ Current ScannedFile

+ Previous ScannedFile

+ type RepositoryMatch = ignore.Match

+ type RepositoryMatcher struct

+ func NewRepositoryMatcher(root string, opts Options) (*RepositoryMatcher, error)

+ func (m *RepositoryMatcher) EnterDir(abs, rel string) []string

+ func (m *RepositoryMatcher) Match(relative string, isDir bool) RepositoryMatch

+ func (m *RepositoryMatcher) Sources() []IgnoreSourceEvidence

+ type RootSymlinkPolicy = walk.RootSymlinkPolicy

+ type ScanCache struct

+ Entries []ScanCacheEntry

+ FormatVersion uint32

+ Root string

+ func (c *ScanCache) ApplyWatchPlan(plan WatchPlan) int

+ func (c *ScanCache) Invalidate(relativePaths []string) int

+ func (c ScanCache) IsCompatible(root string) bool

+ type ScanCacheEntry struct

+ BinaryChecked bool

+ Bytes uint64

+ ContentFingerprint string

+ ContentHash string

+ Relative string

+ Version FileVersion

+ type ScanCacheStats struct

+ ContentReads uint64

+ FingerprintReads uint64

+ Rebuilt bool

+ ReusedHashes uint64

+ type ScanDelta struct

+ Added []ScannedFile

+ FromRevision string

+ Modified []ModifiedFile

+ PolicyChanged bool

+ Quality DeltaQuality

+ Removed []ScannedFile

+ Renamed []RenamedFile

+ ScanStateChanged bool

+ SelectionInputsChanged bool

+ ToRevision string

+ Unchanged uint64

+ func DeltaBetween(previous, current *ScanReport) ScanDelta

+ func (d ScanDelta) IsEmpty() bool

+ type ScanDescriptor struct

+ Policy string

+ Version uint32

+ func DescriptorFromOptions(opts Options) ScanDescriptor

+ func (d ScanDescriptor) Matches(opts Options) bool

+ type ScanLimits struct

+ MaxEntries *uint64

+ MaxTotalBytes *uint64

+ Timeout time.Duration

+ type ScanOptions = Options

+ type ScanReport struct

+ Cache ScanCacheStats

+ Complete bool

+ Descriptor ScanDescriptor

+ Files []ScannedFile

+ IgnoreSources []IgnoreSourceEvidence

+ Portable bool

+ Revision string

+ Root string

+ Skipped []SkippedEntry

+ Termination ScanTermination

+ Warnings []ScanWarning

+ func Scan(ctx context.Context, root string) (*ScanReport, error)

+ func ScanWith(ctx context.Context, root string, opts ...Option) (*ScanReport, error)

+ func (r *ScanReport) ContentProvider() (*SnapshotContentProvider, error)

+ func (r *ScanReport) Delta(current *ScanReport) ScanDelta

+ func (r *ScanReport) PortableFilesPage(offset, limit int) []PortableScannedFile

+ func (r *ScanReport) Summary() ScanSummary

+ func (r *ScanReport) ToCache() ScanCache

+ func (r *ScanReport) ToCompact() CompactScanReport

+ func (r *ScanReport) ToPortable() PortableScanReport

+ type ScanSession struct

+ func OpenScanSession(ctx context.Context, root string, opts Options) (*ScanSession, error)

+ func (s *ScanSession) ApplyWatchPlan(ctx context.Context, plan WatchPlan) (*ScanReport, error)

+ func (s *ScanSession) ApplyWatchPlanWithCancellation(ctx context.Context, plan WatchPlan, cancel *CancellationToken) (*ScanReport, error)

+ func (s *ScanSession) FilesPage(generation uint64, offset, limit int) ([]PortableScannedFile, error)

+ func (s *ScanSession) Generation() uint64

+ func (s *ScanSession) IntoReport() *ScanReport

+ func (s *ScanSession) LastUpdateReason() (WatchUpdateReason, bool)

+ func (s *ScanSession) Report() *ScanReport

+ func (s *ScanSession) Rescan(ctx context.Context) (*ScanReport, error)

+ func (s *ScanSession) Root() string

+ func (s *ScanSession) TreeRevision() string

+ type ScanSink interface

+ OnFile func(*ScannedFile) ScanSinkControl

+ type ScanSinkControl int

+ const ScanSinkContinue

+ const ScanSinkStop

+ type ScanSinkFunc func(*ScannedFile) ScanSinkControl

+ func (f ScanSinkFunc) OnFile(file *ScannedFile) ScanSinkControl

+ type ScanStreamReport struct

+ Cache ScanCacheStats

+ Complete bool

+ Emitted uint64

+ IgnoreSources []IgnoreSourceEvidence

+ Portable bool

+ Revision string

+ Root string

+ Selected uint64

+ Skipped []SkippedEntry

+ Stopped bool

+ Termination ScanTermination

+ Warnings []ScanWarning

+ func ScanIntoErr(ctx context.Context, root string, fn func(*ScannedFile) error, opts ...Option) (*ScanStreamReport, error)

+ type ScanSummary struct

+ BinaryCheckedFiles int

+ Cache ScanCacheStats

+ Complete bool

+ HashedFiles int

+ IgnoreSources int

+ Portable bool

+ RecordedSkips int

+ SelectedBytes uint64

+ SelectedFiles int

+ SkippedByKind map[SkipKind]int

+ Stopped bool

+ Termination ScanTermination

+ Warnings int

+ func EachFile(ctx context.Context, root string, consume func(ScannedFile, []byte) error, ...) (*ScanSummary, error)

+ func (s ScanSummary) LogValue() slog.Value

+ func (s ScanSummary) String() string

+ type ScanTermination int

+ const TerminationCancelled

+ const TerminationMaxEntries

+ const TerminationMaxTotalBytes

+ const TerminationNone

+ const TerminationTimeout

+ func (t ScanTermination) String() string

+ type ScanWarning struct

+ Message string

+ Relative string

+ type ScannedFile struct

+ Absolute string

+ Binary bool

+ BinaryChecked bool

+ Bytes uint64

+ ContentFingerprint string

+ ContentHash string

+ Relative string

+ Version FileVersion

+ func (f ScannedFile) AbsolutePath() string

+ type Scanner struct

+ func NewScanner(root string, opts ...ScannerOption) (*Scanner, error)

+ func (s *Scanner) Explain(rel string) (PathExplanation, error)

+ func (s *Scanner) Options(options Options) *Scanner

+ func (s *Scanner) Scan(ctx context.Context) (*ScanReport, error)

+ func (s *Scanner) ScanCached(ctx context.Context, cache *ScanCache) (*ScanReport, error)

+ func (s *Scanner) ScanCompact(ctx context.Context) (*CompactScanReport, error)

+ func (s *Scanner) ScanIncremental(ctx context.Context, previous *ScanReport) (*ScanReport, error)

+ func (s *Scanner) ScanInto(ctx context.Context, sink ScanSink) (*ScanStreamReport, error)

+ func (s *Scanner) ScanPaths(ctx context.Context) ([]string, error)

+ func (s *Scanner) ScanWatchPlan(ctx context.Context, previous *ScanReport, plan WatchPlan) (*ScanReport, error)

+ func (s *Scanner) ScanWatchPlanDetailed(ctx context.Context, previous *ScanReport, plan WatchPlan) (*WatchUpdate, error)

+ func (s *Scanner) VisitChangedContent(ctx context.Context, plan WatchPlan, factory func(worker int) ContentVisitor) (ChangedContentVisitOutcome, error)

+ func (s *Scanner) VisitContent(ctx context.Context, factory func(worker int) ContentVisitor) (*ContentVisitReport, error)

+ func (s *Scanner) VisitContentManifest(ctx context.Context, factory func(worker int) ContentVisitor) (*CompactScanReport, error)

+ func (s *Scanner) VisitContentStreaming(ctx context.Context, factory func(worker int) ContentVisitor) (*ContentVisitReport, error)

+ type ScannerOption func(*scannerConfig)

+ func WithContentWorkers(n int) ScannerOption

+ func WithOptions(options Options) ScannerOption

+ func WithTraversalWorkers(n int) ScannerOption

+ type SelectionDecision = selection.Decision

+ type SelectionDisposition = selection.Disposition

+ type SelectionMatcher = selection.Matcher

+ func NewSelectionMatcher(root string, opts Options) (*SelectionMatcher, error)

+ type SkipKind = selection.SkipKind

+ type SkippedEntry struct

+ Detail string

+ Kind SkipKind

+ Relative string

+ type SnapshotContent struct

+ Bytes []byte

+ Evidence SnapshotEvidence

+ Relative string

+ type SnapshotContentProvider struct

+ func (p *SnapshotContentProvider) Open(relative string) (*SnapshotContent, error)

+ func (p *SnapshotContentProvider) Read(relative string) (*SnapshotContent, error)

+ func (p *SnapshotContentProvider) ReadBounded(relative string, maxBytes uint64) (*SnapshotContent, error)

+ type SnapshotEvidence int

+ const SnapshotFileVersion

+ const SnapshotSHA256

+ type SnapshotReadError struct

+ Bytes uint64

+ Err error

+ MaxBytes uint64

+ Reason string

+ Relative string

+ func (e *SnapshotReadError) Error() string

+ func (e *SnapshotReadError) Unwrap() error

+ type StandardSkips int

+ const StandardSkipsDisabled

+ const StandardSkipsEnabled

+ type TreeSnapshot struct

+ Cover merkle.Coverage

+ func SnapshotFromFiles(files []ScannedFile) *TreeSnapshot

+ func (s *TreeSnapshot) Apply(upserts, deletes []ScannedFile) *TreeSnapshot

+ func (s *TreeSnapshot) Len() int

+ func (s *TreeSnapshot) TreeRevision() string

+ type WalkBuilder = walk.Builder

+ func NewWalkBuilder(root string) *WalkBuilder

+ type WalkControl = walk.WalkControl

+ type WalkDirFunc = fs.WalkDirFunc

+ func IgnoreDuplicateDirs(fn WalkDirFunc) WalkDirFunc

+ func IgnoreDuplicateFiles(fn WalkDirFunc) WalkDirFunc

+ type WalkEntry = walk.WalkEntry

+ func CollectParallel(root string, workers int, sortPaths bool) ([]*WalkEntry, error)

+ func CollectWalk(next func() (*WalkEntry, error)) ([]*WalkEntry, error)

+ type WalkError = walk.WalkError

+ type WalkEvent = walk.WalkEvent

+ type WalkFunc = walk.WalkFunc

+ type WalkOperation = walk.WalkOperation

+ type WalkOptions = walk.WalkOptions

+ func DefaultWalkOptions() WalkOptions

+ type WalkSkipReason = walk.WalkSkipReason

+ type Walker = walk.Walker

+ func NewWalker(root string) (*Walker, error)

+ func NewWalkerWithOptions(root string, options WalkOptions) (*Walker, error)

+ type WatchEvent struct

+ Kind WatchEventKind

+ Path string

+ func NewWatchEvent(path string, kind WatchEventKind) WatchEvent

+ type WatchEventKind int

+ const WatchCreate

+ const WatchDirectory

+ const WatchModify

+ const WatchRemove

+ const WatchRenameFrom

+ const WatchRenameTo

+ const WatchRescan

+ type WatchPlan struct

+ Changed []string

+ FullRescan bool

+ RejectedEvents uint64

+ Removed []string

+ func (p WatchPlan) ExpandRemoved(known []string) []string

+ func (p WatchPlan) Invalidated() []string

+ func (p WatchPlan) InvalidatesPath(relative string) bool

+ type WatchUpdate struct

+ Reason WatchUpdateReason

+ Report *ScanReport

+ type WatchUpdateReason int

+ const WatchReasonFullIgnore

+ const WatchReasonFullIncomplete

+ const WatchReasonFullPolicy

+ const WatchReasonFullStructural

+ const WatchReasonIncremental

+ func (r WatchUpdateReason) AsString() string

+ func (r WatchUpdateReason) String() string

+ type WatcherEventAdapter struct

+ func NewWatcherEventAdapter(root string, ignoreFiles []string) (*WatcherEventAdapter, error)

+ func NewWatcherEventAdapterWithOptions(root string, opts Options) (*WatcherEventAdapter, error)

+ func (a *WatcherEventAdapter) Plan(events []WatchEvent) WatchPlan

v0.1.0-alpha.1

Sep 16, 2026

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