fieldtags

Documentation

Overview

Package fieldtags defines an analyzer that identifies struct fields identified as sources via a field tag.

Index

• Variables
• type ResultType
  • func (r ResultType) IsSource(field *types.Var) bool
  • func (r ResultType) IsSourceField(t types.Type, field int) bool

Variables

var Analyzer = &analysis.Analyzer{
	Name: "fieldtags",
	Doc:  "This analyzer identifies Source fields based on their tags.",
	Run:  run,
	Requires: []*analysis.Analyzer{
		inspect.Analyzer,
	},
	ResultType: reflect.TypeOf(new(ResultType)).Elem(),
	FactTypes:  []analysis.Fact{new(isTaggedField)},
}

Types

type ResultType

type ResultType map[types.Object]bool

ResultType is a map from types.Object to bool. It can be used to determine whether a field is a tagged Source field.

func (ResultType) IsSource

func (r ResultType) IsSource(field *types.Var) bool

IsSource determines whether a types.Var is a source, that is whether it refers to a field previously identified as a source.

func (ResultType) IsSourceField

func (r ResultType) IsSourceField(t types.Type, field int) bool

IsSourceField determines whether a field on a type is a source field, using the type of the struct holding the field as well as the index of the field.