const (WireVarint     = 0WireFixed32    = 5WireFixed64    = 1WireBytes      = 2WireStartGroup = 3WireEndGroup   = 4)

const (ProtoPackageIsVersion1 =trueProtoPackageIsVersion2 =trueProtoPackageIsVersion3 =trueProtoPackageIsVersion4 =true)

var (// Deprecated: No longer returned.ErrNil =errors.New("proto: Marshal called with nil")// Deprecated: No longer returned.ErrTooLarge =errors.New("proto: message encodes to over 2 GB")// Deprecated: No longer returned.ErrInternalBadWireType =errors.New("proto: internal error: bad wiretype for oneof"))

var ErrMissingExtension =errors.New("proto: missing extension")

funcBool¶

func Bool(vbool) *bool

Bool stores v in a new bool value and returns a pointer to it.

funcClearAllExtensions¶

func ClearAllExtensions(mMessage)

ClearAllExtensions clears all extensions from m.This includes populated fields and unknown fields in the extension range.

funcClearExtension¶

func ClearExtension(mMessage, xt *ExtensionDesc)

ClearExtension removes the extension field from meither as an explicitly populated field or as an unknown field.

funcCompactText¶

func CompactText(wio.Writer, mMessage)error

CompactText writes the compact proto text format of m to w.

funcCompactTextString¶

func CompactTextString(mMessage)string

CompactTextString returns a compact proto text formatted string of m.

funcDecodeVarint¶

func DecodeVarint(b []byte) (uint64,int)

DecodeVarint parses a varint encoded integer from b,returning the integer value and the length of the varint.It returns (0, 0) if there is a parse error.

funcDiscardUnknown¶

func DiscardUnknown(mMessage)

DiscardUnknown recursively discards all unknown fields from this messageand all embedded messages.

When unmarshaling a message with unrecognized fields, the tags and valuesof such fields are preserved in the Message. This allows a later call tomarshal to be able to produce a message that continues to have thoseunrecognized fields. To avoid this, DiscardUnknown is used toexplicitly clear the unknown fields after unmarshaling.

funcEncodeVarint¶

func EncodeVarint(vuint64) []byte

EncodeVarint returns the varint encoded bytes of v.

funcEqual¶

func Equal(x, yMessage)bool

Equal reports whether two messages are equal.If two messages marshal to the same bytes under deterministic serialization,then Equal is guaranteed to report true.

Two messages are equal if they are the same protobuf message type,have the same set of populated known and extension field values,and the same set of unknown fields values.

Scalar values are compared with the equivalent of the == operator in Go,except bytes values which are compared using bytes.Equal andfloating point values which specially treat NaNs as equal.Message values are compared by recursively calling Equal.Lists are equal if each element value is also equal.Maps are equal if they have the same set of keys, where the pair of valuesfor each key is also equal.

funcFloat32¶

func Float32(vfloat32) *float32

Float32 stores v in a new float32 value and returns a pointer to it.

funcFloat64¶

func Float64(vfloat64) *float64

Float64 stores v in a new float64 value and returns a pointer to it.

funcGetExtension¶

func GetExtension(mMessage, xt *ExtensionDesc) (interface{},error)

GetExtension retrieves a proto2 extended field from m.

If the descriptor is type complete (i.e., ExtensionDesc.ExtensionType is non-nil),then GetExtension parses the encoded field and returns a Go value of the specified type.If the field is not present, then the default value is returned (if one is specified),otherwise ErrMissingExtension is reported.

If the descriptor is type incomplete (i.e., ExtensionDesc.ExtensionType is nil),then GetExtension returns the raw encoded bytes for the extension field.

funcGetExtensions¶

func GetExtensions(mMessage, xts []*ExtensionDesc) ([]interface{},error)

GetExtensions returns a list of the extensions values present in m,corresponding with the provided list of extension descriptors, xts.If an extension is missing in m, the corresponding value is nil.

funcHasExtension¶

func HasExtension(mMessage, xt *ExtensionDesc) (hasbool)

HasExtension reports whether the extension field is present in meither as an explicitly populated field or as an unknown field.

funcInt32¶

func Int32(vint32) *int32

Int32 stores v in a new int32 value and returns a pointer to it.

funcInt64¶

func Int64(vint64) *int64

Int64 stores v in a new int64 value and returns a pointer to it.

funcMarshal¶

func Marshal(mMessage) ([]byte,error)

Marshal returns the wire-format encoding of m.

funcMarshalText¶

func MarshalText(wio.Writer, mMessage)error

MarshalText writes the proto text format of m to w.

funcMarshalTextString¶

func MarshalTextString(mMessage)string

MarshalTextString returns a proto text formatted string of m.

funcMerge¶

func Merge(dst, srcMessage)

Merge merges src into dst, which must be messages of the same type.

Populated scalar fields in src are copied to dst, while populatedsingular messages in src are merged into dst by recursively calling Merge.The elements of every list field in src is appended to the correspondedlist fields in dst. The entries of every map field in src is copied intothe corresponding map field in dst, possibly replacing existing entries.The unknown fields of src are appended to the unknown fields of dst.

funcMessageReflect¶added inv1.4.0

func MessageReflect(mMessage)protoreflect.Message

MessageReflect returns a reflective view for a message.It returns nil if m is nil.

funcMessageV1¶added inv1.4.0

func MessageV1(mGeneratedMessage)protoiface.MessageV1

MessageV1 converts either a v1 or v2 message to a v1 message.It returns nil if m is nil.

funcMessageV2¶added inv1.4.0

func MessageV2(mGeneratedMessage)protoV2.Message

MessageV2 converts either a v1 or v2 message to a v2 message.It returns nil if m is nil.

funcSetDefaults¶

func SetDefaults(mMessage)

SetDefaults sets unpopulated scalar fields to their default values.Fields within a oneof are not set even if they have a default value.SetDefaults is recursively called upon any populated message fields.

funcSetExtension¶

func SetExtension(mMessage, xt *ExtensionDesc, v interface{})error

SetExtension sets an extension field in m to the provided value.

funcSize¶

func Size(mMessage)int

Size returns the size in bytes of the wire-format encoding of m.

funcSizeVarint¶

func SizeVarint(vuint64)int

SizeVarint returns the length of the varint encoded bytes of v.This is equal to len(EncodeVarint(v)).

funcString¶

func String(vstring) *string

String stores v in a new string value and returns a pointer to it.

funcUint32¶

func Uint32(vuint32) *uint32

Uint32 stores v in a new uint32 value and returns a pointer to it.

funcUint64¶

func Uint64(vuint64) *uint64

Uint64 stores v in a new uint64 value and returns a pointer to it.

funcUnmarshal¶

func Unmarshal(b []byte, mMessage)error

Unmarshal parses a wire-format message in b and places the decoded results in m.

Unmarshal resets m before starting to unmarshal, so any existing data in m is alwaysremoved. Use UnmarshalMerge to preserve and append to existing data.

funcUnmarshalMerge¶

func UnmarshalMerge(b []byte, mMessage)error

UnmarshalMerge parses a wire-format message in b and places the decoded results in m.

funcUnmarshalText¶

func UnmarshalText(sstring, mMessage)error

UnmarshalText parses a proto text formatted string into m.

typeBuffer¶

type Buffer struct {// contains filtered or unexported fields}

Buffer is a buffer for encoding and decoding the protobuf wire format.It may be reused between invocations to reduce memory usage.

func NewBuffer(buf []byte) *Buffer

func (b *Buffer) Bytes() []byte

func (*Buffer) DebugPrint(sstring, b []byte)

func (b *Buffer) DecodeFixed32() (uint64,error)

func (b *Buffer) DecodeFixed64() (uint64,error)

func (b *Buffer) DecodeGroup(mMessage)error

func (b *Buffer) DecodeMessage(mMessage)error

func (b *Buffer) DecodeRawBytes(allocbool) ([]byte,error)

func (b *Buffer) DecodeStringBytes() (string,error)

func (b *Buffer) DecodeVarint() (uint64,error)

func (b *Buffer) DecodeZigzag32() (uint64,error)

func (b *Buffer) DecodeZigzag64() (uint64,error)

func (b *Buffer) EncodeFixed32(vuint64)error

func (b *Buffer) EncodeFixed64(vuint64)error

func (b *Buffer) EncodeMessage(mMessage)error

func (b *Buffer) EncodeRawBytes(v []byte)error

func (b *Buffer) EncodeStringBytes(vstring)error

func (b *Buffer) EncodeVarint(vuint64)error

func (b *Buffer) EncodeZigzag32(vuint64)error

func (b *Buffer) EncodeZigzag64(vuint64)error

func (b *Buffer) Marshal(mMessage)error

func (b *Buffer) Reset()

func (b *Buffer) SetBuf(buf []byte)

func (b *Buffer) SetDeterministic(deterministicbool)

func (b *Buffer) Unmarshal(mMessage)error

func (b *Buffer) Unread() []byte

typeExtensionDesc¶

type ExtensionDesc =protoimpl.ExtensionInfo

ExtensionDesc represents an extension descriptor andis used to interact with an extension field in a message.

Variables of this type are generated in code by protoc-gen-go.

func ExtensionDescs(mMessage) ([]*ExtensionDesc,error)

typeExtensionRange¶

type ExtensionRange =protoiface.ExtensionRangeV1

ExtensionRange represents a range of message extensions.Used in code generated by protoc-gen-go.

typeGeneratedEnum¶added inv1.4.0

type GeneratedEnum interface{}

GeneratedEnum is any enum type generated by protoc-gen-gowhich is a named int32 kind.This type exists for documentation purposes.

typeGeneratedMessage¶added inv1.4.0

type GeneratedMessage interface{}

GeneratedMessage is any message type generated by protoc-gen-gowhich is a pointer to a named struct kind.This type exists for documentation purposes.

typeMessage¶

type Message =protoiface.MessageV1

Message is a protocol buffer message.

This is the v1 version of the message interface and is marginally betterthan an empty interface as it lacks any method to programatically interactwith the contents of the message.

A v2 message is declared in "google.golang.org/protobuf/proto".Message andexposes protobuf reflection as a first-class feature of the interface.

To convert a v1 message to a v2 message, use the MessageV2 function.To convert a v2 message to a v1 message, use the MessageV1 function.

func Clone(srcMessage)Message

typeParseError¶

type ParseError struct {Messagestring// Deprecated: Do not use.Line, Offsetint}

ParseError is returned by UnmarshalText.

func (e *ParseError) Error()string

typeRequiredNotSetError¶

type RequiredNotSetError struct {// contains filtered or unexported fields}

RequiredNotSetError is an error type returned whenmarshaling or unmarshaling a message with missing required fields.

func (e *RequiredNotSetError) Error()string

func (e *RequiredNotSetError) RequiredNotSet()bool

typeTextMarshaler¶

type TextMarshaler struct {Compactbool// use compact text format (one line)ExpandAnybool// expand google.protobuf.Any messages of known types}

TextMarshaler is a configurable text format marshaler.

func (tm *TextMarshaler) Marshal(wio.Writer, mMessage)error

func (tm *TextMarshaler) Text(mMessage)string