doc

Documentation

Index

• type Codec
  • func NewCodec(pkgPath string) (*Codec, error)
• type CodecOption
• type CodecOptions
• type Decoder
• type Encoder
• type Generator
  • func (g *Generator) Printf(format string, args ...interface{})
• type Processor
  • func NewProcessor(pkgPath string) (*Processor, error)
  • func (p *Processor) GenExample(kind string) []byte
  • func (p *Processor) GenMarkdown(kind string) []byte
• type ProcessorOption
  • func (p *ProcessorOption) GenExample(kind string) string
• type ProcessorOptions
• type ProcessorPort

Types

type Codec

type Codec struct {
	Name       string
	PkgName    string
	ImportPath string
	Doc        string
	DocShort   string
	Decoder    *Decoder
	Encoder    *Encoder
}

func NewCodec

func NewCodec(pkgPath string) (*Codec, error)

type CodecOption

type CodecOption struct {
	Name           string
	Alias          string
	Doc            string
	Required       bool
	Type           string
	DefaultValue   interface{}
	PossibleValues []string
	//LogstashExample
	ExampleLS string
}

type CodecOptions

type CodecOptions struct {
	Doc     string
	Options []*CodecOption
}

type Decoder

type Decoder struct {
	Doc     string
	Options *CodecOptions
}

type Encoder

type Encoder struct {
	Doc     string
	Options *CodecOptions
}

type Generator

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

Generator holds the state of the analysis. Primarily used to buffer the output for format.Source.

func (*Generator) Printf

func (g *Generator) Printf(format string, args ...interface{})

type Processor

type Processor struct {
	Behavior   string
	Name       string
	ImportPath string
	Doc        string
	DocShort   string
	Options    *ProcessorOptions
	Ports      []*ProcessorPort
}

func NewProcessor

func NewProcessor(pkgPath string) (*Processor, error)

func (*Processor) GenExample

func (p *Processor) GenExample(kind string) []byte

func (*Processor) GenMarkdown

func (p *Processor) GenMarkdown(kind string) []byte

type ProcessorOption

type ProcessorOption struct {
	Name           string
	Alias          string
	Doc            string
	Required       bool
	Type           string
	DefaultValue   interface{}
	PossibleValues []string
	//LogstashExample
	ExampleLS string
}

func (*ProcessorOption) GenExample

func (p *ProcessorOption) GenExample(kind string) string

type ProcessorOptions

type ProcessorOptions struct {
	Doc     string
	Options []*ProcessorOption
}

type ProcessorPort

type ProcessorPort struct {
	Default bool
	Name    string
	Number  int
	Doc     string
}