x

Documentation

Index

• Variables
• func Nil(v interface{}) bool
• func ValueOf(v interface{}) (reflect.Value, bool)
• type TypeExample
  • func MakeTypeExample(example interface{}) (TypeExample, error)
  • func (e *TypeExample) AssignableFrom(other reflect.Type) bool
  • func (e *TypeExample) Type() reflect.Type

Variables

var (
	// ErrIncorrectType indicates that the provided example is not of the
	// correct type family.
	ErrIncorrectType = errors.New("must be a pointer")
)

Functions

func Nil

func Nil(v interface{}) bool

Nil returns true if v is nil, respecting the various caveats of nullable types that don't "equal" nil when boxed by interface{}.

func ValueOf

func ValueOf(v interface{}) (reflect.Value, bool)

ValueOf returns the reflect.Value of v if it is not nil, respecting the various caveats of nullable types that don't "equal" nil when boxed by interface{}.

Types

type TypeExample

type TypeExample struct {
	// contains filtered or unexported fields
}

TypeExample is useful to check if other types can be assigned to a given type using an example like (*MyType)(nil).

func MakeTypeExample

func MakeTypeExample(example interface{}) (TypeExample, error)

MakeTypeExample returns a new TypeExample given the passed example value, or returns an error. The passed example must be a pointer type.

func (*TypeExample) AssignableFrom

func (e *TypeExample) AssignableFrom(other reflect.Type) bool

AssignableFrom returns true if the other type can be assigned to this type example.

func (*TypeExample) Type

func (e *TypeExample) Type() reflect.Type

Type returns the element type of the example (not the pointer type).