model

Documentation

Index

• type StructFieldModel
  • func (sfm *StructFieldModel) GetTags() map[string]string
• type StructMethodArg
• type StructMethodModel
  • func (sm *StructMethodModel) GetCommentsWithPrefix(prefix string) []string
  • func (sm *StructMethodModel) HasComment(comment string) bool
  • func (sm *StructMethodModel) HasCommentWithPrefix(prefix string) bool
• type StructModel
  • func (sm *StructModel) GetCommentsWithPrefix(prefix string) []string
  • func (sm *StructModel) HasComment(comment string) bool
  • func (sm *StructModel) HasCommentWithPrefix(prefix string) bool

Types

type StructFieldModel

type StructFieldModel struct {
	Name      string // field name
	Type      string // field type
	StructTag string // field struct tag without “
}

description of field of structure

func (*StructFieldModel) GetTags

func (sfm *StructFieldModel) GetTags() map[string]string

get field's struct tags as KV map

type StructMethodArg

type StructMethodArg struct {
	Index int
	Name  string
	Type  string
}

method acceping/return argument

type StructMethodModel

type StructMethodModel struct {
	Name       string // method name
	Returnings []StructMethodArg
	Arguments  []StructMethodArg
	Comments   []string
}

description of structure method

func (*StructMethodModel) GetCommentsWithPrefix

func (sm *StructMethodModel) GetCommentsWithPrefix(prefix string) []string

get all structure comments with given prefix, including it

func (*StructMethodModel) HasComment

func (sm *StructMethodModel) HasComment(comment string) bool

whether structure contains given comment

func (*StructMethodModel) HasCommentWithPrefix

func (sm *StructMethodModel) HasCommentWithPrefix(prefix string) bool

whether structure has comment with prefix

type StructModel

type StructModel struct {
	Name     string              // typename of structure
	Comments []string            // list of comments above structure, without // and trimmed
	Fields   []StructFieldModel  // list of fields
	Methods  []StructMethodModel // list of methods
}

description of struct

func (*StructModel) GetCommentsWithPrefix

func (sm *StructModel) GetCommentsWithPrefix(prefix string) []string

get all structure comments with given prefix, including it

func (*StructModel) HasComment

func (sm *StructModel) HasComment(comment string) bool

whether structure contains given comment

func (*StructModel) HasCommentWithPrefix

func (sm *StructModel) HasCommentWithPrefix(prefix string) bool

whether structure has comment with prefix