source

Documentation

Overview

Package source contains functions for parsing Go source files.

This package is used for extract information about structures and their fields from Go source files.

Index

• type FieldInfo
  • func (fi FieldInfo) String() string
• type Structure
  • func Lookup(sl StructureList, structName string) (Structure, error)
  • func (s Structure) String() string
• type StructureList
  • func Parse(path string, src io.Reader) (StructureList, error)

Types

type FieldInfo

type FieldInfo struct {
	// Field type name.
	Type string
	// Equals true if field is a pointer.
	IsPointer bool
}

FieldInfo contains information about one structure field without field name.

func (FieldInfo) String

func (fi FieldInfo) String() string

type Structure

type Structure map[string]FieldInfo

Structure is a set of fields of one structure.

func Lookup

func Lookup(sl StructureList, structName string) (Structure, error)

Lookup return structure by name from parsed source file or an error if structure with such name not found.

func (Structure) String

func (s Structure) String() string

String return structure information as a string.

type StructureList

type StructureList map[string]Structure

StructureList is a list of parsed structures.

func Parse

func Parse(path string, src io.Reader) (StructureList, error)

Parse gets path to source file or content of source file as a io.Reader and run inspect functions on it. Function returns list of structures with their fields.