proto

Documentation

Overview

Package proto contains protobuf-related utilities.

Index

• Variables
• func MatcherEqual(m proto.Message) gomock.Matcher
• func ParseMultilineStrings(text string) (string, error)
• func StableHash(h hash.Hash, m proto.Message) error
• func UnmarshalJSONWithNonStandardFieldMasks(buf []byte, msg proto.Message) error
• func UnmarshalTextML(s string, pb proto.Message) error
• type Metadata
  • func (*Metadata) Descriptor() ([]byte, []int)
  • func (x *Metadata) GetDocUrl() string
  • func (*Metadata) ProtoMessage()
  • func (x *Metadata) ProtoReflect() protoreflect.Message
  • func (x *Metadata) Reset()
  • func (x *Metadata) String() string
• type TextPBFieldFormat
  • func (TextPBFieldFormat) Descriptor() protoreflect.EnumDescriptor
  • func (x TextPBFieldFormat) Enum() *TextPBFieldFormat
  • func (TextPBFieldFormat) EnumDescriptor() ([]byte, []int)
  • func (x TextPBFieldFormat) Number() protoreflect.EnumNumber
  • func (x TextPBFieldFormat) String() string
  • func (TextPBFieldFormat) Type() protoreflect.EnumType
  • func (x *TextPBFieldFormat) UnmarshalJSON(b []byte) error

Variables

var (
	TextPBFieldFormat_name = map[int32]string{
		0: "DEFAULT",
		1: "JSON",
	}
	TextPBFieldFormat_value = map[string]int32{
		"DEFAULT": 0,
		"JSON":    1,
	}
)

Enum value maps for TextPBFieldFormat.

var (
	// Used by lucicfg and textpb package to pretty-print text protos.
	//
	// Usage:
	//
	//	import "go.chromium.org/luci/common/proto/options.proto";
	//
	//	message MyMessage {
	//	  string my_field = 1 [(luci.text_pb_format) = JSON];
	//	}
	//
	// optional luci.TextPBFieldFormat text_pb_format = 73701;
	E_TextPbFormat = &file_go_chromium_org_luci_common_proto_options_proto_extTypes[1]
	// Used by lucicfg to skip comparing fields when making semantic comparison.
	//
	// Usage:
	//
	//	import "go.chromium.org/luci/common/proto/options.proto";
	//
	//	message MyMessage {
	//	  string my_field = 1 [(luci.lucicfg_ignore) = true];
	//	}
	//
	// optional bool lucicfg_ignore = 73702;
	E_LucicfgIgnore = &file_go_chromium_org_luci_common_proto_options_proto_extTypes[2]
)

Extension fields to descriptorpb.FieldOptions.

var (
	// Used by lucicfg to populate headers of generated text proto files.
	//
	// Usage:
	//
	//	import "go.chromium.org/luci/common/proto/options.proto";
	//
	//	option (luci.file_metadata) = {
	//	  doc_url: "https://example.com/schema.md";
	//	};
	//
	// optional luci.Metadata file_metadata = 73700;
	E_FileMetadata = &file_go_chromium_org_luci_common_proto_options_proto_extTypes[0]
)

Extension fields to descriptorpb.FileOptions.

var File_go_chromium_org_luci_common_proto_options_proto protoreflect.FileDescriptor

Functions

func MatcherEqual

func MatcherEqual(m proto.Message) gomock.Matcher

MatcherEqual returns a matcher that matches on protobuf equality. Note: reflect.DeepEqual can't be used with protobuf messages as it may yield unexpected results.

func ParseMultilineStrings

func ParseMultilineStrings(text string) (string, error)

ParseMultilineStrings looks for bash-style heredocs and replaces them with single-line text-proto-escaped strings.

This looks line by line for /<<\s*([_a-zA-Z]+)\s*$/. If this is found, the scanner then looks until it finds /^\s*\1\s*$/. Every line between these is joined like "\n".join(lines), and then printed back as an escaped proto string. The scanner then loops back to its initial state.

Not that nothing special needs to be done for e.g.

some_key: "string with << angles"

Such a line would be left alone, because the trailing quote (which is mandatory in text proto) cause the starting regex to not match.

For convenience, the inner lines will be treated with the equivalent of python's `textwrap.dedent`; any common leading whitespace that occurs on every line will be removed. Although both tabs and spaces count as whitespace, they are not equivalent (i.e. only exactly-matching whitespace prefixes count)

