fileset

Documentation

Overview

Package fileset provides a utility for resolving the file paths defined by a FileSet proto.

Index

• func ApplyOptOutConfig(fileSet *ipb.FileSet, config *apb.OptOutConfig)
• func FileSetToString(fileSet *ipb.FileSet) string
• func WalkFiles(ctx context.Context, fileSet *ipb.FileSet, fs scanapi.Filesystem, ...) error
• type WalkFunc

Functions

func ApplyOptOutConfig

func ApplyOptOutConfig(fileSet *ipb.FileSet, config *apb.OptOutConfig)

ApplyOptOutConfig applies the directory traversal opt-out settings from an OptOutConfig to a FileSet.

func FileSetToString

func FileSetToString(fileSet *ipb.FileSet) string

FileSetToString returns the string representation of a FileSet.

func WalkFiles

func WalkFiles(ctx context.Context, fileSet *ipb.FileSet, fs scanapi.Filesystem, timeout time.Time, walkFunc WalkFunc) error

WalkFiles calls walkFunc for each file described by the provided FileSet.

Types

type WalkFunc

type WalkFunc func(path string, isDir bool) error

WalkFunc is the type of the function called by WalkFiles to visit each file or directory in the FileSet. If the function returns an error, WalkFiles stops and returns the same error.