types

Documentation

Overview

Package types provides common types for audit report formats.

Index

• type FormatError
  • func (e *FormatError) Error() string
• type ParsingError
  • func (e *ParsingError) Error() string
  • func (e *ParsingError) Unwrap() error
• type Report

Types

type FormatError

type FormatError struct {
	Type          string
	PrintableType string
}

FormatError indicates that a given string could be parsed as a particular audit report type, but does not satisfy the required format for that type of audit report.

func (*FormatError) Error

func (e *FormatError) Error() string

type ParsingError

type ParsingError struct {
	Type          string
	PrintableType string
	Err           error
}

ParsingError indicates that a given string could not be parsed as a particular audit report type.

func (*ParsingError) Error

func (e *ParsingError) Error() string

func (*ParsingError) Unwrap

func (e *ParsingError) Unwrap() error

type Report

type Report interface {
	// SetPackagePath sets the path to the package to which this audit report
	// belongs.
	SetPackagePath(string)

	// Type returns a short textual description of this report type.
	Type() string

	// AsIssues transforms this Report into a slice of Dracon Issues that can be
	// processed by the Dracon enricher.
	AsIssues() []*v1.Issue
}

Report is an interface for audit report formats.