finalize

Documentation

Index

• Variables
• func Run(pass *analysis.Pass) (interface{}, error)
• type FunctionCall
• type Result
• type TopicMapperQualifiedNames

Variables

var Analyzer = &analysis.Analyzer{
	Name:             "finalizer",
	Doc:              "finalizes module schema and writes to the output destination",
	Run:              Run,
	ResultType:       reflect.TypeFor[Result](),
	RunDespiteErrors: true,
}

Analyzer aggregates the results of all extractors.

Functions

func Run

func Run(pass *analysis.Pass) (interface{}, error)

Types

type FunctionCall

type FunctionCall struct {
	Caller types.Object
	Callee types.Object
}

type Result

type Result struct {
	ModuleName     string
	ModuleComments []string

	// Extracted contains all objects successfully extracted to schema.Decls.
	Extracted map[schema.Decl]types.Object
	// Failed contains all objects that failed extraction.
	Failed map[schema.RefKey]types.Object
	// Native names that can't be derived outside of the analysis pass.
	NativeNames map[schema.Node]string
	// FunctionCalls contains all function calls; key is the parent function, value is the called functions.
	FunctionCalls map[schema.Position]FunctionCall
	// VerbResourceParamOrder contains the order of resource parameters for each verb.
	VerbResourceParamOrder map[*schema.Verb][]common.VerbResourceParam
	// TopicPartitionMapper maps the topic to the native names for the partition mapper.
	TopicPartitionMaps map[*schema.Topic]TopicMapperQualifiedNames
}

Result contains the final schema extraction result.

type TopicMapperQualifiedNames

type TopicMapperQualifiedNames struct {
	// qualified name of the partition mapper
	Mapper string
	// qualified name of associated type of the partition mapper
	AssociatedType optional.Option[string]
}

TopicMapperQualifiedNames contains the qualified names of the partition mapper and associated types for a topic.