model

Documentation

Overview

Package model contains the data model necessary for generating mock implementations.

Index

• Variables
• type ArrayType
  • func (at *ArrayType) String(pm map[string]string, pkgOverride string) string
• type ChanDir
• type ChanType
  • func (ct *ChanType) String(pm map[string]string, pkgOverride string) string
• type FuncType
  • func (ft *FuncType) String(pm map[string]string, pkgOverride string) string
• type Interface
  • func InterfaceFromInterfaceType(it reflect.Type) (*Interface, error)
  • func (intf *Interface) AddMethod(m *Method)
  • func (intf *Interface) Print(w io.Writer)
  • func (intf *Interface) TypeParamIndexByName(name string) int
• type MapType
  • func (mt *MapType) String(pm map[string]string, pkgOverride string) string
• type Method
  • func (m *Method) Clone() *Method
  • func (m *Method) Print(w io.Writer)
• type NamedType
  • func (nt *NamedType) String(pm map[string]string, pkgOverride string) string
• type Package
  • func (pkg *Package) Imports() map[string]bool
  • func (pkg *Package) Print(w io.Writer)
• type Parameter
  • func (p *Parameter) Print(w io.Writer)
• type PointerType
  • func (pt *PointerType) String(pm map[string]string, pkgOverride string) string
• type PredeclaredType
  • func (pt PredeclaredType) String(map[string]string, string) string
• type Type
• type TypeParametersType
  • func (tp *TypeParametersType) String(pm map[string]string, pkgOverride string) string

Variables

var ErrorInterface = Interface{
	Name: "error",
	Methods: []*Method{
		{
			Name: "Error",
			Out: []*Parameter{
				{
					Name: "",
					Type: PredeclaredType("string"),
				},
			},
		},
	},
}

ErrorInterface represent built-in error interface.

Types

type ArrayType

type ArrayType struct {
	Len  int // -1 for slices, >= 0 for arrays
	Type Type
}

ArrayType is an array or slice type.

func (*ArrayType) String

func (at *ArrayType) String(pm map[string]string, pkgOverride string) string

type ChanDir

type ChanDir int

ChanDir is a channel direction.

const (
	RecvDir ChanDir = 1
	SendDir ChanDir = 2
)

Constants for channel directions.

type ChanType

type ChanType struct {
	Dir  ChanDir // 0, 1 or 2
	Type Type
}

ChanType is a channel type.

func (*ChanType) String

func (ct *ChanType) String(pm map[string]string, pkgOverride string) string

type FuncType

type FuncType struct {
	In, Out  []*Parameter
	Variadic *Parameter // may be nil
}

FuncType is a function type.

func (*FuncType) String

func (ft *FuncType) String(pm map[string]string, pkgOverride string) string

type Interface

type Interface struct {
	Name       string
	Methods    []*Method
	TypeParams []*Parameter
}

Interface is a Go interface.

func InterfaceFromInterfaceType

func InterfaceFromInterfaceType(it reflect.Type) (*Interface, error)

InterfaceFromInterfaceType returns a pointer to an interface for the given reflection interface type.

func (*Interface) AddMethod

func (intf *Interface) AddMethod(m *Method)

AddMethod adds a new method, de-duplicating by method name.

func (*Interface) Print

func (intf *Interface) Print(w io.Writer)

Print writes the interface name and its methods.

func (*Interface) TypeParamIndexByName

func (intf *Interface) TypeParamIndexByName(name string) int

TypeParamIndexByName returns the index of the type parameter matching on name. If none matching, returns -1.

This is especially useful for generics where interface is something like this:

Doer[T any, K any]{
    Start(T)
    Add(K) error
    Stop() []K
}

But it is used like this:

                  [     T        ,        K               ]
type MyDoer = Doer[types.SomeType, otherPkg.SomeOtherThing]

or as an embedded interface:

type MyDoer interface {
        [      T       ,       K                ]
    Doer[types.SomeType, otherPkg.SomeOtherThing]
}

If parsing the Add method for an implementation of this interface, we need to be able to swap out K for whatever the actual type is. K will be at index 1 of the interface's TypeParams, but it will also be at index 1 of the actual type params in either the definition of the interface being mocked or the generic interface it embeds.

type MapType

type MapType struct {
	Key, Value Type
}

MapType is a map type.

func (*MapType) String

func (mt *MapType) String(pm map[string]string, pkgOverride string) string

type Method

type Method struct {
	Name     string
	In, Out  []*Parameter
	Variadic *Parameter // may be nil
}

Method is a single method of an interface.

func (*Method) Clone

func (m *Method) Clone() *Method

Clone makes a deep clone of a Method.

This is useful specifically for generics so that generic parameters from source interface methods (e.g. Iface[T any, R any]) can be swapped out with actualized types from a referencing entity (e.g. type OtherIface = Iface[external.Foo, Baz]).

func (*Method) Print

func (m *Method) Print(w io.Writer)

Print writes the method name and its signature.

type NamedType

type NamedType struct {
	Package    string // may be empty
	Type       string
	TypeParams *TypeParametersType
}

NamedType is an exported type in a package.

func (*NamedType) String

func (nt *NamedType) String(pm map[string]string, pkgOverride string) string

type Package

type Package struct {
	Name       string
	PkgPath    string
	Interfaces []*Interface
	DotImports []string
}

Package is a Go package. It may be a subset.

func (*Package) Imports

func (pkg *Package) Imports() map[string]bool

Imports returns the imports needed by the Package as a set of import paths.

func (*Package) Print

func (pkg *Package) Print(w io.Writer)

Print writes the package name and its exported interfaces.

type Parameter

type Parameter struct {
	Name string // may be empty
	Type Type
}

Parameter is an argument or return parameter of a method.

func (*Parameter) Print

func (p *Parameter) Print(w io.Writer)

Print writes a method parameter.

type PointerType

type PointerType struct {
	Type Type
}

PointerType is a pointer to another type.

func (*PointerType) String

func (pt *PointerType) String(pm map[string]string, pkgOverride string) string

type PredeclaredType

type PredeclaredType string

PredeclaredType is a predeclared type such as "int".

func (PredeclaredType) String

func (pt PredeclaredType) String(map[string]string, string) string

type Type

type Type interface {
	String(pm map[string]string, pkgOverride string) string
	// contains filtered or unexported methods
}

Type is a Go type.

type TypeParametersType

type TypeParametersType struct {
	TypeParameters []Type
}

TypeParametersType contains type paramters for a NamedType.

func (*TypeParametersType) String

func (tp *TypeParametersType) String(pm map[string]string, pkgOverride string) string