package assert

Import Path
	gotest.tools/v3/internal/assert (on go.dev)

Dependency Relation
	imports 8 packages, and imported by one package

Involved Source Files

	   #d assert.go
		Package assert provides internal utilties for assertions.

	      result.go
Package-Level Type Names (total 6, in which 1 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type LogT (interface)
		LogT is the subset of testing.T used by the assert package.

		Methods (only one, which is exported)
			( LogT) Log(args ...interface{})
		Implemented By (at least 6, in which 5 are exported)
			 gotest.tools/v3/assert.TestingT (interface)
			*testing.B
			*testing.F
			*testing.T
			 testing.TB (interface)
			/* at least one unexported ... *//* at least one unexported: */
			*testing.common
		As Inputs Of (at least 4, in which 2 are exported)
			func Eval(t LogT, argSelector argSelector, comparison interface{}, msgAndArgs ...interface{}) bool
			func RunComparison(t LogT, argSelector argSelector, f cmp.Comparison, msgAndArgs ...interface{}) bool
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			func logFailureFromBool(t LogT, msgAndArgs ...interface{})
			func runCompareFunc(t LogT, f func() (success bool, message string), msgAndArgs ...interface{}) bool

	/* 5 unexporteds ... *//* 5 unexporteds: */
	 type argSelector (func)

		As Inputs Of (at least 2, both are exported)
			func Eval(t LogT, argSelector argSelector, comparison interface{}, msgAndArgs ...interface{}) bool
			func RunComparison(t LogT, argSelector argSelector, f cmp.Comparison, msgAndArgs ...interface{}) bool

	 type helperT (interface)

		Methods (only one, which is exported)
			( helperT) Helper()
		Implemented By (at least 10, in which 5 are exported)
			 github.com/golang/mock/gomock.TestHelper (interface)
			*testing.B
			*testing.F
			*testing.T
			 testing.TB (interface)
			/* 5+ unexporteds ... *//* 5+ unexporteds: */
			 gotest.tools/v3/assert.helperT (interface)
			*github.com/golang/mock/gomock.cancelReporter
			 github.com/golang/mock/gomock.nopTestHelper
			 go.uber.org/goleak.testHelper (interface)
			*testing.common
		Implements (at least 2, neither is exported)
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			 helperT : gotest.tools/v3/assert.helperT
			 helperT : go.uber.org/goleak.testHelper

	 type resultBasic (interface)

		Methods (only one, which is exported)
			( resultBasic) FailureMessage() string
		Implemented By (at least one exported)
			 gotest.tools/v3/assert/cmp.StringResult

	 type resultWithComparisonArgs (interface)

		Methods (only one, which is exported)
			( resultWithComparisonArgs) FailureMessage(args []ast.Expr) string
		Implemented By (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			 gotest.tools/v3/assert/cmp.templatedResult

	 type updateExpected (interface)

		Methods (only one, which is exported)
			( updateExpected) UpdatedExpected(stackIndex int) error
		Implemented By (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			 gotest.tools/v3/assert/cmp.templatedResult


Package-Level Functions (total 11, in which 5 are exported)

	 func ArgsAfterT(args []ast.Expr) []ast.Expr
		ArgsAfterT selects args starting at position 1. Used when the caller has a
		testing.T as the first argument, and the args to select should follow it.

	 func ArgsAtZeroIndex(args []ast.Expr) []ast.Expr
		ArgsAtZeroIndex selects args from the CallExpression at position 1.
		Used when the caller accepts a single cmp.Comparison argument.

	 func ArgsFromComparisonCall(args []ast.Expr) []ast.Expr
		ArgsFromComparisonCall selects args from the CallExpression at position 1.
		Used when the caller has a testing.T as the first argument, and the args to
		select are passed to the cmp.Comparison at position 1.

	 func Eval(t LogT, argSelector argSelector, comparison interface{}, msgAndArgs ...interface{}) bool
		Eval the comparison and print a failure messages if the comparison has failed.

	 func RunComparison(t LogT, argSelector argSelector, f cmp.Comparison, msgAndArgs ...interface{}) bool
		RunComparison and return Comparison.Success. If the comparison fails a messages
		will be printed using t.Log.

	/* 6 unexporteds ... *//* 6 unexporteds: */
	 func boolFailureMessage(expr ast.Expr) (string, error)
	 func failureMsgFromError(err error) string
	 func filterPrintableExpr(args []ast.Expr) []ast.Expr
		filterPrintableExpr filters the ast.Expr slice to only include Expr that are
		easy to read when printed and contain relevant information to an assertion.

		Ident and SelectorExpr are included because they print nicely and the variable
		names may provide additional context to their values.
		BasicLit and CompositeLit are excluded because their source is equivalent to
		their value, which is already available.
		Other types are ignored for now, but could be added if they are relevant.

	 func isShortPrintableExpr(expr ast.Expr) bool
	 func logFailureFromBool(t LogT, msgAndArgs ...interface{})
	 func runCompareFunc(t LogT, f func() (success bool, message string), msgAndArgs ...interface{}) bool
Package-Level Constants (only one, which is unexported)

	/* one unexported ... *//* one unexported: */
	const failureMessage = "assertion failed: "

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