bufimagebuild

Documentation

Index

• type BuildOption
  • func WithExcludeSourceCodeInfo() BuildOption
• type Builder
  • func NewBuilder(logger *zap.Logger) Builder

Types

type BuildOption

type BuildOption func(*buildOptions)

BuildOption is an option for Build.

func WithExcludeSourceCodeInfo

func WithExcludeSourceCodeInfo() BuildOption

WithExcludeSourceCodeInfo returns a BuildOption that excludes sourceCodeInfo.

type Builder

type Builder interface {
	// Build runs compilation.
	//
	// The FileRefs are assumed to have been created by a FileRefProvider, that is
	// they are unique relative to the roots.
	//
	// If an error is returned, it is a system error.
	// Only one of Image and FileAnnotations will be returned.
	//
	// FileAnnotations will use external file paths.
	Build(
		ctx context.Context,
		moduleFileSet bufmodule.ModuleFileSet,
		options ...BuildOption,
	) (bufimage.Image, []bufanalysis.FileAnnotation, error)
}

Builder builds Protobuf files into Images.

func NewBuilder

func NewBuilder(logger *zap.Logger) Builder

NewBuilder returns a new Builder.