package cformat

Import Path
	internal/coverage/cformat (on go.dev)

Dependency Relation
	imports 8 packages, and imported by one package

Involved Source Files

	    format.go
Package-Level Type Names (only one)

	/* sort by: alphabet | popularity */
	 type Formatter (struct)

		Methods (total 5)
			(*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.

			(*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.

			(*Formatter) EmitPercent(w io.Writer, pkgs []string, inpkgs string, noteEmpty bool, aggregate bool) error
				EmitPercent writes out a "percentage covered" string to the writer
				'w', selecting the set of packages in 'pkgs' and suffixing the
				printed string with 'inpkgs'.

			(*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).

			(*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.

		As Outputs Of (at least one exported)
			func NewFormatter(cm coverage.CounterMode) *Formatter


Package-Level Functions (only one)

	 func NewFormatter(cm coverage.CounterMode) *Formatter

The pages are generated with Golds v0.7.0-preview. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.