jsonpb

Documentation

Index

• func GoGoDisallowUnknownFields()
• func TTNEventStream() runtime.Marshaler
• type GoGoDecoderWrapper
  • func (d GoGoDecoderWrapper) Decode(v interface{}) error
• type GoGoJSONPb
  • func (*GoGoJSONPb) ContentType() string
  • func (j *GoGoJSONPb) Delimiter() []byte
  • func (j *GoGoJSONPb) Marshal(v interface{}) ([]byte, error)
  • func (j *GoGoJSONPb) NewDecoder(r io.Reader) Decoder
  • func (j *GoGoJSONPb) NewEncoder(w io.Writer) Encoder
  • func (j *GoGoJSONPb) Unmarshal(data []byte, v interface{}) error
• type TTNDecoder
  • func (d *TTNDecoder) Decode(v any) error
• type TTNEncoder
  • func (e *TTNEncoder) Encode(v any) error
• type TTNMarshaler
  • func TTN() *TTNMarshaler
  • func (*TTNMarshaler) ContentType() string
  • func (m *TTNMarshaler) Marshal(v any) ([]byte, error)
  • func (m *TTNMarshaler) NewDecoder(r io.Reader) runtime.Decoder
  • func (m *TTNMarshaler) NewEncoder(w io.Writer) runtime.Encoder
  • func (m *TTNMarshaler) Unmarshal(data []byte, v any) error

Functions

func GoGoDisallowUnknownFields

func GoGoDisallowUnknownFields()

GoGoDisallowUnknownFields enables option in decoder (unmarshaller) to return an error when it finds an unknown field. This function must be called before using the JSON marshaller.

func TTNEventStream

func TTNEventStream() runtime.Marshaler

TTNEventStream returns a TTN JsonPb marshaler with double newlines for text/event-stream compatibility.

Types

type GoGoDecoderWrapper

type GoGoDecoderWrapper struct {
	*json.Decoder
}

GoGoDecoderWrapper is a wrapper around a *json.Decoder that adds support for protos to the Decode method.

func (GoGoDecoderWrapper) Decode

func (d GoGoDecoderWrapper) Decode(v interface{}) error

Decode wraps the embedded decoder's Decode method to support protos using a jsonpb.Unmarshaler.

type GoGoJSONPb

type GoGoJSONPb jsonpb.Marshaler

GoGoJSONPb is a Marshaler which marshals/unmarshals into/from JSON with the "github.com/gogo/protobuf/jsonpb". It supports fully functionality of protobuf unlike JSONBuiltin.

The NewDecoder method returns a GoGoDecoderWrapper, so the underlying *json.Decoder methods can be used.

func (*GoGoJSONPb) ContentType

func (*GoGoJSONPb) ContentType() string

ContentType always returns "application/json".

func (*GoGoJSONPb) Delimiter

func (j *GoGoJSONPb) Delimiter() []byte

Delimiter for newline encoded JSON streams.

func (*GoGoJSONPb) Marshal

func (j *GoGoJSONPb) Marshal(v interface{}) ([]byte, error)

Marshal marshals "v" into JSON.

func (*GoGoJSONPb) NewDecoder

func (j *GoGoJSONPb) NewDecoder(r io.Reader) Decoder

NewDecoder returns a Decoder which reads JSON stream from "r".

func (*GoGoJSONPb) NewEncoder

func (j *GoGoJSONPb) NewEncoder(w io.Writer) Encoder

NewEncoder returns an Encoder which writes JSON stream into "w".

func (*GoGoJSONPb) Unmarshal

func (j *GoGoJSONPb) Unmarshal(data []byte, v interface{}) error

Unmarshal unmarshals JSON "data" into "v"

type TTNDecoder

type TTNDecoder struct {
	// contains filtered or unexported fields
}

TTNDecoder reads JSON data from an io.Reader and unmarshals that into values.

func (*TTNDecoder) Decode

func (d *TTNDecoder) Decode(v any) error

Decode reads a value from the reader and unmarshals v from JSON.

type TTNEncoder

type TTNEncoder struct {
	// contains filtered or unexported fields
}

TTNEncoder marshals values to JSON and writes them to an io.Writer.

func (*TTNEncoder) Encode

func (e *TTNEncoder) Encode(v any) error

Encode marshals v to JSON and writes it to the writer.

type TTNMarshaler

type TTNMarshaler struct {
	*GoGoJSONPb
}

TTNMarshaler is the JSON marshaler/unmarshaler that is used in grpc-gateway.

func TTN

func TTN() *TTNMarshaler

TTN returns the default JSONPb marshaler of The Things Stack.

func (*TTNMarshaler) ContentType

func (*TTNMarshaler) ContentType() string

ContentType returns the content-type of the marshaler.

func (*TTNMarshaler) Marshal

func (m *TTNMarshaler) Marshal(v any) ([]byte, error)

Marshal marshals v to JSON.

func (*TTNMarshaler) NewDecoder

func (m *TTNMarshaler) NewDecoder(r io.Reader) runtime.Decoder

NewDecoder returns a new JSON decoder that reads data from r.

func (*TTNMarshaler) NewEncoder

func (m *TTNMarshaler) NewEncoder(w io.Writer) runtime.Encoder

NewEncoder returns a new JSON encoder that writes values to w.

func (*TTNMarshaler) Unmarshal

func (m *TTNMarshaler) Unmarshal(data []byte, v any) error

Unmarshal unmarshals v from JSON data.