types

Documentation

Overview

Package types mimics the https://golang.org/pkg/go/types/ package. It also contains some extra utility functions, they're defined in ext.go file.

Index

• func Identical(x, y Type) bool
• func Implements(typ Type, iface *Interface) bool
• type Array
  • func AsArray(x Type) *Array
  • func NewArray(elem Type, len int) *Array
  • func (*Array) Elem() Type
  • func (*Array) Len() int
  • func (*Array) String() string
  • func (*Array) Underlying() Type
• type Interface
  • func AsInterface(x Type) *Interface
  • func (*Interface) String() string
  • func (*Interface) Underlying() Type
• type Pointer
  • func AsPointer(x Type) *Pointer
  • func NewPointer(elem Type) *Pointer
  • func (*Pointer) Elem() Type
  • func (*Pointer) String() string
  • func (*Pointer) Underlying() Type
• type Slice
  • func AsSlice(x Type) *Slice
  • func NewSlice(elem Type) *Slice
  • func (*Slice) Elem() Type
  • func (*Slice) String() string
  • func (*Slice) Underlying() Type
• type Struct
  • func AsStruct(x Type) *Struct
  • func (*Struct) Field(i int) *Var
  • func (*Struct) NumFields() int
  • func (*Struct) String() string
  • func (*Struct) Underlying() Type
• type Type
• type Var
  • func (*Var) Embedded() bool
  • func (*Var) Type() Type

Functions

func Identical

func Identical(x, y Type) bool

Identical reports whether x and y are identical types. Receivers of Signature types are ignored.

func Implements

func Implements(typ Type, iface *Interface) bool

Implements reports whether a given type implements the specified interface.

Types

type Array

type Array struct{}

An Array represents an array type.

func AsArray

func AsArray(x Type) *Array

AsArray is a type-assert like operation, x.(*Array), but never panics. Returns nil if type is not an array.

func NewArray

func NewArray(elem Type, len int) *Array

NewArray returns a new array type for the given element type and length. A negative length indicates an unknown length.

func (*Array) Elem

func (*Array) Elem() Type

Elem returns element type of array.

func (*Array) Len

func (*Array) Len() int

Len returns the length of array. A negative result indicates an unknown length.

func (*Array) String

func (*Array) String() string

func (*Array) Underlying

func (*Array) Underlying() Type

type Interface

type Interface struct{}

An Interface represents an interface type.

func AsInterface

func AsInterface(x Type) *Interface

AsInterface is a type-assert like operation, x.(*Interface), but never panics. Returns nil if type is not an interface.

func (*Interface) String

func (*Interface) String() string

func (*Interface) Underlying

func (*Interface) Underlying() Type

type Pointer

type Pointer struct{}

A Pointer represents a pointer type.

func AsPointer

func AsPointer(x Type) *Pointer

AsPointer is a type-assert like operation, x.(*Pointer), but never panics. Returns nil if type is not a pointer.

func NewPointer

func NewPointer(elem Type) *Pointer

NewPointer returns a new pointer type for the given element (base) type.

func (*Pointer) Elem

func (*Pointer) Elem() Type

Elem returns the element type for the given pointer.

func (*Pointer) String

func (*Pointer) String() string

func (*Pointer) Underlying

func (*Pointer) Underlying() Type

type Slice

type Slice struct{}

A Slice represents a slice type.

func AsSlice

func AsSlice(x Type) *Slice

AsSlice is a type-assert like operation, x.(*Slice), but never panics. Returns nil if type is not an array.

func NewSlice

func NewSlice(elem Type) *Slice

NewSlice returns a new slice type for the given element type.

func (*Slice) Elem

func (*Slice) Elem() Type

Elem returns element type of slice.

func (*Slice) String

func (*Slice) String() string

func (*Slice) Underlying

func (*Slice) Underlying() Type

type Struct

type Struct struct{}

A struct represents a struct type.

func AsStruct

func AsStruct(x Type) *Struct

AsStruct is a type-assert like operation, x.(*Struct), but never panics. Returns nil if type is not a struct.

func (*Struct) Field

func (*Struct) Field(i int) *Var

func (*Struct) NumFields

func (*Struct) NumFields() int

func (*Struct) String

func (*Struct) String() string

func (*Struct) Underlying

func (*Struct) Underlying() Type

type Type

type Type interface {
	// Underlying returns the underlying type of a type.
	Underlying() Type

	// String returns a string representation of a type.
	String() string
}

A Type represents a type of Go. All types implement the Type interface.

type Var

type Var struct{}

func (*Var) Embedded

func (*Var) Embedded() bool

func (*Var) Type

func (*Var) Type() Type