package jsonpb

Import Path
	github.com/golang/protobuf/jsonpb (on go.dev)

Dependency Relation
	imports 16 packages, and imported by one package

Involved Source Files

	      decode.go
	      encode.go
	   #d json.go
		Package jsonpb provides functionality to marshal and unmarshal between a
		protocol buffer message and JSON. It follows the specification at
		https://developers.google.com/protocol-buffers/docs/proto3#json.

		Do not rely on the default behavior of the standard encoding/json package
		when called on generated message types as it does not operate correctly.

		Deprecated: Use the "google.golang.org/protobuf/encoding/protojson"
		package instead.
Package-Level Type Names (total 7, in which 5 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type AnyResolver (interface)
		AnyResolver takes a type URL, present in an Any message,
		and resolves it into an instance of the associated message.

		Methods (only one, which is exported)
			( AnyResolver) Resolve(typeURL string) (proto.Message, error)
		Implemented By (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			 anyResolver

	 type JSONPBMarshaler (interface)
		JSONPBMarshaler is implemented by protobuf messages that customize the
		way they are marshaled to JSON. Messages that implement this should also
		implement JSONPBUnmarshaler so that the custom format can be parsed.

		The JSON marshaling must follow the proto to JSON specification:
			https://developers.google.com/protocol-buffers/docs/proto3#json

		Deprecated: Custom types should implement protobuf reflection instead.

		Methods (only one, which is exported)
			( JSONPBMarshaler) MarshalJSONPB(*Marshaler) ([]byte, error)

	 type JSONPBUnmarshaler (interface)
		JSONPBUnmarshaler is implemented by protobuf messages that customize the way
		they are unmarshaled from JSON. Messages that implement this should also
		implement JSONPBMarshaler so that the custom format can be produced.

		The JSON unmarshaling must follow the JSON to proto specification:
			https://developers.google.com/protocol-buffers/docs/proto3#json

		Deprecated: Custom types should implement protobuf reflection instead.

		Methods (only one, which is exported)
			( JSONPBUnmarshaler) UnmarshalJSONPB(*Unmarshaler, []byte) error

	 type Marshaler (struct)
		Marshaler is a configurable object for marshaling protocol buffer messages
		to the specified JSON representation.

		Fields (total 5, all are exported)
			AnyResolver AnyResolver
				AnyResolver is used to resolve the google.protobuf.Any well-known type.
				If unset, the global registry is used by default.

			EmitDefaults bool
				EmitDefaults specifies whether to render fields with zero values.

			EnumsAsInts bool
				EnumsAsInts specifies whether to render enum values as integers,
				as opposed to string values.

			Indent string
				Indent controls whether the output is compact or not.
				If empty, the output is compact JSON. Otherwise, every JSON object
				entry and JSON array value will be on its own line.
				Each line will be preceded by repeated copies of Indent, where the
				number of copies is the current indentation depth.

			OrigName bool
				OrigName specifies whether to use the original protobuf name for fields.

		Methods (total 3, in which 2 are exported)
			(*Marshaler) Marshal(w io.Writer, m proto.Message) error
				Marshal serializes a protobuf message as JSON into w.

			(*Marshaler) MarshalToString(m proto.Message) (string, error)
				MarshalToString serializes a protobuf message as JSON in string form.

			/* one unexported ... *//* one unexported: */
			(*Marshaler) marshal(m proto.Message) ([]byte, error)
		As Inputs Of (at least one exported)
			func JSONPBMarshaler.MarshalJSONPB(*Marshaler) ([]byte, error)

	 type Unmarshaler (struct)
		Unmarshaler is a configurable object for converting from a JSON
		representation to a protocol buffer object.

		Fields (total 2, both are exported)
			AllowUnknownFields bool
				AllowUnknownFields specifies whether to allow messages to contain
				unknown JSON fields, as opposed to failing to unmarshal.

			AnyResolver AnyResolver
				AnyResolver is used to resolve the google.protobuf.Any well-known type.
				If unset, the global registry is used by default.

		Methods (total 5, in which 2 are exported)
			(*Unmarshaler) Unmarshal(r io.Reader, m proto.Message) error
				Unmarshal unmarshals a JSON object from r into m.

			(*Unmarshaler) UnmarshalNext(d *json.Decoder, m proto.Message) error
				UnmarshalNext unmarshals the next JSON object from d into m.

			/* 3 unexporteds ... *//* 3 unexporteds: */
			(*Unmarshaler) unmarshalMessage(m protoreflect.Message, in []byte) error
			(*Unmarshaler) unmarshalSingularValue(v protoreflect.Value, in []byte, fd protoreflect.FieldDescriptor) (protoreflect.Value, error)
			(*Unmarshaler) unmarshalValue(v protoreflect.Value, in []byte, fd protoreflect.FieldDescriptor) (protoreflect.Value, error)
		As Inputs Of (at least one exported)
			func JSONPBUnmarshaler.UnmarshalJSONPB(*Unmarshaler, []byte) error

	/* 2 unexporteds ... *//* 2 unexporteds: */
	 type anyResolver (struct)

		Fields (only one, which is exported)
			AnyResolver AnyResolver
		Methods (total 5, all are exported)
			( anyResolver) FindExtensionByName(field protoreflect.FullName) (protoreflect.ExtensionType, error)
			( anyResolver) FindExtensionByNumber(message protoreflect.FullName, field protoreflect.FieldNumber) (protoreflect.ExtensionType, error)
			( anyResolver) FindMessageByName(message protoreflect.FullName) (protoreflect.MessageType, error)
			( anyResolver) FindMessageByURL(url string) (protoreflect.MessageType, error)
			( anyResolver) Resolve(typeURL string) (proto.Message, error)
		Implements (at least 3, all are exported)
			 anyResolver : AnyResolver
			 anyResolver : google.golang.org/protobuf/reflect/protoregistry.ExtensionTypeResolver
			 anyResolver : google.golang.org/protobuf/reflect/protoregistry.MessageTypeResolver

	 type jsonWriter (struct)

		Fields (total 7, in which 6 are exported)
			Marshaler *Marshaler
			Marshaler.AnyResolver AnyResolver
				AnyResolver is used to resolve the google.protobuf.Any well-known type.
				If unset, the global registry is used by default.

			Marshaler.EmitDefaults bool
				EmitDefaults specifies whether to render fields with zero values.

			Marshaler.EnumsAsInts bool
				EnumsAsInts specifies whether to render enum values as integers,
				as opposed to string values.

			Marshaler.Indent string
				Indent controls whether the output is compact or not.
				If empty, the output is compact JSON. Otherwise, every JSON object
				entry and JSON array value will be on its own line.
				Each line will be preceded by repeated copies of Indent, where the
				number of copies is the current indentation depth.

			Marshaler.OrigName bool
				OrigName specifies whether to use the original protobuf name for fields.

			/* one unexported ... *//* one unexported: */
			buf []byte
		Methods (total 11, in which 2 are exported)
			( jsonWriter) Marshal(w io.Writer, m proto.Message) error
				Marshal serializes a protobuf message as JSON into w.

			( jsonWriter) MarshalToString(m proto.Message) (string, error)
				MarshalToString serializes a protobuf message as JSON in string form.

			/* 9 unexporteds ... *//* 9 unexporteds: */
			( jsonWriter) marshal(m proto.Message) ([]byte, error)
			(*jsonWriter) marshalAny(m protoreflect.Message, indent string) error
			(*jsonWriter) marshalField(fd protoreflect.FieldDescriptor, v protoreflect.Value, indent string) error
				marshalField writes field description and value to the Writer.

			(*jsonWriter) marshalMessage(m protoreflect.Message, indent, typeURL string) error
			(*jsonWriter) marshalSingularValue(fd protoreflect.FieldDescriptor, v protoreflect.Value, indent string) error
			(*jsonWriter) marshalTypeURL(indent, typeURL string) error
			(*jsonWriter) marshalValue(fd protoreflect.FieldDescriptor, v protoreflect.Value, indent string) error
			(*jsonWriter) write(s string)
			(*jsonWriter) writeComma()


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

	 func Unmarshal(r io.Reader, m proto.Message) error
		Unmarshal unmarshals a JSON object from r into m.

	 func UnmarshalNext(d *json.Decoder, m proto.Message) error
		UnmarshalNext unmarshals the next JSON object from d into m.

	 func UnmarshalString(s string, m proto.Message) error
		UnmarshalString unmarshals a JSON object from s into m.

	/* 8 unexporteds ... *//* 8 unexporteds: */
	 func hasPrefixAndSuffix(prefix byte, in []byte, suffix byte) bool
	 func isMessageSet(md protoreflect.MessageDescriptor) bool
	 func isSingularJSONPBUnmarshaler(v protoreflect.Value, fd protoreflect.FieldDescriptor) bool
	 func isSingularWellKnownValue(fd protoreflect.FieldDescriptor) bool
	 func trimQuote(in []byte) []byte
		trimQuote is like unquoteString but simply strips surrounding quotes.
		This is incorrect, but is behavior done by the legacy implementation.

	 func unmarshalValue(in []byte, v interface{}) (protoreflect.Value, error)
	 func unquoteString(in string) (out string, err error)
	 func wellKnownType(s protoreflect.FullName) string
Package-Level Variables (only one, which is unexported)

	/* one unexported ... *//* one unexported: */
	  var nonFinite map[string]float64
Package-Level Constants (total 2, neither is exported)

	/* 2 unexporteds ... *//* 2 unexporteds: */
	const wrapJSONMarshalV2 = false
	const wrapJSONUnmarshalV2 = false

The pages are generated with Golds v0.4.9. (GOOS=linux GOARCH=amd64)