cformat

Documentation

Index

• type Formatter
  • func NewFormatter(cm coverage.CounterMode) *Formatter
  • func (fm *Formatter) AddUnit(file string, fname string, isfnlit bool, unit coverage.CoverableUnit, ...)
  • func (fm *Formatter) EmitFuncs(w io.Writer) error
  • func (fm *Formatter) EmitPercent(w io.Writer, covpkgs string, noteEmpty bool, aggregate bool) error
  • func (fm *Formatter) EmitTextual(w io.Writer) error
  • func (fm *Formatter) SetPackage(importpath string)

Types

type Formatter

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

func NewFormatter

func NewFormatter(cm coverage.CounterMode) *Formatter

func (*Formatter) AddUnit

func (fm *Formatter) AddUnit(file string, fname string, isfnlit bool, unit coverage.CoverableUnit, count uint32)

AddUnit passes info on a single coverable unit (file, funcname, literal flag, range of lines, and counter value) to the formatter. Counter values will be accumulated where appropriate.

func (*Formatter) EmitFuncs

func (fm *Formatter) EmitFuncs(w io.Writer) error

EmitFuncs writes out a function-level summary to the writer 'w'. A note on handling function literals: although we collect coverage data for unnamed literals, it probably does not make sense to include them in the function summary since there isn't any good way to name them (this is also consistent with the legacy cmd/cover implementation). We do want to include their counts in the overall summary however.

func (*Formatter) EmitPercent

func (fm *Formatter) EmitPercent(w io.Writer, covpkgs string, noteEmpty bool, aggregate bool) error

EmitPercent writes out a "percentage covered" string to the writer 'w'.

func (*Formatter) EmitTextual

func (fm *Formatter) EmitTextual(w io.Writer) error

EmitTextual writes the accumulated coverage data in the legacy cmd/cover text format to the writer 'w'. We sort the data items by importpath, source file, and line number before emitting (this sorting is not explicitly mandated by the format, but seems like a good idea for repeatable/deterministic dumps).

func (*Formatter) SetPackage

func (fm *Formatter) SetPackage(importpath string)

SetPackage tells the formatter that we're about to visit the coverage data for the package with the specified import path. Note that it's OK to call SetPackage more than once with the same import path; counter data values will be accumulated.