model

Documentation

Index

• type Enum
• type EnumLiteral
• type Field
  • func (f Field) DereferencedTypeName() string
  • func (f Field) EmptyInstance() string
  • func (f Field) GetTagMap() map[string]string
  • func (f Field) IsBool() bool
  • func (f Field) IsBoolSlice() bool
  • func (f Field) IsCustom() bool
  • func (f Field) IsDate() bool
  • func (f Field) IsDateSlice() bool
  • func (f Field) IsInt() bool
  • func (f Field) IsIntSlice() bool
  • func (f Field) IsMap() bool
  • func (f Field) IsPointer() bool
  • func (f Field) IsPrimitive() bool
  • func (f Field) IsPrimitiveSlice() bool
  • func (f Field) IsSlice() bool
  • func (f Field) IsString() bool
  • func (f Field) IsStringSlice() bool
  • func (f Field) SliceElementTypeName() string
  • func (f Field) SplitMapTypeNames() (string, string)
  • func (f Field) SplitTypeName() (string, string)
• type Interface
• type Operation
• type ParsedSources
  • func Parse(filename string) (ParsedSources, error)
• type Struct
• type Typedef

Types

type Enum

type Enum struct {
	PackageName  string        `json:"packageName"`
	Filename     string        `json:"filename"`
	DocLines     []string      `json:"docLines,omitempty"`
	Name         string        `json:"name,omitempty"`
	EnumLiterals []EnumLiteral `json:"enumLiterals,omitempty"`
	CommentLines []string      `json:"commentLines,omitempty"`
}

@JsonStruct()

type EnumLiteral

type EnumLiteral struct {
	Name  string `json:"name"`
	Value string `json:"value,omitempty"`
}

@JsonStruct()

type Field

type Field struct {
	PackageName  string   `json:"packageName,omitempty"`
	DocLines     []string `json:"docLines,omitempty"`
	Name         string   `json:"name,omitempty"`
	TypeName     string   `json:"typeName,omitempty"`
	Tag          string   `json:"tag,omitempty"`
	CommentLines []string `json:"commentLines,omitempty"`
}

@JsonStruct()

func (Field) DereferencedTypeName

func (f Field) DereferencedTypeName() string

func (Field) EmptyInstance

func (f Field) EmptyInstance() string

func (Field) GetTagMap

func (f Field) GetTagMap() map[string]string

func (Field) IsBool

func (f Field) IsBool() bool

func (Field) IsBoolSlice

func (f Field) IsBoolSlice() bool

func (Field) IsCustom

func (f Field) IsCustom() bool

func (Field) IsDate

func (f Field) IsDate() bool

func (Field) IsDateSlice

func (f Field) IsDateSlice() bool

func (Field) IsInt

func (f Field) IsInt() bool

func (Field) IsIntSlice

func (f Field) IsIntSlice() bool

func (Field) IsMap

func (f Field) IsMap() bool

func (Field) IsPointer

func (f Field) IsPointer() bool

func (Field) IsPrimitive

func (f Field) IsPrimitive() bool

func (Field) IsPrimitiveSlice

func (f Field) IsPrimitiveSlice() bool

func (Field) IsSlice

func (f Field) IsSlice() bool

func (Field) IsString

func (f Field) IsString() bool

func (Field) IsStringSlice

func (f Field) IsStringSlice() bool

func (Field) SliceElementTypeName

func (f Field) SliceElementTypeName() string

func (Field) SplitMapTypeNames

func (f Field) SplitMapTypeNames() (string, string)

func (Field) SplitTypeName

func (f Field) SplitTypeName() (string, string)

type Interface

type Interface struct {
	PackageName  string      `json:"packageName"`
	Filename     string      `json:"filename"`
	DocLines     []string    `json:"docLines,omitempty"`
	Name         string      `json:"name"`
	Methods      []Operation `json:"methods,omitempty"`
	CommentLines []string    `json:"commentLines,omitempty"`
}

@JsonStruct()

type Operation

type Operation struct {
	PackageName   string   `json:"packageName,omitempty"`
	Filename      string   `json:"filename,omitempty"`
	DocLines      []string `json:"docLines,omitempty"`
	RelatedStruct *Field   `json:"relatedStruct,omitempty"` // optional
	Name          string   `json:"name"`
	InputArgs     []Field  `json:"inputArgs,omitempty"`
	OutputArgs    []Field  `json:"outputArgs,omitempty"`
	CommentLines  []string `json:"commentLines,omitempty"`
}

@JsonStruct()

type ParsedSources

type ParsedSources struct {
	Structs    []Struct    `json:"structs,omitempty"`
	Operations []Operation `json:"operations,omitempty"`
	Interfaces []Interface `json:"interfaces,omitempty"`
	Typedefs   []Typedef   `json:"typedefs,omitempty"`
	Enums      []Enum      `json:"enums,omitempty"`
}

@JsonStruct()

func Parse

func Parse(filename string) (ParsedSources, error)

type Struct

type Struct struct {
	PackageName  string       `json:"packageName"`
	Filename     string       `json:"filename"`
	DocLines     []string     `json:"docLines,omitempty"`
	Name         string       `json:"name"`
	Fields       []Field      `json:"fields,omitempty"`
	Operations   []*Operation `json:"operations,omitempty"`
	CommentLines []string     `json:"commentLines,omitempty"`
}

@JsonStruct()

type Typedef

type Typedef struct {
	PackageName string   `json:"packageName"`
	Filename    string   `json:"filename"`
	DocLines    []string `json:"docLines,omitempty"`
	Name        string   `json:"name"`
	Type        string   `json:"type,omitempty"`
}

@JsonStruct()