package decodecounter

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

Dependency Relation
	imports 9 packages, and imported by one package

Involved Source Files

	    decodecounterfile.go
Package-Level Type Names (total 2)

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

		Methods (total 7)
			(*CounterDataReader) BeginNextSegment() (bool, error)
				BeginNextSegment sets up the reader to read the next segment,
				returning TRUE if we do have another segment to read, or FALSE
				if we're done with all the segments (also an error if
				something went wrong).

			(*CounterDataReader) Goarch() string
				Goarch returns the GOARCH setting in effect for the "-cover" binary
				that produced this counter data file. The GOARCH value may be
				empty in the case where the counter data file was produced
				from a merge in which more than one GOARCH value was present.

			(*CounterDataReader) Goos() string
				Goos returns the GOOS setting in effect for the "-cover" binary
				that produced this counter data file. The GOOS value may be
				empty in the case where the counter data file was produced
				from a merge in which more than one GOOS value was present.

			(*CounterDataReader) NextFunc(p *FuncPayload) (bool, error)
				NextFunc reads data for the next function in this current segment
				into "p", returning TRUE if the read was successful or FALSE
				if we've read all the functions already (also an error if
				something went wrong with the read or we hit a premature
				EOF).

			(*CounterDataReader) NumFunctionsInSegment() uint32
				NumFunctionsInSegment returns the number of live functions
				in the currently selected segment.

			(*CounterDataReader) NumSegments() uint32
				NumSegments returns the number of execution segments in the file.

			(*CounterDataReader) OsArgs() []string
				OsArgs returns the program arguments (saved from os.Args during
				the run of the instrumented binary) read from the counter
				data file. Not all coverage data files will have os.Args values;
				for example, if a data file is produced by merging coverage
				data from two distinct runs, no os args will be available (an
				empty list is returned).

		As Outputs Of (at least one exported)
			func NewCounterDataReader(fn string, rs io.ReadSeeker) (*CounterDataReader, error)

	 type FuncPayload (struct)
		FuncPayload encapsulates the counter data payload for a single
		function as read from a counter data file.

		Fields (total 3)
			Counters []uint32
			FuncIdx uint32
			PkgIdx uint32
		As Inputs Of (at least one exported)
			func (*CounterDataReader).NextFunc(p *FuncPayload) (bool, error)


Package-Level Functions (only one)

	 func NewCounterDataReader(fn string, rs io.ReadSeeker) (*CounterDataReader, error)

The pages are generated with Golds v0.6.9-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 @Go100and1 (reachable from the left QR code) to get the latest news of Golds.