common

Documentation

Index

• Constants
• type ContextKey
• type DescriptionMarkdown
• type Options
  • func DefaultOptions() *Options
• type State
  • func (s *State) PackageAlias(name, path string)
  • func (s *State) PackageAliases() map[string]string
  • func (s *State) SetSpecData(data []byte)
  • func (s *State) SpecData() []byte

Constants

const (
	ContextState            = "state"
	ContextCommonOptions    = "options"
	ContextGeneratorOptions = "generatorOptions"
)

Context key values

Types

type ContextKey

type ContextKey string

ContextKey is a custom key type for contexts

type DescriptionMarkdown

type DescriptionMarkdown interface {
	DescriptionMarkdown() string
}

DescriptionMarkdown simply allows for getting markdown text.

type Options

type Options struct {
	DescriptionComments bool
	Comments            bool
}

Options provides information and settings for all parsers, transformers and targers.

func DefaultOptions

func DefaultOptions() *Options

DefaultOptions returns the default options

type State

type State struct {
	// contains filtered or unexported fields
}

State is a shared state for an entire code generation process. TODO make it threadsafe if needed

func (*State) PackageAlias

func (s *State) PackageAlias(name, path string)

SpecData returns the specification data.

func (*State) PackageAliases

func (s *State) PackageAliases() map[string]string

SetSpecData sets specification data.

func (*State) SetSpecData

func (s *State) SetSpecData(data []byte)

SetSpecData sets specification data.

func (*State) SpecData

func (s *State) SpecData() []byte

SpecData returns the specification data.