collect

Documentation

Overview

Package collect provides functionality to collect file paths for processing.

Index

• type IPath
  • func NewPath(kind kind.Kind, val string, err error) IPath
• type IPathCollector
  • func NewPathCollector(kind kind.Kind, baseDir string, defaultPathVals []string, ...) (IPathCollector, error)

Types

type IPath

type IPath interface {
	Kind() kind.Kind
	SetKind(kind kind.Kind)
	Val() string
	SetVal(val string)
	Err() error
	SetErr(err error)
}

IPath provides an interface for Paths collected by IPathCollectors.

func NewPath

func NewPath(kind kind.Kind, val string, err error) IPath

NewPath is a path of a specific kind, such as a Dockerfile, Composefile, or Kubernetesfile.

type IPathCollector

type IPathCollector interface {
	Kind() kind.Kind
	CollectPaths(done <-chan struct{}) <-chan IPath
}

IPathCollector provides an interface for PathCollectors, which collect paths to be processed downstream.

func NewPathCollector

func NewPathCollector(
	kind kind.Kind,
	baseDir string,
	defaultPathVals []string,
	manualPathVals []string,
	globVals []string,
	recursive bool,
) (IPathCollector, error)

NewPathCollector returns an IPathCollector after validating its fields. If recursive is true, defaultPathVals must be defined so the collector knows which files to collect as it recurs.