local

Documentation

Overview

Package local implements CompilationAnalyzer utilities for local analyses.

Index

• type FileQueue
  • func NewFileQueue(paths []string, opts *Options) *FileQueue
  • func (q *FileQueue) Fetch(path, digest string) ([]byte, error)
  • func (q *FileQueue) Next(ctx context.Context, f driver.CompilationFunc) error
• type Options

Types

type FileQueue

type FileQueue struct {
	// contains filtered or unexported fields
}

A FileQueue is a driver.Queue reading each compilation from a sequence of .kzip and .kindex files. On each call to the driver.CompilationFunc, the FileQueue's analysis.Fetcher interface exposes the current file's contents.

func NewFileQueue

func NewFileQueue(paths []string, opts *Options) *FileQueue

NewFileQueue returns a new FileQueue over the given paths to .kzip or .kindex files.

func (*FileQueue) Fetch

func (q *FileQueue) Fetch(path, digest string) ([]byte, error)

Fetch implements the analysis.Fetcher interface by delegating to the currently-active input file. Only files in the current archive will be accessible for a given invocation of Fetch.

func (*FileQueue) Next

func (q *FileQueue) Next(ctx context.Context, f driver.CompilationFunc) error

Next implements the driver.Queue interface.

type Options

type Options struct {
	// The revision marker to attribute to each compilation.
	Revision string
}

Options control the behaviour of a FileQueue.