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

package protodesc Import Path google.golang.org/protobuf/reflect/protodesc (on go.dev) Dependency Relation imports 15 packages, and imported by one package

Involved Source Files d➜ desc.go Package protodesc provides functionality for converting FileDescriptorProto messages to/from protoreflect.FileDescriptor values. The google.protobuf.FileDescriptorProto is a protobuf message that describes the type information for a .proto file in a form that is easily serializable. The protoreflect.FileDescriptor is a more structured representation of the FileDescriptorProto message where references and remote dependencies can be directly followed. desc_init.go desc_resolve.go desc_validate.go proto.go

Package-Level Type Names (total 6, in which 2 are exported)

/* sort exporteds by: alphabet | popularity */

type FileOptions (struct) FileOptions configures the construction of file descriptors. Fields (total 2, both are exported) AllowUnresolvable bool AllowUnresolvable configures New to permissively allow unresolvable file, enum, or message dependencies. Unresolved dependencies are replaced by placeholder equivalents. The following dependencies may be left unresolved: • Resolving an imported file. • Resolving the type for a message field or extension field. If the kind of the field is unknown, then a placeholder is used for both the Enum and Message accessors on the protoreflect.FieldDescriptor. • Resolving an enum value set as the default for an optional enum field. If unresolvable, the protoreflect.FieldDescriptor.Default is set to the first value in the associated enum (or zero if the also enum dependency is also unresolvable). The protoreflect.FieldDescriptor.DefaultEnumValue is populated with a placeholder. • Resolving the extended message type for an extension field. • Resolving the input or output message type for a service method. If the unresolved dependency uses a relative name, then the placeholder will contain an invalid FullName with a "*." prefix, indicating that the starting prefix of the full name is unknown. NoUnkeyedLiterals pragma.NoUnkeyedLiterals Methods (total 3, in which 2 are exported) ( T) New(fd *descriptorpb.FileDescriptorProto, r Resolver) (protoreflect.FileDescriptor, error) New creates a new protoreflect.FileDescriptor from the provided file descriptor message. The file must represent a valid proto file according to protobuf semantics. The returned descriptor is a deep copy of the input. Any imported files, enum types, or message types referenced in the file are resolved using the provided registry. When looking up an import file path, the path must be unique. The newly created file descriptor is not registered back into the provided file registry. ( T) NewFiles(fds *descriptorpb.FileDescriptorSet) (*protoregistry.Files, error) NewFiles creates a new protoregistry.Files from the provided FileDescriptorSet message. The descriptor set must include only valid files according to protobuf semantics. The returned descriptors are a deep copy of the input. /* one unexported ... *//* one unexported: */ ( T) addFileDeps(r *protoregistry.Files, fd *descriptorpb.FileDescriptorProto, files map[string]*descriptorpb.FileDescriptorProto) error

type Resolver (interface) Resolver is the resolver used by NewFile to resolve dependencies. The enums and messages provided must belong to some parent file, which is also registered. It is implemented by protoregistry.Files. Methods (total 2, both are exported) ( T) FindDescriptorByName(protoreflect.FullName) (protoreflect.Descriptor, error) ( T) FindFileByPath(string) (protoreflect.FileDescriptor, error) Implemented By (at least 4, in which 1 are exported) *google.golang.org/protobuf/reflect/protoregistry.Files /* 3+ unexporteds ... *//* 3+ unexporteds: */ google.golang.org/protobuf/internal/filetype.fileRegistry (interface) google.golang.org/protobuf/internal/filetype.resolverByIndex google.golang.org/protobuf/internal/impl.resolverOnly As Inputs Of (at least 2, both are exported) func NewFile(fd *descriptorpb.FileDescriptorProto, r Resolver) (protoreflect.FileDescriptor, error) func FileOptions.New(fd *descriptorpb.FileDescriptorProto, r Resolver) (protoreflect.FileDescriptor, error)

/* 4 unexporteds ... *//* 4 unexporteds: */

