Package: internal/coverage/decodemeta

package decodemeta Import Path internal/coverage/decodemeta (on go.dev) Dependency Relation imports 9 packages, and imported by one package

Involved Source Files decode.go decodefile.go

Package-Level Type Names (total 2)

/* sort by: alphabet | popularity */

type CoverageMetaDataDecoder (struct) Methods (total 5) (*CoverageMetaDataDecoder) ModulePath() string (*CoverageMetaDataDecoder) NumFuncs() uint32 (*CoverageMetaDataDecoder) PackageName() string (*CoverageMetaDataDecoder) PackagePath() string (*CoverageMetaDataDecoder) ReadFunc(fidx uint32, f *coverage.FuncDesc) error ReadFunc reads the coverage meta-data for the function with index 'findex', filling it into the FuncDesc pointed to by 'f'. As Outputs Of (at least 2) func NewCoverageMetaDataDecoder(b []byte, readonly bool) (*CoverageMetaDataDecoder, error) func (*CoverageMetaFileReader).GetPackageDecoder(pkIdx uint32, payloadbuf []byte) (*CoverageMetaDataDecoder, []byte, error)

type CoverageMetaFileReader (struct) CoverageMetaFileReader provides state and methods for reading a meta-data file from a code coverage run. Methods (total 6) (*CoverageMetaFileReader) CounterGranularity() coverage.CounterGranularity CounterGranularity returns the counter granularity (single counter per function, or counter per block) selected when building for coverage for the program that produce this meta-data file. (*CoverageMetaFileReader) CounterMode() coverage.CounterMode CounterMode returns the counter mode (set, count, atomic) used when building for coverage for the program that produce this meta-data file. (*CoverageMetaFileReader) FileHash() [16]byte FileHash returns the hash computed for all of the package meta-data blobs. Coverage counter data files refer to this hash, and the hash will be encoded into the meta-data file name. (*CoverageMetaFileReader) GetPackageDecoder(pkIdx uint32, payloadbuf []byte) (*CoverageMetaDataDecoder, []byte, error) GetPackageDecoder requests a decoder object for the package within the meta-data file whose index is 'pkIdx'. If the CoverageMetaFileReader was set up with a read-only file view, a pointer into that file view will be returned, otherwise the buffer 'payloadbuf' will be written to (or if it is not of sufficient size, a new buffer will be allocated). Return value is the decoder, a byte slice with the encoded meta-data, and an error. (*CoverageMetaFileReader) GetPackagePayload(pkIdx uint32, payloadbuf []byte) ([]byte, error) GetPackagePayload returns the raw (encoded) meta-data payload for the package with index 'pkIdx'. As with GetPackageDecoder, if the CoverageMetaFileReader was set up with a read-only file view, a pointer into that file view will be returned, otherwise the buffer 'payloadbuf' will be written to (or if it is not of sufficient size, a new buffer will be allocated). Return value is the decoder, a byte slice with the encoded meta-data, and an error. (*CoverageMetaFileReader) NumPackages() uint64 NumPackages returns the number of packages for which this file contains meta-data. As Outputs Of (at least one exported) func NewCoverageMetaFileReader(f *os.File, fileView []byte) (*CoverageMetaFileReader, error)

Package-Level Functions (total 2)

func NewCoverageMetaDataDecoder(b []byte, readonly bool) (*CoverageMetaDataDecoder, error)

func NewCoverageMetaFileReader(f *os.File, fileView []byte) (*CoverageMetaFileReader, error) NewCoverageMetaFileReader returns a new helper object for reading the coverage meta-data output file 'f'. The param 'fileView' is a read-only slice containing the contents of 'f' obtained by mmap'ing the file read-only; 'fileView' may be nil, in which case the helper will read the contents of the file using regular file Read operations.