it

package

v0.0.6 Latest Latest Go to latest Published: Mar 18, 2024 License: MPL-2.0 Imports: 2 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

git.sr.ht/~nelsam/correct

Links

Open Source Insights

Documentation ¶

Index ¶

func InitOutputPrefs(opts ...OutputOpt)
func Must[T any](t TestingT, actual T, matchFn Match[T], opts ...OutputOpt)
type Match
type OutputOpt
type Result
type TestingT

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func InitOutputPrefs ¶

func InitOutputPrefs(opts ...OutputOpt)

InitOutputPrefs sets the default output prefs, typically during init(). Calls to this function outside of init() are unsupported and may panic or produce unexpected results.

func Must ¶

func Must[T any](t TestingT, actual T, matchFn Match[T], opts ...OutputOpt)

Must takes a TestingT and an actual, checks to see if it matches, and outputs the returned result.

Types ¶

type Match ¶

type Match[T any] func(T) Result

Match is a function which matches against an actual.

type OutputOpt ¶

type OutputOpt func(outputPrefs) outputPrefs

OutputOpt is an option function for changing how a Result is handled when outputing test results.

func Describe ¶

func Describe(desc string) OutputOpt

Describe returns an OutputOpt which adds extra context about the assertion in any output that may result.

func OutputOnPass ¶

func OutputOnPass() OutputOpt

OutputOnPass returns an OutputOpt which tells assertions to still output passing results.

func WithCtx ¶

func WithCtx(ctx context.Context) OutputOpt

WithCtx returns an OutputOpt that sets the context.Context passed to any result methods. This may be used to pass formatters, differs, color preferences, etc.

By default, assertions use context.Background().

type Result ¶

type Result interface {
	Matched() bool
	Describe(_ context.Context, passed bool) string
}

type TestingT ¶

type TestingT interface {
	Helper()
	Logf(string, ...any)
	Fatalf(string, ...any)
}

TestingT contains the methods from *testing.T that we Must uses.

Source Files ¶

View all Source files

must.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL