yaml

Documentation

Index

• func OptionWithDataDirs(paths ...string) func(s *Scanner)
• func OptionWithDebug(debugWriter io.Writer) func(s *Scanner)
• func OptionWithPolicyDirs(paths ...string) func(s *Scanner)
• func OptionWithPolicyNamespaces(namespaces ...string) func(s *Scanner)
• type Option
  • func OptionWithTrace(w io.Writer) Option
• type Scanner
  • func NewScanner(options ...Option) *Scanner
  • func (s *Scanner) ScanFS(ctx context.Context, fs fs.FS, path string) (scan.Results, error)
  • func (s *Scanner) ScanFile(ctx context.Context, fs fs.FS, path string) (scan.Results, error)

Functions

func OptionWithDataDirs

func OptionWithDataDirs(paths ...string) func(s *Scanner)

func OptionWithDebug

func OptionWithDebug(debugWriter io.Writer) func(s *Scanner)

OptionWithDebug - pass the scanner an io.Writer to log debug messages to

func OptionWithPolicyDirs

func OptionWithPolicyDirs(paths ...string) func(s *Scanner)

func OptionWithPolicyNamespaces

func OptionWithPolicyNamespaces(namespaces ...string) func(s *Scanner)

OptionWithPolicyNamespaces - namespaces which indicate rego policies containing enforced rules

Types

type Option

type Option func(s *Scanner)

func OptionWithTrace

func OptionWithTrace(w io.Writer) Option

type Scanner

type Scanner struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func NewScanner

func NewScanner(options ...Option) *Scanner

func (*Scanner) ScanFS

func (s *Scanner) ScanFS(ctx context.Context, fs fs.FS, path string) (scan.Results, error)

func (*Scanner) ScanFile

func (s *Scanner) ScanFile(ctx context.Context, fs fs.FS, path string) (scan.Results, error)