protojson

Documentation

Overview

*Copyright (c) 2022, kaydxh * *Permission is hereby granted, free of charge, to any person obtaining a copy *of this software and associated documentation files (the "Software"), to deal *in the Software without restriction, including without limitation the rights *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *copies of the Software, and to permit persons to whom the Software is *furnished to do so, subject to the following conditions: * *The above copyright notice and this permission notice shall be included in all *copies or substantial portions of the Software. * *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *SOFTWARE.

*Copyright (c) 2022, kaydxh * *Permission is hereby granted, free of charge, to any person obtaining a copy *of this software and associated documentation files (the "Software"), to deal *in the Software without restriction, including without limitation the rights *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *copies of the Software, and to permit persons to whom the Software is *furnished to do so, subject to the following conditions: * *The above copyright notice and this permission notice shall be included in all *copies or substantial portions of the Software. * *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *SOFTWARE.

*Copyright (c) 2022, kaydxh * *Permission is hereby granted, free of charge, to any person obtaining a copy *of this software and associated documentation files (the "Software"), to deal *in the Software without restriction, including without limitation the rights *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *copies of the Software, and to permit persons to whom the Software is *furnished to do so, subject to the following conditions: * *The above copyright notice and this permission notice shall be included in all *copies or substantial portions of the Software. * *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *SOFTWARE.

*Copyright (c) 2022, kaydxh * *Permission is hereby granted, free of charge, to any person obtaining a copy *of this software and associated documentation files (the "Software"), to deal *in the Software without restriction, including without limitation the rights *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *copies of the Software, and to permit persons to whom the Software is *furnished to do so, subject to the following conditions: * *The above copyright notice and this permission notice shall be included in all *copies or substantial portions of the Software. * *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *SOFTWARE.

*Copyright (c) 2022, kaydxh * *Permission is hereby granted, free of charge, to any person obtaining a copy *of this software and associated documentation files (the "Software"), to deal *in the Software without restriction, including without limitation the rights *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *copies of the Software, and to permit persons to whom the Software is *furnished to do so, subject to the following conditions: * *The above copyright notice and this permission notice shall be included in all *copies or substantial portions of the Software. * *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *SOFTWARE.

*Copyright (c) 2022, kaydxh * *Permission is hereby granted, free of charge, to any person obtaining a copy *of this software and associated documentation files (the "Software"), to deal *in the Software without restriction, including without limitation the rights *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *copies of the Software, and to permit persons to whom the Software is *furnished to do so, subject to the following conditions: * *The above copyright notice and this permission notice shall be included in all *copies or substantial portions of the Software. * *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *SOFTWARE.

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.