output

Documentation

Index

• type JSONSummaryWriter
  • func NewJSONSummaryWriter(writer io.Writer, prefix, indent string) *JSONSummaryWriter
  • func (w *JSONSummaryWriter) WriteSummary(sum ScanSummary) error
• type ScanResult
• type ScanStats
• type ScanSummary
• type SummaryWriter
• type YAMLSummaryWriter
  • func NewYAMLSummaryWriter(writer io.Writer) *YAMLSummaryWriter
  • func (w *YAMLSummaryWriter) WriteSummary(sum ScanSummary) error

Types

type JSONSummaryWriter

type JSONSummaryWriter struct {
	Prefix string
	Indent string
	// contains filtered or unexported fields
}

func NewJSONSummaryWriter

func NewJSONSummaryWriter(writer io.Writer, prefix, indent string) *JSONSummaryWriter

func (*JSONSummaryWriter) WriteSummary

func (w *JSONSummaryWriter) WriteSummary(sum ScanSummary) error

type ScanResult

type ScanResult struct {
	File string         `json:"file" yaml:"file"`
	Hits []keywords.Hit `json:"hits" yaml:"hits`
}

type ScanStats

type ScanStats struct {
	FilesScanned int     `json:"filesScanned" yaml:"filesScanned"`
	FilesHit     int     `json:"filesHit" yaml:"filesHit"`
	TotalHits    int     `json:"totalHits" yaml:"totalHits"`
	Duration     float64 `json:"duration" yaml:"duration"`
}

type ScanSummary

type ScanSummary struct {
	InputFile string       `json:"inputFile" yaml:"inputFile"`
	Results   []ScanResult `json:"results" yaml:"results"`
	Stats     ScanStats    `json:"stats" yaml:"stats"`
}

type SummaryWriter

type SummaryWriter interface {
	WriteSummary(ScanSummary) error
}

type YAMLSummaryWriter

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

func NewYAMLSummaryWriter

func NewYAMLSummaryWriter(writer io.Writer) *YAMLSummaryWriter

func (*YAMLSummaryWriter) WriteSummary

func (w *YAMLSummaryWriter) WriteSummary(sum ScanSummary) error