package cmerge

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

Dependency Relation
	imports 3 packages, and imported by 2 packages

Involved Source Files

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

	/* sort by: alphabet | popularity */
	 type Merger (struct)
		Merger provides state and methods to help manage the process of
		merging together coverage counter data for a given function, for
		tools that need to implicitly merge counter as they read multiple
		coverage counter data files.

		Methods (total 7)
			(*Merger) Granularity() coverage.CounterGranularity
			(*Merger) MergeCounters(dst, src []uint32) (error, bool)
				MergeCounters takes the counter values in 'src' and merges them
				into 'dst' according to the correct counter mode.

			(*Merger) Mode() coverage.CounterMode
			(*Merger) ResetModeAndGranularity()
			(*Merger) SaturatingAdd(dst, src uint32) uint32
				Saturating add does a saturating addition of 'dst' and 'src',
				returning added value or math.MaxUint32 if there is an overflow.
				Overflows are recorded in case the client needs to track them.

			(*Merger) SetModeAndGranularity(mdf string, cmode coverage.CounterMode, cgran coverage.CounterGranularity) error
				SetModeAndGranularity records the counter mode and granularity for
				the current merge. In the specific case of merging across coverage
				data files from different binaries, where we're combining data from
				more than one meta-data file, we need to check for and resolve
				mode/granularity clashes.

			(*Merger) SetModeMergePolicy(policy ModeMergePolicy)

	 type ModeMergePolicy uint8 (basic type)

		As Inputs Of (at least one exported)
			func (*Merger).SetModeMergePolicy(policy ModeMergePolicy)
		As Types Of (total 2)
			const ModeMergeRelaxed
			const ModeMergeStrict


Package-Level Functions (only one)

	 func SaturatingAdd(dst, src uint32) (uint32, bool)
		Saturating add does a saturating addition of 'dst' and 'src',
		returning added value or math.MaxUint32 plus an overflow flag.


Package-Level Constants (total 2)

	const ModeMergeRelaxed ModeMergePolicy = 1
	const ModeMergeStrict ModeMergePolicy = 0

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.