Package: google.golang.org/protobuf/reflect/protoregistry

package protoregistry Import Path google.golang.org/protobuf/reflect/protoregistry (on go.dev) Dependency Relation imports 8 packages, and imported by 9 packages

Involved Source Files d➜ registry.go Package protoregistry provides data structures to register and lookup protobuf descriptor types. The Files registry contains file descriptors and provides the ability to iterate over the files or lookup a specific descriptor within the files. Files only contains protobuf descriptors and has no understanding of Go type information that may be associated with each descriptor. The Types registry contains descriptor types for which there is a known Go type associated with that descriptor. It provides the ability to iterate over the registered types or lookup a type by name.

Package-Level Type Names (total 9, in which 4 are exported)

/* sort exporteds by: alphabet | popularity */

type ExtensionTypeResolver (interface) ExtensionTypeResolver is an interface for looking up extensions. A compliant implementation must deterministically return the same type if no error is encountered. The Types type implements this interface. Methods (total 2, both are exported) ( T) FindExtensionByName(field protoreflect.FullName) (protoreflect.ExtensionType, error) ( T) FindExtensionByNumber(message protoreflect.FullName, field protoreflect.FieldNumber) (protoreflect.ExtensionType, error) Implemented By (at least 2, in which 1 are exported) *Types /* at least one unexported ... *//* at least one unexported: */ github.com/golang/protobuf/proto.extensionResolver

type Files (struct) Files is a registry for looking up or iterating over files and the descriptors contained within them. The Find and Range methods are safe for concurrent use. Fields (total 2, neither is exported) /* 2 unexporteds ... *//* 2 unexporteds: */ descsByName map[protoreflect.FullName]interface{} The map of descsByName contains: EnumDescriptor EnumValueDescriptor MessageDescriptor ExtensionDescriptor ServiceDescriptor *packageDescriptor Note that files are stored as a slice, since a package may contain multiple files. Only top-level declarations are registered. Note that enum values are in the top-level since that are in the same scope as the parent enum. filesByPath map[string]protoreflect.FileDescriptor Methods (total 8, in which 7 are exported) (*T) FindDescriptorByName(name protoreflect.FullName) (protoreflect.Descriptor, error) FindDescriptorByName looks up a descriptor by the full name. This returns (nil, NotFound) if not found. (*T) FindFileByPath(path string) (protoreflect.FileDescriptor, error) FindFileByPath looks up a file by the path. This returns (nil, NotFound) if not found. (*T) NumFiles() int NumFiles reports the number of registered files. (*T) NumFilesByPackage(name protoreflect.FullName) int NumFilesByPackage reports the number of registered files in a proto package. (*T) RangeFiles(f func(protoreflect.FileDescriptor) bool) RangeFiles iterates over all registered files while f returns true. The iteration order is undefined. (*T) RangeFilesByPackage(name protoreflect.FullName, f func(protoreflect.FileDescriptor) bool) RangeFilesByPackage iterates over all registered files in a given proto package while f returns true. The iteration order is undefined. (*T) RegisterFile(file protoreflect.FileDescriptor) error RegisterFile registers the provided file descriptor. If any descriptor within the file conflicts with the descriptor of any previously registered file (e.g., two enums with the same full name), then the file is not registered and an error is returned. It is permitted for multiple files to have the same file path. /* one unexported ... *//* one unexported: */ (*T) checkGenProtoConflict(path string) Several well-known types were hosted in the google.golang.org/genproto module but were later moved to this module. To avoid a weak dependency on the genproto module (and its relatively large set of transitive dependencies), we rely on a registration conflict to determine whether the genproto version is too old (i.e., does not contain aliases to the new type declarations). Implements (at least 2, in which 1 are exported) *T : google.golang.org/protobuf/reflect/protodesc.Resolver /* at least one unexported ... *//* at least one unexported: */ *T : google.golang.org/protobuf/internal/filetype.fileRegistry As Outputs Of (at least 2, both are exported) func google.golang.org/protobuf/reflect/protodesc.NewFiles(fd *descriptorpb.FileDescriptorSet) (*Files, error) func google.golang.org/protobuf/reflect/protodesc.FileOptions.NewFiles(fds *descriptorpb.FileDescriptorSet) (*Files, error) As Inputs Of (at least one unexported) /* at least one unexported ... *//* at least one unexported: */ func google.golang.org/protobuf/reflect/protodesc.FileOptions.addFileDeps(r *Files, fd *descriptorpb.FileDescriptorProto, files map[string]*descriptorpb.FileDescriptorProto) error As Types Of (only one, which is exported) var GlobalFiles *Files

type MessageTypeResolver (interface) MessageTypeResolver is an interface for looking up messages. A compliant implementation must deterministically return the same type if no error is encountered. The Types type implements this interface. Methods (total 2, both are exported) ( T) FindMessageByName(message protoreflect.FullName) (protoreflect.MessageType, error) FindMessageByName looks up a message by its full name. E.g., "google.protobuf.Any" This return (nil, NotFound) if not found. ( T) FindMessageByURL(url string) (protoreflect.MessageType, error) FindMessageByURL looks up a message by a URL identifier. See documentation on google.protobuf.Any.type_url for the URL format. This returns (nil, NotFound) if not found. Implemented By (at least one exported) *Types

