# Functions

Contains succeeds if item is in collection.
DeepEqual compares two values using [github.com/google/go-cmp/cmp] and succeeds if the values are equal.
Equal succeeds if x == y.
Error succeeds if err is a non-nil error, and the error message equals the expected message.
ErrorContains succeeds if err is a non-nil error, and the error message contains the expected substring.
ErrorIs succeeds if errors.Is(actual, expected) returns true.
ErrorType succeeds if err is not nil and is of the expected type.
Len succeeds if the sequence has the expected length.
Nil succeeds if obj is a nil interface, pointer, or function.
Panics succeeds if f() panics.
Regexp succeeds if value v matches regular expression re.
ResultFailure returns a failed [Result] with a failure message.
ResultFailureTemplate returns a [Result] with a template string and data which can be used to format a failure message.
ResultFromError returns [ResultSuccess] if err is nil.

# Variables

ResultSuccess is a constant which is returned by a [Comparison] to indicate success.

# Structs

StringResult is an implementation of [Result] that reports the error message string verbatim and does not provide any templating or formatting of the message.

# Interfaces

RegexOrPattern may be either a [*regexp.Regexp] or a string that is a valid regexp pattern.
A Result of a [Comparison].

# Type aliases

Comparison is a function which compares values and returns [ResultSuccess] if the actual value matches the expected value.