type descsByName (map) Methods (total 9, none are exported) /* 9 unexporteds ... *//* 9 unexporteds: */ ( T) initEnumDeclarations(eds []*descriptorpb.EnumDescriptorProto, parent protoreflect.Descriptor, sb *strs.Builder) (es []filedesc.Enum, err error) ( T) initEnumValuesFromDescriptorProto(vds []*descriptorpb.EnumValueDescriptorProto, parent protoreflect.Descriptor, sb *strs.Builder) (vs []filedesc.EnumValue, err error) ( T) initExtensionDeclarations(xds []*descriptorpb.FieldDescriptorProto, parent protoreflect.Descriptor, sb *strs.Builder) (xs []filedesc.Extension, err error) ( T) initFieldsFromDescriptorProto(fds []*descriptorpb.FieldDescriptorProto, parent protoreflect.Descriptor, sb *strs.Builder) (fs []filedesc.Field, err error) ( T) initMessagesDeclarations(mds []*descriptorpb.DescriptorProto, parent protoreflect.Descriptor, sb *strs.Builder) (ms []filedesc.Message, err error) ( T) initMethodsFromDescriptorProto(mds []*descriptorpb.MethodDescriptorProto, parent protoreflect.Descriptor, sb *strs.Builder) (ms []filedesc.Method, err error) ( T) initOneofsFromDescriptorProto(ods []*descriptorpb.OneofDescriptorProto, parent protoreflect.Descriptor, sb *strs.Builder) (os []filedesc.Oneof, err error) ( T) initServiceDeclarations(sds []*descriptorpb.ServiceDescriptorProto, parent protoreflect.Descriptor, sb *strs.Builder) (ss []filedesc.Service, err error) ( T) makeBase(child, parent protoreflect.Descriptor, name string, idx int, sb *strs.Builder) (filedesc.BaseL0, error)

type importSet (map) Methods (only one, which is unexported) /* one unexported ... *//* one unexported: */ ( T) importPublic(imps protoreflect.FileImports)

type partialName string (basic type) partialName is the partial name. A leading dot means that the name is full, otherwise the name is relative to some current scope. See google.protobuf.FieldDescriptorProto.type_name. Methods (total 3, all are exported) ( T) FullName() protoreflect.FullName FullName converts the partial name to a full name on a best-effort basis. If relative, it creates an invalid full name, using a "*." prefix to indicate that the start of the full name is unknown. ( T) IsFull() bool ( T) IsValid() bool

type resolver (struct) resolver is a wrapper around a local registry of declarations within the file and the remote resolver. The remote resolver is restricted to only return descriptors that have been imported. Fields (total 4, none are exported) /* 4 unexporteds ... *//* 4 unexporteds: */ allowUnresolvable bool imports importSet local descsByName remote Resolver Methods (total 7, none are exported) /* 7 unexporteds ... *//* 7 unexporteds: */ (*T) findDescriptor(scope protoreflect.FullName, ref partialName) (protoreflect.Descriptor, error) findDescriptor finds the descriptor by name, which may be a relative name within some scope. Suppose the scope was "fizz.buzz" and the reference was "Foo.Bar", then the following full names are searched: * fizz.buzz.Foo.Bar * fizz.Foo.Bar * Foo.Bar (*T) findEnumDescriptor(scope protoreflect.FullName, ref partialName, isWeak bool) (protoreflect.EnumDescriptor, error) (*T) findMessageDescriptor(scope protoreflect.FullName, ref partialName, isWeak bool) (protoreflect.MessageDescriptor, error) (*T) findTarget(k protoreflect.Kind, scope protoreflect.FullName, ref partialName, isWeak bool) (protoreflect.Kind, protoreflect.EnumDescriptor, protoreflect.MessageDescriptor, error) findTarget finds an enum or message descriptor if k is an enum, message, group, or unknown. If unknown, and the name could be resolved, the kind returned kind is set based on the type of the resolved descriptor. (*T) resolveExtensionDependencies(xs []filedesc.Extension, xds []*descriptorpb.FieldDescriptorProto) (err error) (*T) resolveMessageDependencies(ms []filedesc.Message, mds []*descriptorpb.DescriptorProto) (err error) (*T) resolveServiceDependencies(ss []filedesc.Service, sds []*descriptorpb.ServiceDescriptorProto) (err error)

