Package: google.golang.org/protobuf/encoding/protojson

package protojson Import Path google.golang.org/protobuf/encoding/protojson (on go.dev) Dependency Relation imports 19 packages, and imported by one package

Involved Source Files decode.go d➜ doc.go Package protojson marshals and unmarshals protocol buffer messages as JSON format. It follows the guide at https://developers.google.com/protocol-buffers/docs/proto3#json. This package produces a different output than the standard "encoding/json" package, which does not operate correctly on protocol buffer messages. encode.go well_known_types.go

Package-Level Type Names (total 7, in which 2 are exported)

/* sort exporteds by: alphabet | popularity */

type MarshalOptions (struct) MarshalOptions is a configurable JSON format marshaler. Fields (total 8, all are exported) AllowPartial bool AllowPartial allows messages that have missing required fields to marshal without returning an error. If AllowPartial is false (the default), Marshal will return error if there are any missing required fields. EmitUnpopulated bool EmitUnpopulated specifies whether to emit unpopulated fields. It does not emit unpopulated oneof fields or unpopulated extension fields. The JSON value emitted for unpopulated fields are as follows: ╔═══════╤════════════════════════════╗ ║ JSON │ Protobuf field ║ ╠═══════╪════════════════════════════╣ ║ false │ proto3 boolean fields ║ ║ 0 │ proto3 numeric fields ║ ║ "" │ proto3 string/bytes fields ║ ║ null │ proto2 scalar fields ║ ║ null │ message fields ║ ║ [] │ list fields ║ ║ {} │ map fields ║ ╚═══════╧════════════════════════════╝ Indent string Indent specifies the set of indentation characters to use in a multiline formatted output such that every entry is preceded by Indent and terminated by a newline. If non-empty, then Multiline is treated as true. Indent can only be composed of space or tab characters. Multiline bool Multiline specifies whether the marshaler should format the output in indented-form with every textual element on a new line. If Indent is an empty string, then an arbitrary indent is chosen. NoUnkeyedLiterals pragma.NoUnkeyedLiterals Resolver interface{protoregistry.ExtensionTypeResolver; protoregistry.MessageTypeResolver} Resolver is used for looking up types when expanding google.protobuf.Any messages. If nil, this defaults to using protoregistry.GlobalTypes. UseEnumNumbers bool UseEnumNumbers emits enum values as numbers. UseProtoNames bool UseProtoNames uses proto field name instead of lowerCamelCase name in JSON field names. Methods (total 3, in which 2 are exported) ( T) Format(m proto.Message) string Format formats the message as a string. This method is only intended for human consumption and ignores errors. Do not depend on the output being stable. It may change over time across different versions of the program. ( T) Marshal(m proto.Message) ([]byte, error) Marshal marshals the given proto.Message in the JSON format using options in MarshalOptions. Do not depend on the output being stable. It may change over time across different versions of the program. /* one unexported ... *//* one unexported: */ ( T) marshal(m proto.Message) ([]byte, error) marshal is a centralized function that all marshal operations go through. For profiling purposes, avoid changing the name of this function or introducing other code paths for marshal that do not go through this.

type UnmarshalOptions (struct) UnmarshalOptions is a configurable JSON format parser. Fields (total 4, all are exported) AllowPartial bool If AllowPartial is set, input for messages that will result in missing required fields will not return an error. DiscardUnknown bool If DiscardUnknown is set, unknown fields are ignored. NoUnkeyedLiterals pragma.NoUnkeyedLiterals Resolver interface{protoregistry.MessageTypeResolver; protoregistry.ExtensionTypeResolver} Resolver is used for looking up types when unmarshaling google.protobuf.Any messages or extension fields. If nil, this defaults to using protoregistry.GlobalTypes. Methods (total 2, in which 1 are exported) ( T) Unmarshal(b []byte, m proto.Message) error Unmarshal reads the given []byte and populates the given proto.Message using options in UnmarshalOptions object. It will clear the message first before setting the fields. If it returns an error, the given message may be partially set. /* one unexported ... *//* one unexported: */ ( T) unmarshal(b []byte, m proto.Message) error unmarshal is a centralized function that all unmarshal operations go through. For profiling purposes, avoid changing the name of this function or introducing other code paths for unmarshal that do not go through this.

