package diag

Import Path
	go.pact.im/x/plumb/internal/diag (on go.dev)

Dependency Relation
	imports 4 packages, and imported by 3 packages

Involved Source Files

	  d diag.go
		Package diag holds plumb's diagnostic vocabulary: the located, user-facing
		error type, the sentinel errors every phase wraps, and the position helpers
		that order diagnostics deterministically. It is the leaf every other package
		reaches for when it must reject input or compare source positions.
Package-Level Type Names (total 2, both are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Error (struct)
		Error is a located, user-facing diagnostic. It wraps one of the sentinel
		errors above (reachable with errors.Is and errors.Unwrap) and carries the
		source position where the problem occurred. Violations of plumb's own
		internal invariants are panics instead, never *Error.

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			err error
				// sentinel wrapped with the specific detail

			pos token.Position
				// the offending source position; zero if none applies

		Methods (total 2, both are exported)
			(*Error) Error() string
			(*Error) Unwrap() error
				Unwrap exposes the wrapped chain so errors.Is/As reach the sentinel.

		Implements (at least one exported)
			*Error : error
		As Outputs Of (at least 26, in which 5 are exported)
			func Earlier(a, b *Error) *Error
			func Errorf(pos token.Position, kind ErrorKind, detail string, args ...any) *Error
			func Sentinel(msg string) *Error
			func go.pact.im/x/plumb/internal/discover.Analyze(pkgs []*discover.Package, destPath, outputBase string) ([]*discover.Provider, *Error)
			func go.pact.im/x/plumb/internal/solve.Set(name string, provs []*discover.Provider, destPath, outputBase string, dest *solve.DestInfo, ctxt *types.Context) (*solve.Plan, *Error)
			/* 21+ unexporteds ... *//* 21+ unexporteds: */
			func go.pact.im/x/plumb/internal/discover.appendDirectiveNames(prior []string, doc *ast.CommentGroup, fset *token.FileSet) ([]string, *Error)
			func go.pact.im/x/plumb/internal/discover.directiveNames(doc *ast.CommentGroup, fset *token.FileSet) ([]string, *Error)
			func go.pact.im/x/plumb/internal/discover.reportStrayDirectives(pkg *discover.Package, file *ast.File) *Error
			func go.pact.im/x/plumb/internal/discover.scanConst(pkg *discover.Package, s *ast.ValueSpec, names []string) ([]*discover.Provider, *Error)
			func go.pact.im/x/plumb/internal/discover.scanConversion(pkg *discover.Package, s *ast.ValueSpec, ident *ast.Ident, names []string) ([]*discover.Provider, *Error)
			func go.pact.im/x/plumb/internal/discover.scanFile(pkg *discover.Package, file *ast.File) ([]*discover.Provider, *Error)
			func go.pact.im/x/plumb/internal/discover.scanFunc(pkg *discover.Package, fd *ast.FuncDecl) ([]*discover.Provider, *Error)
			func go.pact.im/x/plumb/internal/discover.scanGenDecl(pkg *discover.Package, gd *ast.GenDecl) ([]*discover.Provider, *Error)
			func go.pact.im/x/plumb/internal/discover.scanInterfaceMethods(pkg *discover.Package, it *ast.InterfaceType, owner types.Type) ([]*discover.Provider, *Error)
			func go.pact.im/x/plumb/internal/discover.scanStructFields(pkg *discover.Package, st *ast.StructType, owner types.Type) ([]*discover.Provider, *Error)
			func go.pact.im/x/plumb/internal/discover.scanTypeSpec(pkg *discover.Package, gd *ast.GenDecl, s *ast.TypeSpec) ([]*discover.Provider, *Error)
			func go.pact.im/x/plumb/internal/discover.scanValueSpec(pkg *discover.Package, gd *ast.GenDecl, s *ast.ValueSpec) ([]*discover.Provider, *Error)
			func go.pact.im/x/plumb/internal/discover.scanVar(pkg *discover.Package, s *ast.ValueSpec, names []string) ([]*discover.Provider, *Error)
			func go.pact.im/x/plumb/internal/discover.specDirectiveNames(gd *ast.GenDecl, specDoc *ast.CommentGroup, fset *token.FileSet) ([]string, *Error)
			func go.pact.im/x/plumb/internal/discover.structProviders(pkg *discover.Package, s *ast.TypeSpec, tn *types.TypeName, names []string) ([]*discover.Provider, *Error)
			func go.pact.im/x/plumb/internal/gen.buildDestInfo(opts gen.Options, pkgs []*discover.Package) (*solve.DestInfo, *Error)
			func go.pact.im/x/plumb/internal/solve.ambiguousProducers(a, b *solve.Instance, t types.Type) *Error
			func go.pact.im/x/plumb/internal/solve.ambiguousTemplates(cs []solve.matchCand) *Error
			func go.pact.im/x/plumb/internal/solve.ambiguousTemplatesFor(ps []*discover.Provider, d types.Type) *Error
			func go.pact.im/x/plumb/internal/solve.classifyResults(p *discover.Provider, in *solve.Instance, sig *types.Signature) *Error
			func go.pact.im/x/plumb/internal/solve.instantiate(p *discover.Provider, ctxt *types.Context, targs []types.Type) (in *solve.Instance, err *Error, miss error)
		As Inputs Of (at least one exported)
			func Earlier(a, b *Error) *Error
		As Types Of (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			  var go.pact.im/x/plumb/internal/solve.errRestart *Error

	 type ErrorKind string (basic type)
		ErrorKind is a sentinel diagnostic kind: a constant string that implements
		error. Making it a named string type lets the sentinels below be true compile-
		time constants while still being wrappable and matchable with errors.Is (a
		string is comparable, so errors.Is compares them by value).

		Methods (only one, which is exported)
			( ErrorKind) Error() string
				Error returns the sentinel's message.

		Implements (at least one exported)
			 ErrorKind : error
		As Inputs Of (at least one exported)
			func Errorf(pos token.Position, kind ErrorKind, detail string, args ...any) *Error
		As Types Of (total 26, all are exported)
			const ErrAmbiguousProducer
			const ErrAmbiguousTemplates
			const ErrBareTypeParamResult
			const ErrBlankProvider
			const ErrConstraintInterfaceMethod
			const ErrDependencyCycle
			const ErrDestShadowsPredeclared
			const ErrDuplicateDirective
			const ErrEmbeddedField
			const ErrEmbeddedInterface
			const ErrInitProvider
			const ErrInvalidConversion
			const ErrInvalidSetName
			const ErrInvalidType
			const ErrMisplacedDirective
			const ErrMultipleErrors
			const ErrNoDirectives
			const ErrNonTerminating
			const ErrReservedName
			const ErrSetNameCollision
			const ErrShadowsPredeclared
			const ErrStructProvider
			const ErrUnexportedProvider
			const ErrUnreachableType
			const ErrUntypedConstant
			const ErrUnusedTemplate


Package-Level Functions (total 5, all are exported)

	 func CmpPos(a, b token.Position) int
		CmpPos orders positions deterministically: by file name, then byte offset.
		This is the single ordering authority for source-anchored decisions. Read
		order (of packages, files, or map entries) never participates. It is the
		int-returning comparator backing slices.SortFunc/SortStableFunc/MinFunc.

	 func Earlier(a, b *Error) *Error
		Earlier returns the source-earlier of two diagnostics by CmpPos, treating a nil
		*Error as "no fault" (later than any real one); it returns nil only when both
		are nil. Use it to report the fault a reader would fix first when a phase finds
		faults out of source order.

	 func Errorf(pos token.Position, kind ErrorKind, detail string, args ...any) *Error
		Errorf builds a located *Error wrapping the given sentinel kind. detail is a
		Printf-style format describing the specifics; it should not repeat the
		sentinel's own words.

	 func PosIn(fset *token.FileSet, p token.Pos) token.Position
		PosIn resolves p to a token.Position within fset, returning the zero Position
		when fset is nil or p is invalid.

	 func Sentinel(msg string) *Error
		Sentinel returns a positionless *Error wrapping msg. It exists for internal
		control-flow signals that ride the *Error return channel but are compared by
		identity, never by content: unlike a zero-value *Error (whose nil wrapped err
		makes Error() panic), a Sentinel is safe to format if one is ever accidentally
		printed or logged.


Package-Level Constants (total 26, all are exported)

	const ErrAmbiguousProducer ErrorKind = "ambiguous producer"
		Sentinel errors for every condition plumb can reject. Each diagnostic wraps
		one of these, so callers and tests can classify a failure with errors.Is
		rather than matching message text. The human-readable specifics travel in the
		wrapped detail; the source position travels on *Error.

	const ErrAmbiguousTemplates ErrorKind = "ambiguous templates"
		Sentinel errors for every condition plumb can reject. Each diagnostic wraps
		one of these, so callers and tests can classify a failure with errors.Is
		rather than matching message text. The human-readable specifics travel in the
		wrapped detail; the source position travels on *Error.

	const ErrBareTypeParamResult ErrorKind = "bare type-parameter result"
		Sentinel errors for every condition plumb can reject. Each diagnostic wraps
		one of these, so callers and tests can classify a failure with errors.Is
		rather than matching message text. The human-readable specifics travel in the
		wrapped detail; the source position travels on *Error.

	const ErrBlankProvider ErrorKind = "blank provider name"
		Sentinel errors for every condition plumb can reject. Each diagnostic wraps
		one of these, so callers and tests can classify a failure with errors.Is
		rather than matching message text. The human-readable specifics travel in the
		wrapped detail; the source position travels on *Error.

	const ErrConstraintInterfaceMethod ErrorKind = "method provider on constraint interface"
		Sentinel errors for every condition plumb can reject. Each diagnostic wraps
		one of these, so callers and tests can classify a failure with errors.Is
		rather than matching message text. The human-readable specifics travel in the
		wrapped detail; the source position travels on *Error.

	const ErrDependencyCycle ErrorKind = "dependency cycle"
		Sentinel errors for every condition plumb can reject. Each diagnostic wraps
		one of these, so callers and tests can classify a failure with errors.Is
		rather than matching message text. The human-readable specifics travel in the
		wrapped detail; the source position travels on *Error.

	const ErrDestShadowsPredeclared ErrorKind = "destination declaration shadows a predeclared identifier"
		Sentinel errors for every condition plumb can reject. Each diagnostic wraps
		one of these, so callers and tests can classify a failure with errors.Is
		rather than matching message text. The human-readable specifics travel in the
		wrapped detail; the source position travels on *Error.

	const ErrDuplicateDirective ErrorKind = "duplicate provider directive"
		Sentinel errors for every condition plumb can reject. Each diagnostic wraps
		one of these, so callers and tests can classify a failure with errors.Is
		rather than matching message text. The human-readable specifics travel in the
		wrapped detail; the source position travels on *Error.

	const ErrEmbeddedField ErrorKind = "provider directive on embedded field"
		Sentinel errors for every condition plumb can reject. Each diagnostic wraps
		one of these, so callers and tests can classify a failure with errors.Is
		rather than matching message text. The human-readable specifics travel in the
		wrapped detail; the source position travels on *Error.

	const ErrEmbeddedInterface ErrorKind = "provider directive on embedded interface"
		Sentinel errors for every condition plumb can reject. Each diagnostic wraps
		one of these, so callers and tests can classify a failure with errors.Is
		rather than matching message text. The human-readable specifics travel in the
		wrapped detail; the source position travels on *Error.

	const ErrInitProvider ErrorKind = "provider directive on func init"
		Sentinel errors for every condition plumb can reject. Each diagnostic wraps
		one of these, so callers and tests can classify a failure with errors.Is
		rather than matching message text. The human-readable specifics travel in the
		wrapped detail; the source position travels on *Error.

	const ErrInvalidConversion ErrorKind = "invalid conversion"
		Sentinel errors for every condition plumb can reject. Each diagnostic wraps
		one of these, so callers and tests can classify a failure with errors.Is
		rather than matching message text. The human-readable specifics travel in the
		wrapped detail; the source position travels on *Error.

	const ErrInvalidSetName ErrorKind = "invalid set name"
		Sentinel errors for every condition plumb can reject. Each diagnostic wraps
		one of these, so callers and tests can classify a failure with errors.Is
		rather than matching message text. The human-readable specifics travel in the
		wrapped detail; the source position travels on *Error.

	const ErrInvalidType ErrorKind = "type does not type-check"
		Sentinel errors for every condition plumb can reject. Each diagnostic wraps
		one of these, so callers and tests can classify a failure with errors.Is
		rather than matching message text. The human-readable specifics travel in the
		wrapped detail; the source position travels on *Error.

	const ErrMisplacedDirective ErrorKind = "directive in an unsupported position"
		Sentinel errors for every condition plumb can reject. Each diagnostic wraps
		one of these, so callers and tests can classify a failure with errors.Is
		rather than matching message text. The human-readable specifics travel in the
		wrapped detail; the source position travels on *Error.

	const ErrMultipleErrors ErrorKind = "multiple error results"
		Sentinel errors for every condition plumb can reject. Each diagnostic wraps
		one of these, so callers and tests can classify a failure with errors.Is
		rather than matching message text. The human-readable specifics travel in the
		wrapped detail; the source position travels on *Error.

	const ErrNoDirectives ErrorKind = "no //plumb: directives found"
		Sentinel errors for every condition plumb can reject. Each diagnostic wraps
		one of these, so callers and tests can classify a failure with errors.Is
		rather than matching message text. The human-readable specifics travel in the
		wrapped detail; the source position travels on *Error.

	const ErrNonTerminating ErrorKind = "non-terminating generic instantiation"
		Sentinel errors for every condition plumb can reject. Each diagnostic wraps
		one of these, so callers and tests can classify a failure with errors.Is
		rather than matching message text. The human-readable specifics travel in the
		wrapped detail; the source position travels on *Error.

	const ErrReservedName ErrorKind = "reserved function name with a non-empty signature"
		Sentinel errors for every condition plumb can reject. Each diagnostic wraps
		one of these, so callers and tests can classify a failure with errors.Is
		rather than matching message text. The human-readable specifics travel in the
		wrapped detail; the source position travels on *Error.

	const ErrSetNameCollision ErrorKind = "set name collides with an existing declaration"
		Sentinel errors for every condition plumb can reject. Each diagnostic wraps
		one of these, so callers and tests can classify a failure with errors.Is
		rather than matching message text. The human-readable specifics travel in the
		wrapped detail; the source position travels on *Error.

	const ErrShadowsPredeclared ErrorKind = "set name shadows a predeclared identifier"
		Sentinel errors for every condition plumb can reject. Each diagnostic wraps
		one of these, so callers and tests can classify a failure with errors.Is
		rather than matching message text. The human-readable specifics travel in the
		wrapped detail; the source position travels on *Error.

	const ErrStructProvider ErrorKind = "invalid struct-type provider"
		Sentinel errors for every condition plumb can reject. Each diagnostic wraps
		one of these, so callers and tests can classify a failure with errors.Is
		rather than matching message text. The human-readable specifics travel in the
		wrapped detail; the source position travels on *Error.

	const ErrUnexportedProvider ErrorKind = "unexported provider referenced across a package boundary"
		Sentinel errors for every condition plumb can reject. Each diagnostic wraps
		one of these, so callers and tests can classify a failure with errors.Is
		rather than matching message text. The human-readable specifics travel in the
		wrapped detail; the source position travels on *Error.

	const ErrUnreachableType ErrorKind = "type not reachable from the destination package"
		Sentinel errors for every condition plumb can reject. Each diagnostic wraps
		one of these, so callers and tests can classify a failure with errors.Is
		rather than matching message text. The human-readable specifics travel in the
		wrapped detail; the source position travels on *Error.

	const ErrUntypedConstant ErrorKind = "untyped constant provider"
		Sentinel errors for every condition plumb can reject. Each diagnostic wraps
		one of these, so callers and tests can classify a failure with errors.Is
		rather than matching message text. The human-readable specifics travel in the
		wrapped detail; the source position travels on *Error.

	const ErrUnusedTemplate ErrorKind = "unused result-generic template"
		Sentinel errors for every condition plumb can reject. Each diagnostic wraps
		one of these, so callers and tests can classify a failure with errors.Is
		rather than matching message text. The human-readable specifics travel in the
		wrapped detail; the source position travels on *Error.

The pages are generated with Golds v0.8.4. (GOOS=linux GOARCH=amd64)