Package-Level Functions (total 19, in which 10 are exported)

func NewFile(fd *descriptorpb.FileDescriptorProto, r Resolver) (protoreflect.FileDescriptor, error) NewFile creates a new protoreflect.FileDescriptor from the provided file descriptor message. See FileOptions.New for more information.

func NewFiles(fd *descriptorpb.FileDescriptorSet) (*protoregistry.Files, error) NewFiles creates a new protoregistry.Files from the provided FileDescriptorSet message. See FileOptions.NewFiles for more information.

func ToDescriptorProto(message protoreflect.MessageDescriptor) *descriptorpb.DescriptorProto ToDescriptorProto copies a protoreflect.MessageDescriptor into a google.protobuf.DescriptorProto message.

func ToEnumDescriptorProto(enum protoreflect.EnumDescriptor) *descriptorpb.EnumDescriptorProto ToEnumDescriptorProto copies a protoreflect.EnumDescriptor into a google.protobuf.EnumDescriptorProto message.

func ToEnumValueDescriptorProto(value protoreflect.EnumValueDescriptor) *descriptorpb.EnumValueDescriptorProto ToEnumValueDescriptorProto copies a protoreflect.EnumValueDescriptor into a google.protobuf.EnumValueDescriptorProto message.

func ToFieldDescriptorProto(field protoreflect.FieldDescriptor) *descriptorpb.FieldDescriptorProto ToFieldDescriptorProto copies a protoreflect.FieldDescriptor into a google.protobuf.FieldDescriptorProto message.

func ToFileDescriptorProto(file protoreflect.FileDescriptor) *descriptorpb.FileDescriptorProto ToFileDescriptorProto copies a protoreflect.FileDescriptor into a google.protobuf.FileDescriptorProto message.

func ToMethodDescriptorProto(method protoreflect.MethodDescriptor) *descriptorpb.MethodDescriptorProto ToMethodDescriptorProto copies a protoreflect.MethodDescriptor into a google.protobuf.MethodDescriptorProto message.

func ToOneofDescriptorProto(oneof protoreflect.OneofDescriptor) *descriptorpb.OneofDescriptorProto ToOneofDescriptorProto copies a protoreflect.OneofDescriptor into a google.protobuf.OneofDescriptorProto message.

func ToServiceDescriptorProto(service protoreflect.ServiceDescriptor) *descriptorpb.ServiceDescriptorProto ToServiceDescriptorProto copies a protoreflect.ServiceDescriptor into a google.protobuf.ServiceDescriptorProto message.

/* 9 unexporteds ... *//* 9 unexporteds: */

func checkValidGroup(fd protoreflect.FieldDescriptor) error checkValidGroup reports whether fd is a valid group according to the same rules that protoc imposes.

func checkValidMap(fd protoreflect.FieldDescriptor) error checkValidMap checks whether the field is a valid map according to the same rules that protoc imposes. See protoc v3.8.0: src/google/protobuf/descriptor.cc:6045-6115

func fullNameOf(d protoreflect.Descriptor) *string

func isOptionalMessage(fd protoreflect.FieldDescriptor) bool isOptionalMessage reports whether this is an optional message. If the kind is unknown, it is assumed to be a message.

func isPackable(fd protoreflect.FieldDescriptor) bool isPackable checks whether the pack option can be specified.

func unmarshalDefault(s string, fd protoreflect.FieldDescriptor, allowUnresolvable bool) (protoreflect.Value, protoreflect.EnumValueDescriptor, error)

func validateEnumDeclarations(es []filedesc.Enum, eds []*descriptorpb.EnumDescriptorProto) error

func validateExtensionDeclarations(xs []filedesc.Extension, xds []*descriptorpb.FieldDescriptorProto) error

func validateMessageDeclarations(ms []filedesc.Message, mds []*descriptorpb.DescriptorProto) error

Package-Level Constants (only one, which is unexported) /* one unexported ... *//* one unexported: */

const unknownPrefix = "*."