appproto

Documentation

Overview

Package appproto contains helper functionality for protoc plugins.

Note this is currently implicitly tested through buf's protoc command. If this were split out into a separate package, testing would need to be moved to this package.

Index

• func NewRunFunc(handler Handler) func(context.Context, app.Container) error
• type Executor
  • func NewExecutor(logger *zap.Logger, handler Handler) Executor
• type Handler
• type HandlerFunc
  • func (h HandlerFunc) Handle(ctx context.Context, container app.EnvStderrContainer, ...) error
• type ResponseWriter

Functions

func NewRunFunc

func NewRunFunc(handler Handler) func(context.Context, app.Container) error

NewRunFunc returns a new RunFunc for app.Main and app.Run.

Types

type Executor

type Executor interface {
	Execute(
		ctx context.Context,
		container app.EnvStderrContainer,
		readWriteBucket storage.ReadWriteBucket,
		request *pluginpb.CodeGeneratorRequest,
	) error
}

Executor executes the Handler using protoc's plugin execution logic.

This invokes a Handler and writes out the response to a Bucket, additionally accounting for insertion point logic.

func NewExecutor

func NewExecutor(
	logger *zap.Logger,
	handler Handler,
) Executor

NewExecutor returns a new Executor.

type Handler

type Handler interface {
	// Handle handles the plugin.
	//
	// This function can assume the request is valid.
	Handle(
		ctx context.Context,
		container app.EnvStderrContainer,
		responseWriter ResponseWriter,
		request *pluginpb.CodeGeneratorRequest,
	) error
}

Handler is a protoc plugin handler

type HandlerFunc

type HandlerFunc func(
	context.Context,
	app.EnvStderrContainer,
	ResponseWriter,
	*pluginpb.CodeGeneratorRequest,
) error

HandlerFunc is a handler function.

func (HandlerFunc) Handle

func (h HandlerFunc) Handle(
	ctx context.Context,
	container app.EnvStderrContainer,
	responseWriter ResponseWriter,
	request *pluginpb.CodeGeneratorRequest,
) error

Handle implements Handler.

type ResponseWriter

type ResponseWriter interface {
	// Add adds the file to the response.
	//
	// Returns error if nil, the name is empty, or the name is already added.
	Add(*pluginpb.CodeGeneratorResponse_File) error
	// AddError adds the error message to the response.
	//
	// If there is an existing error message, this will be concatenated with a newline.
	AddError(message string) error
	// SetFeatureProto3Optional sets the proto3 optional feature.
	SetFeatureProto3Optional()
}

ResponseWriter handles CodeGeneratorResponses.