sourceinfo

package
v2.0.0-...-c9ae7ca Latest Latest
Warning

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

 Go to latest Published: Feb 7, 2024 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Overview

Package sourceinfo provides the ability to register and query source code info for file descriptors that are compiled into the binary. This data is registered by code generated from the protoc-gen-gosrcinfo plugin.

The standard descriptors bundled into the compiled binary are stripped of source code info, to reduce binary size and reduce runtime memory footprint. However, the source code info can be very handy and worth the size cost when used with gRPC services and the server reflection service. Without source code info, the descriptors that a client downloads from the reflection service have no comments. But the presence of comments, and the ability to show them to humans, can greatly improve the utility of user agents that use the reflection service.

In order to make the reflection service use this functionality, you will need to be using v1.45 or higher of the Go runtime for gRPC (google.golang.org/grpc). The following snippet demonstrates how to do this in your server. Do this instead of using the reflection.Register function: 

refSvr := reflection.NewServer(reflection.ServerOptions{
    Services:           grpcServer,
    DescriptorResolver: sourceinfo.Files,
    ExtensionResolver:  sourceinfo.Types,
})
grpc_reflection_v1alpha.RegisterServerReflectionServer(grpcServer, refSvr)

Index

Constants

This section is empty.

Variables

View Source 
var (
	// Files is a registry of descriptors that include source code info, if the
	// files they belong to were processed with protoc-gen-gosrcinfo.
	//
	// It is meant to serve as a drop-in alternative to protoregistry.GlobalFiles
	// that can include source code info in the returned descriptors.
	Files protoresolve.DescriptorPool = files{}

	// Types is a registry of types that include source code info, if the
	// files they belong to were processed with protoc-gen-gosrcinfo.
	//
	// It is meant to serve as a drop-in alternative to protoregistry.GlobalTypes
	// that can include source code info in the returned types.
	Types protoresolve.TypePool = types{}
)

Functions

func ForFile 

func ForFile(file string) (*descriptorpb.SourceCodeInfo, error)

ForFile queries for any registered source code info for the file descriptor with the given path/name. It returns nil if no source code info was registered.

func Register 

func Register(file string, data []byte)

Register registers the given source code info, which is a serialized and gzipped form of a google.protobuf.SourceCodeInfo message.

This is automatically used from generated code if using the protoc-gen-gosrcinfo plugin.

func WrapEnum 

func WrapEnum(ed protoreflect.EnumDescriptor) protoreflect.EnumDescriptor

WrapEnum wraps the given enum descriptor so that it will include source code info that was registered with this package if the file it is defined in was processed with protoc-gen-gosrcinfo. Returns ed without wrapping if ed's parent file already contains source code info.

func WrapEnumType 

func WrapEnumType(et protoreflect.EnumType) protoreflect.EnumType

WrapEnumType wraps the given enum type so that its associated descriptor will include source code info that was registered with this package if the file it is defined in was processed with protoc-gen-gosrcinfo. Returns et without wrapping if the parent file of et's descriptor already contains source code info.

func WrapExtension 

func WrapExtension(extd protoreflect.ExtensionDescriptor) protoreflect.ExtensionDescriptor

WrapExtension wraps the given extension descriptor so that it will include source code info that was registered with this package if the file it is defined in was processed with protoc-gen-gosrcinfo. Returns ed without wrapping if extd's parent file already contains source code info.

func WrapExtensionType 

func WrapExtensionType(xt protoreflect.ExtensionType) protoreflect.ExtensionType

WrapExtensionType wraps the given extension type so that its associated descriptor will include source code info that was registered with this package if the file it is defined in was processed with protoc-gen-gosrcinfo. Returns xt without wrapping if the parent file of xt's descriptor already contains source code info.

func WrapFile 

func WrapFile(fd protoreflect.FileDescriptor) protoreflect.FileDescriptor

WrapFile wraps the given file descriptor so that it will include source code info that was registered with this package if the given file was processed with protoc-gen-gosrcinfo. Returns fd without wrapping if fd already contains source code info.

func WrapMessage 

func WrapMessage(md protoreflect.MessageDescriptor) protoreflect.MessageDescriptor

WrapMessage wraps the given message descriptor so that it will include source code info that was registered with this package if the file it is defined in was processed with protoc-gen-gosrcinfo. Returns md without wrapping if md's parent file already contains source code info.

func WrapMessageType 

func WrapMessageType(mt protoreflect.MessageType) protoreflect.MessageType

WrapMessageType wraps the given message type so that its associated descriptor will include source code info that was registered with this package if the file it is defined in was processed with protoc-gen-gosrcinfo. Returns mt without wrapping if the parent file of mt's descriptor already contains source code info.

func WrapService 

func WrapService(sd protoreflect.ServiceDescriptor) protoreflect.ServiceDescriptor

WrapService wraps the given service descriptor so that it will include source code info that was registered with this package if the file it is defined in was processed with protoc-gen-gosrcinfo. Returns sd without wrapping if sd's parent file already contains source code info.

Types

This section is empty.

Source Files

View all Source files

Directories

Path Synopsis
cmd
protoc-gen-gosrcinfo
Command protoc-gen-gosrcinfo is a protoc plugin.
 Command protoc-gen-gosrcinfo is a protoc plugin.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.