proto

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