json

Documentation

Overview

Package json provides an interface to functions and types in the standard encoding/json package to facilitate mocking.

Index

• func Marshal(v any) ([]byte, error)
• func MarshalIndent(v any, prefix, indent string) ([]byte, error)
• func Unmarshal(data []byte, v any) error
• type Decoder
  • func NewDecoder(r io.Reader, options ...DecoderOption) Decoder
  • func WrapDecoder(dec *json.Decoder) Decoder
• type DecoderOption
  • func WithDisallowUnknownFields() DecoderOption
  • func WithUseNumber() DecoderOption
• type Delim
• type Encoder
  • func NewEncoder(w io.Writer, options ...EncoderOption) Encoder
  • func WrapEncoder(enc *json.Encoder) Encoder
• type EncoderOption
  • func WithEscapeHTML(on bool) EncoderOption
  • func WithIndent(prefix, indent string) EncoderOption
• type InvalidUnmarshalError
• type JSON
  • func NewJSON() JSON
• type Marshaler
• type MarshalerError
• type Number
• type RawMessage
• type SyntaxError
• type Token
• type UnmarshalTypeError
• type Unmarshaler
• type UnsupportedTypeError
• type UnsupportedValueError

Functions

func Marshal

func Marshal(v any) ([]byte, error)

Marshal returns the JSON encoding of v by calling encoding/json.Marshal.

func MarshalIndent

func MarshalIndent(v any, prefix, indent string) ([]byte, error)

MarshalIndent returns formatted JSON encoding of v by calling encoding/json.MarshalIndent.

func Unmarshal

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

Unmarshal parses the JSON-encoded data and stores the result by calling encoding/json.Unmarshal.

Types

type Decoder

type Decoder interface {
	Decode(v any) error
	Buffered() io.Reader
	InputOffset() int64
	More() bool
	Token() (Token, error)
	Nub() *json.Decoder
}

func NewDecoder

func NewDecoder(r io.Reader, options ...DecoderOption) Decoder

NewDecoder creates a new Decoder that reads from r with optional configuration.

func WrapDecoder

func WrapDecoder(dec *json.Decoder) Decoder

type DecoderOption

type DecoderOption func(*json.Decoder)

func WithDisallowUnknownFields

func WithDisallowUnknownFields() DecoderOption

func WithUseNumber

func WithUseNumber() DecoderOption

type Delim

type Delim = json.Delim

Value types

type Encoder

type Encoder interface {
	Encode(v any) error
	SetIndent(prefix, indent string)
	SetEscapeHTML(on bool)
	Nub() *json.Encoder
}

func NewEncoder

func NewEncoder(w io.Writer, options ...EncoderOption) Encoder

NewEncoder creates a new Encoder that writes to w with optional configuration.

func WrapEncoder

func WrapEncoder(enc *json.Encoder) Encoder

type EncoderOption

type EncoderOption func(*json.Encoder)

func WithEscapeHTML

func WithEscapeHTML(on bool) EncoderOption

func WithIndent

func WithIndent(prefix, indent string) EncoderOption

type InvalidUnmarshalError

type InvalidUnmarshalError = json.InvalidUnmarshalError

Error types

type JSON

type JSON interface {
	// Functions:
	Marshal(v any) ([]byte, error)
	MarshalIndent(v any, prefix, indent string) ([]byte, error)
	Unmarshal(data []byte, v any) error
	Compact(dst *bytes.Buffer, src []byte) error
	HTMLEscape(dst *bytes.Buffer, src []byte)
	Indent(dst *bytes.Buffer, src []byte, prefix, indent string) error
	Valid(data []byte) bool

	// Constructors:
	NewDecoder(r io.Reader, options ...DecoderOption) Decoder
	NewEncoder(w io.Writer, options ...EncoderOption) Encoder
}

func NewJSON

func NewJSON() JSON

type Marshaler

type Marshaler = json.Marshaler

Interfaces for custom marshaling/unmarshaling

type MarshalerError

type MarshalerError = json.MarshalerError

type Number

type Number = json.Number

type RawMessage

type RawMessage = json.RawMessage

type SyntaxError

type SyntaxError = json.SyntaxError

type Token

type Token = json.Token

type UnmarshalTypeError

type UnmarshalTypeError = json.UnmarshalTypeError

type Unmarshaler

type Unmarshaler = json.Unmarshaler

type UnsupportedTypeError

type UnsupportedTypeError = json.UnsupportedTypeError

type UnsupportedValueError

type UnsupportedValueError = json.UnsupportedValueError