/* 5 unexporteds ... *//* 5 unexporteds: */

type decoder (struct) Fields (total 8, in which 1 are exported) Decoder *json.Decoder /* 7 unexporteds ... *//* 7 unexporteds: */ Decoder.in []byte in contains the unconsumed input. Decoder.lastCall json.call lastCall is last method called, either readCall or peekCall. Initial value is readCall. Decoder.lastErr error lastErr contains the last read error. Decoder.lastToken json.Token lastToken contains the last read token. Decoder.openStack []json.Kind openStack is a stack containing ObjectOpen and ArrayOpen values. The top of stack represents the object or the array the current value is directly located in. Decoder.orig []byte orig is used in reporting line and column. opts UnmarshalOptions Methods (total 35, in which 4 are exported) ( T) Clone() *json.Decoder Clone returns a copy of the Decoder for use in reading ahead the next JSON object, array or other values without affecting current Decoder. ( T) Peek() (json.Token, error) Peek looks ahead and returns the next token kind without advancing a read. ( T) Position(idx int) (line int, column int) Position returns line and column number of given index of the original input. It will panic if index is out of range. ( T) Read() (json.Token, error) Read returns the next JSON token. It will return an error if there is no valid token. /* 31 unexporteds ... *//* 31 unexporteds: */ ( T) consume(n int) consume consumes n bytes of input and any subsequent whitespace. ( T) consumeBoolToken(b bool, size int) json.Token consumeBoolToken constructs a Token for a Bool kind with raw value derived from current d.in and given size. ( T) consumeStringToken(s string, size int) json.Token consumeStringToken constructs a Token for a String kind with raw value derived from current d.in and given size. ( T) consumeToken(kind json.Kind, size int) json.Token consumeToken constructs a Token for given Kind with raw value derived from current d.in and given size, and consumes the given size-lenght of it. ( T) currPos() int currPos returns the current index position of d.in from d.orig. ( T) findExtension(xtName pref.FullName) (pref.ExtensionType, error) findExtension returns protoreflect.ExtensionType from the resolver if found. ( T) isValueNext() bool isValueNext returns true if next type should be a JSON value: Null, Number, String or Bool. ( T) newError(pos int, f string, x ...interface{}) error newError returns an error object with position info. ( T) newSyntaxError(pos int, f string, x ...interface{}) error newSyntaxError returns an error with line and column information useful for syntax errors. ( T) parseNext() (json.Token, error) parseNext parses for the next JSON token. It returns a Token object for different types, except for Name. It does not handle whether the next token is in a valid sequence or not. ( T) parseString(in []byte) (string, int, error) ( T) skipJSONValue() error skipJSONValue parses a JSON value (null, boolean, string, number, object and array) in order to advance the read to the next JSON value. It relies on the decoder returning an error if the types are not in valid sequence. ( T) syntaxError(pos int, f string, x ...interface{}) error syntaxError returns a syntax error for given position. ( T) unexpectedTokenError(tok json.Token) error unexpectedTokenError returns a syntax error for the given unexpected token. ( T) unmarshalAny(m pref.Message) error ( T) unmarshalAnyValue(unmarshal unmarshalFunc, m pref.Message) error unmarshalAnyValue unmarshals the given custom-type message from the JSON object's "value" field. ( T) unmarshalDuration(m pref.Message) error ( T) unmarshalEmpty(pref.Message) error ( T) unmarshalFieldMask(m pref.Message) error ( T) unmarshalFields(m pref.Message, skipTypeURL bool) error unmarshalFields unmarshals the fields into the given protoreflect.Message. ( T) unmarshalKnownValue(m pref.Message) error ( T) unmarshalList(list pref.List, fd pref.FieldDescriptor) error ( T) unmarshalListValue(m pref.Message) error ( T) unmarshalMap(mmap pref.Map, fd pref.FieldDescriptor) error ( T) unmarshalMapKey(tok json.Token, fd pref.FieldDescriptor) (pref.MapKey, error) unmarshalMapKey converts given token of Name kind into a protoreflect.MapKey. A map key type is any integral or string type. ( T) unmarshalMessage(m pref.Message, skipTypeURL bool) error unmarshalMessage unmarshals a message into the given protoreflect.Message. ( T) unmarshalScalar(fd pref.FieldDescriptor) (pref.Value, error) unmarshalScalar unmarshals to a scalar/enum protoreflect.Value specified by the given FieldDescriptor. ( T) unmarshalSingular(m pref.Message, fd pref.FieldDescriptor) error unmarshalSingular unmarshals to the non-repeated field specified by the given FieldDescriptor. ( T) unmarshalStruct(m pref.Message) error ( T) unmarshalTimestamp(m pref.Message) error ( T) unmarshalWrapperType(m pref.Message) error As Inputs Of (at least one unexported) /* at least one unexported ... *//* at least one unexported: */ func findTypeURL(d decoder) (json.Token, error)

