proto

package
Version: v0.0.0-...-e56ba34 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 5, 2022 License: Apache-2.0 Imports: 18 Imported by: 25

Documentation

Overview

Package proto contains protobuf-related utilities.

Index

Constants

This section is empty.

Variables

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

Enum value maps for TextPBFieldFormat.

View Source
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.

View Source
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.

View Source
var File_go_chromium_org_luci_common_proto_options_proto protoreflect.FileDescriptor

Functions

func FixFieldMasksBeforeUnmarshal

func FixFieldMasksBeforeUnmarshal(jsonMessage []byte, messageType reflect.Type) ([]byte, error)

FixFieldMasksBeforeUnmarshal reads FieldMask fields from a JSON-encoded message, parses them as a string according to https://github.com/protocolbuffers/protobuf/blob/ec1a70913e5793a7d0a7b5fbf7e0e4f75409dd41/src/google/protobuf/field_mask.proto#L180 and converts them to a JSON serialization format that Golang Protobuf library can unmarshal from. It is a workaround for https://github.com/golang/protobuf/issues/745.

This function is a reverse of FixFieldMasksAfterMarshal.

messageType must be a struct, not a struct pointer.

WARNING: AVOID. LIKELY BUGGY, see https://crbug.com/1028915.

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 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 deprecated

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) Enum

func (TextPBFieldFormat) EnumDescriptor deprecated

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

Deprecated: Use TextPBFieldFormat.Descriptor instead.

func (TextPBFieldFormat) Number

func (TextPBFieldFormat) String

func (x TextPBFieldFormat) String() string

func (TextPBFieldFormat) Type

func (*TextPBFieldFormat) UnmarshalJSON deprecated

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

Deprecated: Do not use.

Directories

Path Synopsis
Package config contains luci-config protobuf definitions.
Package config contains luci-config protobuf definitions.
Package examples shows how to design protos which adhere to the Google Cloud API design guide.
Package examples shows how to design protos which adhere to the Google Cloud API design guide.
Package gerritpb contains Gerrit service definition.
Package gerritpb contains Gerrit service definition.
Package git contains Git-related protobuf definitions.
Package git contains Git-related protobuf definitions.
Package gitiles contains Gitiles service definition.
Package gitiles contains Gitiles service definition.
mock_gitiles
Package mock_gitiles is a generated GoMock package.
Package mock_gitiles is a generated GoMock package.
google
descutil
Package descutil contains utility functions for protobuf descriptor messages.
Package descutil contains utility functions for protobuf descriptor messages.
Package mask provides utility functions for google protobuf field mask
Package mask provides utility functions for google protobuf field mask
Package paged implements a helper for making paginated Datastore queries.
Package paged implements a helper for making paginated Datastore queries.
Package protoc contains helpers for running `protoc` using protos files stored in the Go source tree.
Package protoc contains helpers for running `protoc` using protos files stored in the Go source tree.
Package protowalk contains routines for efficiently walking proto messages, focusing on the ability to react to field annotations.
Package protowalk contains routines for efficiently walking proto messages, focusing on the ability to react to field annotations.
Package realms contains LUCI Realms protobuf definitions.
Package realms contains LUCI Realms protobuf definitions.
Package reflectutil has an arbitrary assortment of helpers for dealing with protobuf reflection including:
Package reflectutil has an arbitrary assortment of helpers for dealing with protobuf reflection including:
Package srcman contains source manifest protobuf definitions.
Package srcman contains source manifest protobuf definitions.
Package structmask implements a functionality similar to google.protobuf.FieldMask, but which applies only to google.protobuf.Struct.
Package structmask implements a functionality similar to google.protobuf.FieldMask, but which applies only to google.protobuf.Struct.
Package textpb can reformat text protos to be prettier.
Package textpb can reformat text protos to be prettier.
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL