verifier

Documentation

Index

• type Result
  • func NewError(err ...string) Result
  • func NewResult() Result
  • func NewWarning(warn ...string) Result
  • func (vr *Result) AddErrors(err ...string)
  • func (vr *Result) AddGroupError(groupName string, reason string)
  • func (vr *Result) AddGroupWarning(groupName string, reason string)
  • func (vr *Result) AddParamError(paramName string, reason string)
  • func (vr *Result) AddParamWarning(paramName string, reason string)
  • func (vr *Result) AddWarnings(wrn ...string)
  • func (vr *Result) ErrorsAsString() string
  • func (vr *Result) ForOutput() ResultForOutput
  • func (vr *Result) IsEmpty() bool
  • func (vr *Result) IsValid() bool
  • func (vr *Result) Merge(other Result)
  • func (vr *Result) PrintErrors(out io.Writer)
  • func (vr *Result) PrintWarnings(out io.Writer)
• type ResultForOutput

Types

type Result

type Result struct {
	Errors   []string
	Warnings []string
}

Result holds the errors and warnings of a package verification

func NewError

func NewError(err ...string) Result

func NewResult

func NewResult() Result

NewResult initializes the Result struct

func NewWarning

func NewWarning(warn ...string) Result

func (*Result) AddErrors

func (vr *Result) AddErrors(err ...string)

AddErrors adds an arbitrary error string to the verification result

func (*Result) AddGroupError

func (vr *Result) AddGroupError(groupName string, reason string)

func (*Result) AddGroupWarning

func (vr *Result) AddGroupWarning(groupName string, reason string)

func (*Result) AddParamError

func (vr *Result) AddParamError(paramName string, reason string)

AddParamError adds a formatted error string for a package parameter error

func (*Result) AddParamWarning

func (vr *Result) AddParamWarning(paramName string, reason string)

AddParamWarning adds a formatted warning string for a package parameter error

func (*Result) AddWarnings

func (vr *Result) AddWarnings(wrn ...string)

AddWarnings adds an arbitrary warning string to the verification result

func (*Result) ErrorsAsString

func (vr *Result) ErrorsAsString() string

ErrorsAsString returns all errors as a single string

func (*Result) ForOutput

func (vr *Result) ForOutput() ResultForOutput

func (*Result) IsEmpty

func (vr *Result) IsEmpty() bool

IsEmpty returns true if verification result has no errors AND no warnings

func (*Result) IsValid

func (vr *Result) IsValid() bool

IsValid returns true if verification result does not have errors

func (*Result) Merge

func (vr *Result) Merge(other Result)

Merge method merges the errors and warnings from two verification results

func (*Result) PrintErrors

func (vr *Result) PrintErrors(out io.Writer)

PrintErrors is a pretty printer for verification errors

func (*Result) PrintWarnings

func (vr *Result) PrintWarnings(out io.Writer)

PrintWarnings is a pretty printer for verification warnings

type ResultForOutput

type ResultForOutput struct {
	Errors   []string `json:"errors"`
	Warnings []string `json:"warnings"`
	Valid    bool     `json:"valid"`
}

ResultForOutput provides a serialization format for yaml/json output of a result