generator

Documentation

Overview

Package generator generates Golang code from the input proto files then compiles the code into protobuf structures for use by the protoc executable.

Index

• func Compile(input io.Reader, output io.Writer, gen Generator) error
• func NewTemplate(name string, content string) *template.Template
• type Argument
• type Descriptor
• type File
• type Generator
• type Method
• type Service
• type Setting

Functions

func Compile

func Compile(input io.Reader, output io.Writer, gen Generator) error

func NewTemplate

func NewTemplate(name string, content string) *template.Template

Types

type Argument

type Argument struct {
	Name        string
	Description string
	Type        descriptor.FieldDescriptorProto_Type
	// contains filtered or unexported fields
}

type Descriptor

type Descriptor struct {
	Imports  map[string]string
	Services []*Service
}

type File

type File struct {
	Name    string
	Content string
}

type Generator

type Generator func(*Descriptor) ([]*File, error)

type Method

type Method struct {
	Name        string
	Description string
	Input       string
	Output      string
	Arguments   []*Argument
}

type Service

type Service struct {
	Name        string
	Enabled     bool
	Description string
	Package     string
	Methods     []*Method
	Config      []Setting
}

type Setting

type Setting struct {
	Name        string
	Required    bool
	Description string
}