protojson

Documentation

Index

• func Marshal(pb proto.Message, options ...MarshalerOption) ([]byte, error)
• func Unmarshal(data []byte, pb proto.Message, options ...UnmarshalerOption) error
• type EmptyMarshalerOption
• type EmptyUnmarshalerOption
• type Marshaler
  • func (o *Marshaler) ApplyOptions(options ...MarshalerOption) *Marshaler
• type MarshalerOption
  • func WithMashalEmitUnpopulated(emitUnpopulated bool) MarshalerOption
  • func WithMashalMultiline(multiline bool) MarshalerOption
  • func WithMashalUseEnumNumbers(useEnumNumbers bool) MarshalerOption
  • func WithMashalUseProtoNames(useProtoNames bool) MarshalerOption
• type MarshalerOptionFunc
• type Unmarshaler
  • func (o *Unmarshaler) ApplyOptions(options ...UnmarshalerOption) *Unmarshaler
• type UnmarshalerOption
  • func WithUnMashalAllowPartial(allowPartial bool) UnmarshalerOption
  • func WithUnmashalDiscardUnknown(discardUnknown bool) UnmarshalerOption
• type UnmarshalerOptionFunc

Functions

func Marshal

func Marshal(pb proto.Message, options ...MarshalerOption) ([]byte, error)

func Unmarshal

func Unmarshal(data []byte, pb proto.Message, options ...UnmarshalerOption) error

Types

type EmptyMarshalerOption

type EmptyMarshalerOption struct{}

EmptyMarshalerOption does not alter the configuration. It can be embedded in another structure to build custom options.

This API is EXPERIMENTAL.

type EmptyUnmarshalerOption

type EmptyUnmarshalerOption struct{}

EmptyUnmarshalerOption does not alter the configuration. It can be embedded in another structure to build custom options.

This API is EXPERIMENTAL.

type Marshaler

type Marshaler struct {
	// MarshalOptions is a configurable JSON format marshaler.
	protojson.MarshalOptions
}

func (*Marshaler) ApplyOptions

func (o *Marshaler) ApplyOptions(options ...MarshalerOption) *Marshaler

type MarshalerOption

type MarshalerOption interface {
	// contains filtered or unexported methods
}

A MarshalerOption sets options.

func WithMashalEmitUnpopulated

func WithMashalEmitUnpopulated(emitUnpopulated bool) MarshalerOption

func WithMashalMultiline

func WithMashalMultiline(multiline bool) MarshalerOption

func WithMashalUseEnumNumbers

func WithMashalUseEnumNumbers(useEnumNumbers bool) MarshalerOption

func WithMashalUseProtoNames

func WithMashalUseProtoNames(useProtoNames bool) MarshalerOption

type MarshalerOptionFunc

type MarshalerOptionFunc func(*Marshaler)

MarshalerOptionFunc wraps a function that modifies Client into an implementation of the MarshalerOption interface.

type Unmarshaler

type Unmarshaler struct {
	// UnmarshalOptions is a configurable JSON format parser.
	protojson.UnmarshalOptions
}

func (*Unmarshaler) ApplyOptions

func (o *Unmarshaler) ApplyOptions(options ...UnmarshalerOption) *Unmarshaler

type UnmarshalerOption

type UnmarshalerOption interface {
	// contains filtered or unexported methods
}

A UnmarshalerOption sets options.

func WithUnMashalAllowPartial

func WithUnMashalAllowPartial(allowPartial bool) UnmarshalerOption

If AllowPartial is set, input for messages that will result in missing

func WithUnmashalDiscardUnknown

func WithUnmashalDiscardUnknown(discardUnknown bool) UnmarshalerOption

If DiscardUnknown is set, unknown fields are ignored.

type UnmarshalerOptionFunc

type UnmarshalerOptionFunc func(*Unmarshaler)

UnmarshalerOptionFunc wraps a function that modifies Client into an implementation of the UnmarshalerOption interface.