type encoder (struct) Fields (total 6, in which 1 are exported) Encoder *json.Encoder /* 5 unexporteds ... *//* 5 unexporteds: */ Encoder.indent string Encoder.indents []byte Encoder.lastKind json.kind Encoder.out []byte opts MarshalOptions Methods (total 29, in which 12 are exported) ( T) Bytes() []byte Bytes returns the content of the written bytes. ( T) EndArray() EndArray writes out the ']' symbol. ( T) EndObject() EndObject writes out the '}' symbol. ( T) StartArray() StartArray writes out the '[' symbol. ( T) StartObject() StartObject writes out the '{' symbol. ( T) WriteBool(b bool) WriteBool writes out the given boolean value. ( T) WriteFloat(n float64, bitSize int) WriteFloat writes out the given float and bitSize in JSON number value. ( T) WriteInt(n int64) WriteInt writes out the given signed integer in JSON number value. ( T) WriteName(s string) error WriteName writes out the given string in JSON string value and the name separator ':'. Returns error if input string contains invalid UTF-8, which should not be likely as protobuf field names should be valid. ( T) WriteNull() WriteNull writes out the null value. ( T) WriteString(s string) error WriteString writes out the given string in JSON string value. Returns error if input string contains invalid UTF-8. ( T) WriteUint(n uint64) WriteUint writes out the given unsigned integer in JSON number value. /* 17 unexporteds ... *//* 17 unexporteds: */ ( T) marshalAny(m pref.Message) error ( T) marshalDuration(m pref.Message) error ( T) marshalEmpty(pref.Message) error ( T) marshalExtensions(m pref.Message) error marshalExtensions marshals extension fields. ( T) marshalFieldMask(m pref.Message) error ( T) marshalFields(m pref.Message) error marshalFields marshals the fields in the given protoreflect.Message. ( T) marshalKnownValue(m pref.Message) error ( T) marshalList(list pref.List, fd pref.FieldDescriptor) error marshalList marshals the given protoreflect.List. ( T) marshalListValue(m pref.Message) error ( T) marshalMap(mmap pref.Map, fd pref.FieldDescriptor) error marshalMap marshals given protoreflect.Map. ( T) marshalMessage(m pref.Message) error marshalMessage marshals the given protoreflect.Message. ( T) marshalSingular(val pref.Value, fd pref.FieldDescriptor) error marshalSingular marshals the given non-repeated field value. This includes all scalar types, enums, messages, and groups. ( T) marshalStruct(m pref.Message) error ( T) marshalTimestamp(m pref.Message) error ( T) marshalValue(val pref.Value, fd pref.FieldDescriptor) error marshalValue marshals the given protoreflect.Value. ( T) marshalWrapperType(m pref.Message) error ( T) prepareNext(next json.kind) prepareNext adds possible comma and indentation for the next value based on last type and indent option. It also updates lastKind to next.