type Types (struct) Types is a registry for looking up or iterating over descriptor types. The Find and Range methods are safe for concurrent use. Fields (total 5, none are exported) /* 5 unexporteds ... *//* 5 unexporteds: */ extensionsByMessage extensionsByMessage numEnums int numExtensions int numMessages int typesByName typesByName Methods (total 17, in which 16 are exported) (*T) FindEnumByName(enum protoreflect.FullName) (protoreflect.EnumType, error) FindEnumByName looks up an enum by its full name. E.g., "google.protobuf.Field.Kind". This returns (nil, NotFound) if not found. (*T) FindExtensionByName(field protoreflect.FullName) (protoreflect.ExtensionType, error) FindExtensionByName looks up a extension field by the field's full name. Note that this is the full name of the field as determined by where the extension is declared and is unrelated to the full name of the message being extended. This returns (nil, NotFound) if not found. (*T) FindExtensionByNumber(message protoreflect.FullName, field protoreflect.FieldNumber) (protoreflect.ExtensionType, error) FindExtensionByNumber looks up a extension field by the field number within some parent message, identified by full name. This returns (nil, NotFound) if not found. (*T) FindMessageByName(message protoreflect.FullName) (protoreflect.MessageType, error) FindMessageByName looks up a message by its full name, e.g. "google.protobuf.Any". This returns (nil, NotFound) if not found. (*T) FindMessageByURL(url string) (protoreflect.MessageType, error) FindMessageByURL looks up a message by a URL identifier. See documentation on google.protobuf.Any.type_url for the URL format. This returns (nil, NotFound) if not found. (*T) NumEnums() int NumEnums reports the number of registered enums. (*T) NumExtensions() int NumExtensions reports the number of registered extensions. (*T) NumExtensionsByMessage(message protoreflect.FullName) int NumExtensionsByMessage reports the number of registered extensions for a given message type. (*T) NumMessages() int NumMessages reports the number of registered messages. (*T) RangeEnums(f func(protoreflect.EnumType) bool) RangeEnums iterates over all registered enums while f returns true. Iteration order is undefined. (*T) RangeExtensions(f func(protoreflect.ExtensionType) bool) RangeExtensions iterates over all registered extensions while f returns true. Iteration order is undefined. (*T) RangeExtensionsByMessage(message protoreflect.FullName, f func(protoreflect.ExtensionType) bool) RangeExtensionsByMessage iterates over all registered extensions filtered by a given message type while f returns true. Iteration order is undefined. (*T) RangeMessages(f func(protoreflect.MessageType) bool) RangeMessages iterates over all registered messages while f returns true. Iteration order is undefined. (*T) RegisterEnum(et protoreflect.EnumType) error RegisterEnum registers the provided enum type. If a naming conflict occurs, the type is not registered and an error is returned. (*T) RegisterExtension(xt protoreflect.ExtensionType) error RegisterExtension registers the provided extension type. If a naming conflict occurs, the type is not registered and an error is returned. (*T) RegisterMessage(mt protoreflect.MessageType) error RegisterMessage registers the provided message type. If a naming conflict occurs, the type is not registered and an error is returned. /* one unexported ... *//* one unexported: */ (*T) register(kind string, desc protoreflect.Descriptor, typ interface{}) error Implements (at least 2, both are exported) *T : ExtensionTypeResolver *T : MessageTypeResolver As Types Of (only one, which is exported) var GlobalTypes *Types

/* 5 unexporteds ... *//* 5 unexporteds: */

type extensionsByMessage (map)

type extensionsByNumber (map)

type nameSuffix string (basic type) Methods (only one, which is exported) (*T) Pop() (name protoreflect.Name) As Inputs Of (at least one unexported) /* at least one unexported ... *//* at least one unexported: */ func findDescriptorInMessage(md protoreflect.MessageDescriptor, suffix nameSuffix) protoreflect.Descriptor

type packageDescriptor (struct) Fields (only one, which is unexported) /* one unexported ... *//* one unexported: */ files []protoreflect.FileDescriptor

type typesByName (map)

Package-Level Functions (total 5, none are exported) /* 5 unexporteds ... *//* 5 unexporteds: */

func amendErrorWithCaller(err error, prev, curr interface{}) error

func findDescriptorInMessage(md protoreflect.MessageDescriptor, suffix nameSuffix) protoreflect.Descriptor

func goPackage(v interface{}) string

func rangeTopLevelDescriptors(fd protoreflect.FileDescriptor, f func(protoreflect.Descriptor)) rangeTopLevelDescriptors iterates over all top-level descriptors in a file which will be directly entered into the registry.

func typeName(t interface{}) string

Package-Level Variables (total 6, in which 3 are exported)

var GlobalFiles *Files GlobalFiles is a global registry of file descriptors.

var GlobalTypes *Types GlobalTypes is the registry used by default for type lookups unless a local registry is provided by the user.

var NotFound error NotFound is a sentinel error value to indicate that the type was not found. Since registry lookup can happen in the critical performance path, resolvers must return this exact error value, not an error wrapping it.

/* 3 unexporteds ... *//* 3 unexporteds: */

var conflictPolicy string // "panic" | "warn" | "ignore" conflictPolicy configures the policy for handling registration conflicts. It can be over-written at compile time with a linker-initialized variable: go build -ldflags "-X google.golang.org/protobuf/reflect/protoregistry.conflictPolicy=warn" It can be over-written at program execution with an environment variable: GOLANG_PROTOBUF_REGISTRATION_CONFLICT=warn ./main Neither of the above are covered by the compatibility promise and may be removed in a future release of this module.

var globalMutex sync.RWMutex

var ignoreConflict func(d protoreflect.Descriptor, err error) bool ignoreConflict reports whether to ignore a registration conflict given the descriptor being registered and the error. It is a variable so that the behavior is easily overridden in another file.