common

Documentation

Index

• type EventTypeMetadata
  • func NewEventTypeMetada(fields ...string) *EventTypeMetadata
• type Module
• type Platform
• type StructField
  • func (sf *StructField) GetArrayPrefix() string
  • func (sf *StructField) GetCacheName() string
  • func (sf *StructField) GetDefaultReturnValue() string
  • func (sf *StructField) GetDefaultScalarReturnValue() string
  • func (sf *StructField) GetEvaluatorType() string

Types

type EventTypeMetadata

type EventTypeMetadata struct {
	Doc    string
	Fields []string
}

EventTypeMetadata is used to iterate over the model from the event types

func NewEventTypeMetada

func NewEventTypeMetada(fields ...string) *EventTypeMetadata

NewEventTypeMetada returns a new EventTypeMetada

type Module

type Module struct {
	Name                   string
	SourcePkgPrefix        string
	SourcePkg              string
	TargetPkg              string
	BuildTags              []string
	FieldHandlersBuildTags []string
	Fields                 map[string]*StructField // only exposed fields by SECL
	AllFields              map[string]*StructField
	Iterators              map[string]*StructField
	EventTypes             map[string]*EventTypeMetadata
	Mock                   bool
	Platform               Platform
}

Module represents everything needed to generate the accessors for a specific module (fields, build tags, ...)

type Platform

type Platform string

Platform defines which platform a structure is associated with

const (
	Unspecified Platform = "unspecified"
	Linux       Platform = "linux"
	Windows     Platform = "windows"
)

type StructField

type StructField struct {
	Name                string
	Prefix              string
	Struct              string
	BasicType           string
	ReturnType          string
	IsArray             bool
	IsLength            bool
	Event               string
	Handler             string
	CachelessResolution bool
	SkipADResolution    bool
	OrigType            string
	IsOrigTypePtr       bool
	Iterator            *StructField
	Weight              int64
	CommentText         string
	OpOverrides         string
	Check               string
	Alias               string
	AliasPrefix         string
}

StructField represents a structure field for which an accessor will be generated

func (*StructField) GetArrayPrefix

func (sf *StructField) GetArrayPrefix() string

GetArrayPrefix returns the array prefix of this field

func (*StructField) GetCacheName

func (sf *StructField) GetCacheName() string

GetCacheName returns the cache name

func (*StructField) GetDefaultReturnValue

func (sf *StructField) GetDefaultReturnValue() string

GetDefaultReturnValue returns default value for the given return type

func (*StructField) GetDefaultScalarReturnValue

func (sf *StructField) GetDefaultScalarReturnValue() string

GetDefaultScalarReturnValue returns default scalar value for the given return type

func (*StructField) GetEvaluatorType

func (sf *StructField) GetEvaluatorType() string

GetEvaluatorType returns the evaluator type name