compiler

Documentation

Index

• func RelativePathFromImportPaths(protoPath string, importPaths []string) (string, error)
• type Compiler
  • func New() *Compiler
  • func (c *Compiler) Compile(ctx context.Context, file *source.File, opts ...Option) ([]*descriptorpb.FileDescriptorProto, error)
• type CompilerError
  • func (e *CompilerError) Error() string
• type Option
  • func ImportPathOption(path ...string) Option
  • func ManualImportOption() Option

Functions

func RelativePathFromImportPaths

func RelativePathFromImportPaths(protoPath string, importPaths []string) (string, error)

Types

type Compiler

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

Compiler provides a way to generate file descriptors from a Protocol Buffers file without relying on protoc command. This allows you to do things like validate proto files without relying on protoc.

func New

func New() *Compiler

New creates compiler instance.

func (*Compiler) Compile

func (c *Compiler) Compile(ctx context.Context, file *source.File, opts ...Option) ([]*descriptorpb.FileDescriptorProto, error)

Compile compile the target Protocol Buffers file and produces all file descriptors.

type CompilerError

type CompilerError struct {
	Err        error
	ErrWithPos []reporter.ErrorWithPos
}

CompilerError has error with source position.

func (*CompilerError) Error

func (e *CompilerError) Error() string

type Option

type Option func(*Compiler)

Option represents compiler option.

func ImportPathOption

func ImportPathOption(path ...string) Option

ImportPathOption used to add a path to reference a proto file. By default, only the directory where the starting file exists is added to the import path.

func ManualImportOption

func ManualImportOption() Option

ManualImportOption stops importing `grpc/federation/federation.proto` file and its dependencies By default if `grpc/federation/federation.proto` file and its dependencies do not exist, automatically imports it. The version of the proto file is the same as the version when the compiler is built.