type mapEntry (struct) Fields (total 2, neither is exported) /* 2 unexporteds ... *//* 2 unexporteds: */ key pref.MapKey value pref.Value As Inputs Of (at least one unexported) /* at least one unexported ... *//* at least one unexported: */ func sortMap(keyKind pref.Kind, values []mapEntry)

type marshalFunc (func) As Outputs Of (at least one unexported) /* at least one unexported ... *//* at least one unexported: */ func wellKnownTypeMarshaler(name pref.FullName) marshalFunc

type unmarshalFunc (func) As Outputs Of (at least one unexported) /* at least one unexported ... *//* at least one unexported: */ func wellKnownTypeUnmarshaler(name pref.FullName) unmarshalFunc

Package-Level Functions (total 18, in which 3 are exported)

func Format(m proto.Message) string Format formats the message as a multiline string. This function is only intended for human consumption and ignores errors. Do not depend on the output being stable. It may change over time across different versions of the program.

func Marshal(m proto.Message) ([]byte, error) Marshal writes the given proto.Message in JSON format using default options. Do not depend on the output being stable. It may change over time across different versions of the program.

func Unmarshal(b []byte, m proto.Message) error Unmarshal reads the given []byte into the given proto.Message.

/* 15 unexporteds ... *//* 15 unexporteds: */

func findTypeURL(d decoder) (json.Token, error) findTypeURL returns the token for the "@type" field value from the given JSON bytes. It is expected that the given bytes start with json.ObjectOpen. It returns errEmptyObject if the JSON object is empty or errMissingType if @type field does not exist. It returns other error if the @type field is not valid or other decoding issues.

func getFloat(tok json.Token, bitSize int) (pref.Value, bool)

func getInt(tok json.Token, bitSize int) (pref.Value, bool)

func getUint(tok json.Token, bitSize int) (pref.Value, bool)

func isKnownValue(fd pref.FieldDescriptor) bool

func isNullValue(fd pref.FieldDescriptor) bool

func parseDuration(input string) (int64, int32, bool) parseDuration parses the given input string for seconds and nanoseconds value for the Duration JSON format. The format is a decimal number with a suffix 's'. It can have optional plus/minus sign. There needs to be at least an integer or fractional part. Fractional part is limited to 9 digits only for nanoseconds precision, regardless of whether there are trailing zero digits. Example values are 1s, 0.1s, 1.s, .1s, +1s, -1s, -.1s.

func sortMap(keyKind pref.Kind, values []mapEntry) sortMap orders list based on value of key field for deterministic ordering.

func unmarshalBytes(tok json.Token) (pref.Value, bool)

func unmarshalEnum(tok json.Token, fd pref.FieldDescriptor) (pref.Value, bool)

func unmarshalFloat(tok json.Token, bitSize int) (pref.Value, bool)

func unmarshalInt(tok json.Token, bitSize int) (pref.Value, bool)

func unmarshalUint(tok json.Token, bitSize int) (pref.Value, bool)

func wellKnownTypeMarshaler(name pref.FullName) marshalFunc wellKnownTypeMarshaler returns a marshal function if the message type has specialized serialization behavior. It returns nil otherwise.

func wellKnownTypeUnmarshaler(name pref.FullName) unmarshalFunc wellKnownTypeUnmarshaler returns a unmarshal function if the message type has specialized serialization behavior. It returns nil otherwise.

Package-Level Variables (total 2, neither is exported) /* 2 unexporteds ... *//* 2 unexporteds: */

var errEmptyObject error

var errMissingType error

Package-Level Constants (total 5, none are exported) /* 5 unexporteds ... *//* 5 unexporteds: */

const defaultIndent = " "

const maxSecondsInDuration = 315576000000

const maxTimestampSeconds = 253402300799

const minTimestampSeconds = -62135596800

const secondsInNanos = 999999999