protoc

Documentation

Overview

Package protoc provides high level access to protoc command.

Index

• func Generate(ctx context.Context, outDir, protoPath string, ...) error
• type Cmd
  • func Command() (command Cmd, cleanup func(), err error)
• type Option
  • func GenerateDependencies() Option
  • func Plugin(path string, options ...string) Option

Functions

func Generate

func Generate(ctx context.Context, outDir, protoPath string, includePaths, protocOuts []string, options ...Option) error

Generate generates code into outDir from protoPath and its includePaths by using plugins provided with protocOuts.

Types

type Cmd

type Cmd struct {
	Command  []string
	Included []string
}

func Command

func Command() (command Cmd, cleanup func(), err error)

Command sets the protoc binary up and returns the command needed to execute c.

type Option

type Option func(*configs)

Option configures Generate configs.

func GenerateDependencies

func GenerateDependencies() Option

GenerateDependencies enables code generation for the proto files that your protofile depends on. use this if your protoc plugin does not give you an option to enable the same feature.

func Plugin

func Plugin(path string, options ...string) Option

Plugin configures a plugin for code generation.