Interface Option

cmp/options.go:25–33

Option configures for specific behavior of [Equal] and [Diff]. In particular, the fundamental Option functions ([Ignore], [Transformer], and [Comparer]), configure how equality is determined. The fundamental options may be composed with filters ([FilterPath] and [FilterValues]) to control the scope

// The [github.com/google/go-cmp/cmp/cmpopts] package provides helper functions
// for creating options that may be used with [Equal] and [Diff].
type Option interface {
	// filter applies all filters and returns the option that remains.
	// Each option may only read s.curPath and call s.callTTBFunc.
	//
	// An Options is returned only if multiple comparers or transformers
	// can apply simultaneously and will only contain values of those types
	// or sub-Options containing values of those types.
	filter(s *state, t reflect.Type, vx, vy reflect.Value) applicableOption
}

// applicableOption represents the following types:
//