The only error this may return is if there's an open heredoc without a matching close marker.

Example:

  this: <<EOF
	   would
	   turn \ninto
      a "single"
    line
  EOF

Turns into the same as:

this: "would\nturn \\ninto\n  a \"single\"\nline"

func StableHash

func StableHash(h hash.Hash, m proto.Message) error

StableHash does a deterministic and ordered walk over the proto message `m`, feeding each field into `h`.

This is useful to produce stable, deterministic hashes of proto messages where comparison of messages generated from different sources or runtimes is important.

Because of this, `m` may not contain any unknown fields, since there is no way to canonicalize them without the message definition. If the message has any unknown fields, this function returns an error. NOTE: - The hash value can ONLY be used for backward compatible protobuf change to determine if the protobuf message is different. If two protobuf specs are incompatible, their value MUST NOT be compared with each other and not promised to be different even their messages are clearly different. - google.protobuf.Any is supported via Any.UnmarshalNew: if the message is not registered, this returns an error. - 0-valued scalar fields are not distinguished from absent fields.

func UnmarshalJSONWithNonStandardFieldMasks

func UnmarshalJSONWithNonStandardFieldMasks(buf []byte, msg proto.Message) error

UnmarshalJSONWithNonStandardFieldMasks unmarshals a JSONPB message that has google.protobuf.FieldMask inside that either uses non-standard field mask semantics (like paths that contains `*`) or uses non-standard object encoding (e.g. `"mask": {"paths": ["a", "b"]}` instead of `"mask": "a,b"`), or both.

Such field masks are not supported by the standard JSONPB unmarshaller. If your message uses only standard field masks (i.e. only containing paths like `a.b.c` with not extra syntax, with the field mask serialized as a string), use the standard JSON unmarshaler from google.golang.org/protobuf/encoding/protojson package.

Using non-standard field masks is discouraged. Deserializing them has significant performance overhead. This function is also more likely to break in the future (since it uses deprecated libraries under the hood).

Giant name of this function is a hint that it should not be used.

func UnmarshalTextML

func UnmarshalTextML(s string, pb proto.Message) error

UnmarshalTextML behaves the same as proto.UnmarshalText, except that it allows for multiline strings in the manner of ParseMultilineStrings.

Types

type Metadata

type Metadata struct {

	// URL to a human-readable proto schema definition doc.
	DocUrl *string `protobuf:"bytes,1,opt,name=doc_url,json=docUrl" json:"doc_url,omitempty"`
	// contains filtered or unexported fields
}

func (*Metadata) Descriptor

func (*Metadata) Descriptor() ([]byte, []int)

Deprecated: Use Metadata.ProtoReflect.Descriptor instead.

func (*Metadata) GetDocUrl

func (x *Metadata) GetDocUrl() string

func (*Metadata) ProtoMessage

func (*Metadata) ProtoMessage()

func (*Metadata) ProtoReflect

func (x *Metadata) ProtoReflect() protoreflect.Message

func (*Metadata) Reset

func (x *Metadata) Reset()

func (*Metadata) String

func (x *Metadata) String() string

type TextPBFieldFormat

type TextPBFieldFormat int32

Type of formatting to apply to a primitive field when converting a message to TextPB

const (
	// The default formatting for TextPB for the field
	TextPBFieldFormat_DEFAULT TextPBFieldFormat = 0
	// Interpret the field's value as a JSON object and format it across multiple
	// lines, valid only for string fields
	TextPBFieldFormat_JSON TextPBFieldFormat = 1
)

func (TextPBFieldFormat) Descriptor

func (TextPBFieldFormat) Descriptor() protoreflect.EnumDescriptor

func (TextPBFieldFormat) Enum

func (x TextPBFieldFormat) Enum() *TextPBFieldFormat

func (TextPBFieldFormat) EnumDescriptor

func (TextPBFieldFormat) EnumDescriptor() ([]byte, []int)

Deprecated: Use TextPBFieldFormat.Descriptor instead.

func (TextPBFieldFormat) Number

func (x TextPBFieldFormat) Number() protoreflect.EnumNumber

func (TextPBFieldFormat) String

func (x TextPBFieldFormat) String() string

func (TextPBFieldFormat) Type

func (TextPBFieldFormat) Type() protoreflect.EnumType

func (*TextPBFieldFormat) UnmarshalJSON

func (x *TextPBFieldFormat) UnmarshalJSON(b []byte) error

Deprecated: Do not use.