types

Documentation

Index

• Variables
• type Kind
• type Registry
  • func (registry Registry) Add(ty *Type) (string, error)
  • func (registry Registry) EqualTypeSlices(a, b []*Type) bool
  • func (registry Registry) EqualTypes(a, b *Type) bool
  • func (registry Registry) Get(key string) *Type
• type Type
  • func NewArray(element *Type) *Type
  • func NewFunc(args, returns []*Type) *Type
  • func NewInterface(name string, properties map[string]*Type) *Type
  • func NewMap(element *Type) *Type
  • func NewRef(ref string) *Type
  • func NewUnresolvedInterface(name string) *Type
  • func TypeFromString(s string) *Type
  • func (t *Type) Copy() *Type
  • func (t *Type) Interface() string
  • func (t *Type) SortedPropertyNames() []string
  • func (t *Type) String() string
  • func (t *Type) ToArray() *Type
  • func (t *Type) ToMap() *Type

Variables

var (
	Any    = TypeFromString("any")
	Bool   = TypeFromString("bool")
	Char   = TypeFromString("char")
	Data   = TypeFromString("data")
	Number = TypeFromString("number")
	String = TypeFromString("string")

	AnyArray    = NewArray(Any)
	BoolArray   = NewArray(Bool)
	NumberArray = NewArray(Number)
	StringArray = NewArray(String)

	AnyMap    = NewMap(Any)
	NumberMap = NewMap(Number)
	StringMap = NewMap(String)

	ErrorInterface = NewInterface("error.Error", map[string]*Type{
		"Error": String,
	})
)

Types

type Kind

type Kind int

const (
	// An unresolved interface (object type) is named, but the properties will
	// be nil because they are not known. This is a distinction from a resolved
	// interface which allowed to have zero or more properties.
	//
	// KindUnresolvedInterface = 0 on purpose it acts as a fallthrough/unknown
	// type.
	KindUnresolvedInterface Kind = iota
	KindResolvedInterface

	// Basic types.
	KindAny
	KindBool
	KindChar
	KindData
	KindNumber
	KindString

	// Other.
	KindArray
	KindMap
	KindFunc
)

type Registry

type Registry map[string]*Type

A Registry holds a collection of unique types that can are referenced internally to allow for circular references but also be serializable.

func (Registry) Add

func (registry Registry) Add(ty *Type) (string, error)

Add will merge new types into the register. An error is returned only if an unresolved interface type is added and there's no way to resolve it right now.

func (Registry) EqualTypeSlices

func (registry Registry) EqualTypeSlices(a, b []*Type) bool

func (Registry) EqualTypes

func (registry Registry) EqualTypes(a, b *Type) bool

EqualTypes ignores only the Name.

func (Registry) Get

func (registry Registry) Get(key string) *Type

type Type

type Type struct {
	// Kind will not be set when Ref is supplied.
	Kind Kind `json:",omitempty"`

	// Name is used as the descriptive name for the object.
	Name string `json:",omitempty"`

	// Element is used when Kind is an Array or Map.
	Element *Type `json:",omitempty"`

	// Argument and Returns are used when Kind is a Func. Either may be nil.
	Arguments, Returns []*Type `json:",omitempty"`

	// Properties is used for KindInterface
	Properties map[string]*Type `json:",omitempty"`

	// Ref is used when types are flattened for a Registry. It will point to an
	// index of another type in the registry.
	Ref string `json:",omitempty"`
}

Type represents a data type.

func NewArray

func NewArray(element *Type) *Type

func NewFunc

func NewFunc(args, returns []*Type) *Type

func NewInterface

func NewInterface(name string, properties map[string]*Type) *Type

func NewMap

func NewMap(element *Type) *Type

func NewRef

func NewRef(ref string) *Type

func NewUnresolvedInterface

func NewUnresolvedInterface(name string) *Type

func TypeFromString

func TypeFromString(s string) *Type

TypeFromString decodes a syntactically-valid type from a string.

func (*Type) Copy

func (t *Type) Copy() *Type

func (*Type) Interface

func (t *Type) Interface() string

func (*Type) SortedPropertyNames

func (t *Type) SortedPropertyNames() []string

func (*Type) String

func (t *Type) String() string

func (*Type) ToArray

func (t *Type) ToArray() *Type

ToArray creates an array type using this element type.

func (*Type) ToMap

func (t *Type) ToMap() *Type

ToMap creates a map type using this element type.