README
¶
Package for equality of Go values
This package is intended to be a more powerful and safer alternative to
reflect.DeepEqual for comparing whether two values are semantically equal.
The primary features of cmp are:
-
When the default behavior of equality does not suit the needs of the test, custom equality functions can override the equality operation. For example, an equality function may report floats as equal so long as they are within some tolerance of each other.
-
Types that have an
Equalmethod may use that method to determine equality. This allows package authors to determine the equality operation for the types that they define. -
If no custom equality functions are used and no
Equalmethod is defined, equality is determined by recursively comparing the primitive kinds on both values, much likereflect.DeepEqual. Unlikereflect.DeepEqual, unexported fields are not compared by default; they result in panics unless suppressed by using anIgnoreoption (seecmpopts.IgnoreUnexported) or explictly compared using theAllowUnexportedoption.
See the GoDoc documentation for more information.
This is not an official Google product.
Install
go get -u github.com/google/go-cmp/cmp
License
BSD - See LICENSE file
Directories
¶
| Path | Synopsis |
|---|---|
|
Package cmp determines equality of values.
|
Package cmp determines equality of values. |
|
cmpopts
Package cmpopts provides common options for the cmp package.
|
Package cmpopts provides common options for the cmp package. |
|
internal/diff
Package diff implements an algorithm for producing edit-scripts.
|
Package diff implements an algorithm for producing edit-scripts. |
|
internal/function
Package function identifies function types.
|
Package function identifies function types. |
|
internal/value
Package value provides functionality for reflect.Value types.
|
Package value provides functionality for reflect.Value types. |