dynamicpb
package
This package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
- Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
- Tagged version
Modules with tagged versions give importers more predictable builds.
- Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Open Source Insights
Documentation¶
Overview¶
Package dynamicpb creates protocol buffer messages using runtime type information.
Index¶
- func NewEnumType(desc protoreflect.EnumDescriptor) protoreflect.EnumType
- func NewExtensionType(desc protoreflect.ExtensionDescriptor) protoreflect.ExtensionType
- func NewMessageType(desc protoreflect.MessageDescriptor) protoreflect.MessageType
- type Message
- func (m *Message) Clear(fd protoreflect.FieldDescriptor)
- func (m *Message) Descriptor() protoreflect.MessageDescriptor
- func (m *Message) Get(fd protoreflect.FieldDescriptor) protoreflect.Value
- func (m *Message) GetUnknown() protoreflect.RawFields
- func (m *Message) Has(fd protoreflect.FieldDescriptor) bool
- func (m *Message) Interface() protoreflect.ProtoMessage
- func (m *Message) IsValid() bool
- func (m *Message) Mutable(fd protoreflect.FieldDescriptor) protoreflect.Value
- func (m *Message) New() protoreflect.Message
- func (m *Message) NewField(fd protoreflect.FieldDescriptor) protoreflect.Value
- func (m *Message) ProtoMessage()
- func (m *Message) ProtoMethods() *protoiface.Methods
- func (m *Message) ProtoReflect() protoreflect.Message
- func (m *Message) Range(f func(protoreflect.FieldDescriptor, protoreflect.Value) bool)
- func (m *Message) Reset()
- func (m *Message) Set(fd protoreflect.FieldDescriptor, v protoreflect.Value)
- func (m *Message) SetUnknown(r protoreflect.RawFields)
- func (m *Message) String() string
- func (m *Message) Type() protoreflect.MessageType
- func (m *Message) WhichOneof(od protoreflect.OneofDescriptor) protoreflect.FieldDescriptor
- type Types
- func (t *Types) FindEnumByName(name protoreflect.FullName) (protoreflect.EnumType, error)
- func (t *Types) FindExtensionByName(name protoreflect.FullName) (protoreflect.ExtensionType, error)
- func (t *Types) FindExtensionByNumber(message protoreflect.FullName, field protoreflect.FieldNumber) (protoreflect.ExtensionType, error)
- func (t *Types) FindMessageByName(name protoreflect.FullName) (protoreflect.MessageType, error)
- func (t *Types) FindMessageByURL(url string) (protoreflect.MessageType, error)
Constants¶
This section is empty.
Variables¶
This section is empty.
Functions¶
funcNewEnumType¶added inv1.25.0
func NewEnumType(descprotoreflect.EnumDescriptor)protoreflect.EnumType
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.
funcNewExtensionType¶
func NewExtensionType(descprotoreflect.ExtensionDescriptor)protoreflect.ExtensionType
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 functionsis determined by these methods, and is therefore equivalent to the Go typeused to represent a protoreflect.Value. See the protoreflect.Valuedocumentation for more details.
funcNewMessageType¶
func NewMessageType(descprotoreflect.MessageDescriptor)protoreflect.MessageType
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).
Types¶
typeMessage¶
type Message struct {// contains filtered or unexported fields}A Message is a dynamically constructed protocol buffer message.
Message implements thegoogle.golang.org/protobuf/proto.Message interface,and may be used with all standard proto package functionssuch as Marshal, Unmarshal, and so forth.
Message also implements theprotoreflect.Message interface.See theprotoreflect package documentation for that interface for how toget 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 takemessages, such as Set for a message-value field, will accept any messagewith a compatible type.
Operations which modify a Message are not safe for concurrent use.
funcNewMessage¶
func NewMessage(descprotoreflect.MessageDescriptor) *Message
NewMessage creates a new message with the provided descriptor.
func (*Message)Clear¶
func (m *Message) Clear(fdprotoreflect.FieldDescriptor)
Clear clears a field.Seeprotoreflect.Message for details.
func (*Message)Descriptor¶
func (m *Message) Descriptor()protoreflect.MessageDescriptor
Descriptor returns the message descriptor.
func (*Message)Get¶
func (m *Message) Get(fdprotoreflect.FieldDescriptor)protoreflect.Value
Get returns the value of a field.Seeprotoreflect.Message for details.
func (*Message)GetUnknown¶
func (m *Message) GetUnknown()protoreflect.RawFields
GetUnknown returns the raw unknown fields.Seeprotoreflect.Message for details.
func (*Message)Has¶
func (m *Message) Has(fdprotoreflect.FieldDescriptor)bool
Has reports whether a field is populated.Seeprotoreflect.Message for details.
func (*Message)Interface¶
func (m *Message) Interface()protoreflect.ProtoMessage
Interface returns the message.Seeprotoreflect.Message for details.
func (*Message)IsValid¶
IsValid reports whether the message is valid.Seeprotoreflect.Message for details.
func (*Message)Mutable¶
func (m *Message) Mutable(fdprotoreflect.FieldDescriptor)protoreflect.Value
Mutable returns a mutable reference to a repeated, map, or message field.Seeprotoreflect.Message for details.
func (*Message)New¶
func (m *Message) New()protoreflect.Message
New returns a newly allocated empty message with the same descriptor.Seeprotoreflect.Message for details.
func (*Message)NewField¶
func (m *Message) NewField(fdprotoreflect.FieldDescriptor)protoreflect.Value
NewField returns a new value for assignable to the field of a given descriptor.Seeprotoreflect.Message for details.
func (*Message)ProtoMessage¶added inv1.21.0
func (m *Message) ProtoMessage()
ProtoMessage implements the legacy message interface.
func (*Message)ProtoMethods¶
func (m *Message) ProtoMethods() *protoiface.Methods
ProtoMethods is an internal detail of theprotoreflect.Message interface.Users should never call this directly.
func (*Message)ProtoReflect¶
func (m *Message) ProtoReflect()protoreflect.Message
ProtoReflect implements theprotoreflect.ProtoMessage interface.
func (*Message)Range¶
func (m *Message) Range(f func(protoreflect.FieldDescriptor,protoreflect.Value)bool)
Range visits every populated field in undefined order.Seeprotoreflect.Message for details.
func (*Message)Reset¶added inv1.21.0
func (m *Message) Reset()
Reset clears the message to be empty, but preserves the dynamic message type.
func (*Message)Set¶
func (m *Message) Set(fdprotoreflect.FieldDescriptor, vprotoreflect.Value)
Set stores a value in a field.Seeprotoreflect.Message for details.
func (*Message)SetUnknown¶
func (m *Message) SetUnknown(rprotoreflect.RawFields)
SetUnknown sets the raw unknown fields.Seeprotoreflect.Message for details.
func (*Message)WhichOneof¶
func (m *Message) WhichOneof(odprotoreflect.OneofDescriptor)protoreflect.FieldDescriptor
WhichOneof reports which field in a oneof is populated, returning nil if none are populated.Seeprotoreflect.Message for details.
typeTypes¶added inv1.31.0
type Types struct {// contains filtered or unexported fields}A Types is a collection of dynamically constructed descriptors.Its methods are safe for concurrent use.
Types implementsprotoregistry.MessageTypeResolver andprotoregistry.ExtensionTypeResolver.A Types may be used as agoogle.golang.org/protobuf/proto.UnmarshalOptions.Resolver.
funcNewTypes¶added inv1.31.0
func NewTypes(f *protoregistry.Files) *Types
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.
func (*Types)FindEnumByName¶added inv1.31.0
func (t *Types) FindEnumByName(nameprotoreflect.FullName) (protoreflect.EnumType,error)
FindEnumByName looks up an enum by its full name;e.g., "google.protobuf.Field.Kind".
This returns (nil,protoregistry.NotFound) if not found.
func (*Types)FindExtensionByName¶added inv1.31.0
func (t *Types) FindExtensionByName(nameprotoreflect.FullName) (protoreflect.ExtensionType,error)
FindExtensionByName looks up an extension field by the field's full name.Note that this is the full name of the field as determined bywhere the extension is declared and is unrelated to the full name of themessage being extended.
This returns (nil,protoregistry.NotFound) if not found.
func (*Types)FindExtensionByNumber¶added inv1.31.0
func (t *Types) FindExtensionByNumber(messageprotoreflect.FullName, fieldprotoreflect.FieldNumber) (protoreflect.ExtensionType,error)
FindExtensionByNumber looks up an extension field by the field numberwithin some parent message, identified by full name.
This returns (nil,protoregistry.NotFound) if not found.
func (*Types)FindMessageByName¶added inv1.31.0
func (t *Types) FindMessageByName(nameprotoreflect.FullName) (protoreflect.MessageType,error)
FindMessageByName looks up a message by its full name;e.g. "google.protobuf.Any".
This returns (nil,protoregistry.NotFound) if not found.
func (*Types)FindMessageByURL¶added inv1.31.0
func (t *Types) FindMessageByURL(urlstring) (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,protoregistry.NotFound) if not found.
Source Files