| commit | 1c57fff5373af756ecb7a9aa4860f55ad0782b36 | [log] [tgz] |
|---|---|---|
| author | Joe Tsai <joetsai@digital-static.net> | Fri Jul 07 12:35:59 2017 -0700 |
| committer | Joe Tsai <joetsai@digital-static.net> | Fri Jul 07 12:35:59 2017 -0700 |
| tree | 7a855697c51590a5700f27302580c84e64946001 |
Add package cmp for performing equality of Go values
The API of the package is as follows:
func Equal(x, y interface{}, opts ...Option) bool
func Diff(x, y interface{}, opts ...Option) string
type Option interface{ ... }
func Ignore() Option
func Comparer(f interface{}) Option
func Transformer(name string, f interface{}) Option
func FilterPath(f func(Path) bool, opt Option) Option
func FilterValues(f interface{}, opt Option) Option
func AllowUnexported(typs ...interface{}) Option
type Options []Option
type Path []PathStep
type PathStep interface{ ... }
type Indirect interface{ ... }
type StructField interface{ ... }
type MapIndex interface{ ... }
type SliceIndex interface{ ... }
type TypeAssertion interface{ ... }
type Transform interface{ ... }
See the package docs in compare.go for a high-level view of this package.
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 Equal method 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 Equal method is defined, equality is determined by recursively comparing the primitive kinds on both values, much like reflect.DeepEqual. Unlike reflect.DeepEqual, unexported fields are not compared; they result in panics unless suppressed by using an Ignore option.
This is not an official Google product.
go get -u github.com/google/go-cmp/cmp
BSD - See LICENSE file