protobuf

package
v0.0.0-...-ef67063 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 21, 2026 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// DefaultOutputFileBaseName is the default output file base name for the generated protobuf functions.
	DefaultOutputFileBaseName = "generated.pb"
)

Variables

This section is empty.

Functions

func NewGenerator

func NewGenerator(opts Options) generation.Generator

NewGenerator builds a new protobuf generator.

Types

type Options

type Options struct {
	// Disabled indicates whether the protobuf generator is enabled or not.
	// This defaults to true as the protobuf generator is disabled by default.
	Disabled *bool

	// DisabledVersions allows you to explicitly disable the generation of protobuf for
	// specific versions of an API.
	// This is a list of version names.
	// When omitted, no versions are disabled.
	DisabledVersions []string

	// HeaderFilePath is the path to the file containing the boilerplate header text.
	// When omitted, no header is added to the generated files.
	HeaderFilePath string

	// Verify determines whether the generator should verify the content instead
	// of updating the generated file.
	Verify bool
}

Options contains the configuration required for the protobuf generator.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL