dynamicpb package - google.golang.org/protobuf/types/dynamicpb - Go Packages (original) (raw)

Package dynamicpb creates protocol buffer messages using runtime type information.

This section is empty.

This section is empty.

NewEnumType creates a new EnumType with the provided descriptor.

EnumTypes created by this package are equal if their descriptors are equal. That is, if ed1 == ed2, then NewEnumType(ed1) == NewEnumType(ed2).

Enum values created by the EnumType are equal if their numbers are equal.

NewExtensionType creates a new ExtensionType with the provided descriptor.

Dynamic ExtensionTypes with the same descriptor compare as equal. That is, if xd1 == xd2, then NewExtensionType(xd1) == NewExtensionType(xd2).

The InterfaceOf and ValueOf methods of the extension type are defined as:

func (xt extensionType) ValueOf(iv any) protoreflect.Value { return protoreflect.ValueOf(iv) }

func (xt extensionType) InterfaceOf(v protoreflect.Value) any { return v.Interface() }

The Go type used by the proto.GetExtension and proto.SetExtension functions is determined by these methods, and is therefore equivalent to the Go type used to represent a protoreflect.Value. See the protoreflect.Value documentation for more details.

NewMessageType creates a new MessageType with the provided descriptor.

MessageTypes created by this package are equal if their descriptors are equal. That is, if md1 == md2, then NewMessageType(md1) == NewMessageType(md2).

A Message is a dynamically constructed protocol buffer message.

Message implements the google.golang.org/protobuf/proto.Message interface, and may be used with all standard proto package functions such as Marshal, Unmarshal, and so forth.

Message also implements the protoreflect.Message interface. See the protoreflect package documentation for that interface for how to get and set fields and otherwise interact with the contents of a Message.

Reflection API functions which construct messages, such as NewField, return new dynamic messages of the appropriate type. Functions which take messages, such as Set for a message-value field, will accept any message with a compatible type.

Operations which modify a Message are not safe for concurrent use.

NewMessage creates a new message with the provided descriptor.

Descriptor returns the message descriptor.

Mutable returns a mutable reference to a repeated, map, or message field. See protoreflect.Message for details.

New returns a newly allocated empty message with the same descriptor. See protoreflect.Message for details.

NewField returns a new value for assignable to the field of a given descriptor. See protoreflect.Message for details.

func (m *Message) ProtoMessage()

ProtoMessage implements the legacy message interface.

ProtoMethods is an internal detail of the protoreflect.Message interface. Users should never call this directly.

func (m *Message) Reset()

Reset clears the message to be empty, but preserves the dynamic message type.

String returns a string representation of a message.

Type returns the message type.

WhichOneof reports which field in a oneof is populated, returning nil if none are populated. See protoreflect.Message for details.

A Types is a collection of dynamically constructed descriptors. Its methods are safe for concurrent use.

Types implements protoregistry.MessageTypeResolver and protoregistry.ExtensionTypeResolver. A Types may be used as a google.golang.org/protobuf/proto.UnmarshalOptions.Resolver.

NewTypes creates a new Types registry with the provided files. The Files registry is retained, and changes to Files will be reflected in Types. It is not safe to concurrently change the Files while calling Types methods.

FindEnumByName looks up an enum by its full name; e.g., "google.protobuf.Field.Kind".

This returns (nil, protoregistry.NotFound) if not found.

FindExtensionByName looks up an 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, protoregistry.NotFound) if not found.

FindExtensionByNumber looks up an extension field by the field number within some parent message, identified by full name.

This returns (nil, protoregistry.NotFound) if not found.

FindMessageByName looks up a message by its full name; e.g. "google.protobuf.Any".

This returns (nil, protoregistry.NotFound) if not found.

FindMessageByURL looks up a message by a URL identifier. See documentation on google.protobuf.Any.type_url for the URL format.

This returns (nil, protoregistry.NotFound) if not found.