json

Documentation

Overview

Package json implements an ifaces.Adapter using github.com/mailru/easyjson.

Index

• func BorrowAdapterIface() ifaces.Adapter
• func BorrowLexer(data []byte) *jlexer.Lexer
• func BorrowWriter() *jwriter.Writer
• func RedeemAdapter(a *Adapter)
• func RedeemAdapterIface(a ifaces.Adapter)
• func RedeemLexer(l *jlexer.Lexer)
• func RedeemWriter(w *jwriter.Writer)
• func Register(dispatcher ifaces.Registrar, opts ...Option)
• type Adapter
  • func BorrowAdapter() *Adapter
  • func NewAdapter(opts ...Option) *Adapter
  • func (a *Adapter) Marshal(value any) ([]byte, error)
  • func (a *Adapter) NewOrderedMap(capacity int) ifaces.OrderedMap
  • func (a *Adapter) OrderedMarshal(value ifaces.Ordered) ([]byte, error)
  • func (a *Adapter) OrderedUnmarshal(data []byte, value ifaces.SetOrdered) error
  • func (a *Adapter) Redeem()
  • func (a *Adapter) Reset()
  • func (a *Adapter) Unmarshal(data []byte, value any) error
• type MapItem
  • func (s MapItem) MarshalEasyJSON(w *jwriter.Writer)
  • func (s *MapItem) UnmarshalEasyJSON(in *jlexer.Lexer)
• type MapSlice
  • func (s MapSlice) MarshalEasyJSON(w *jwriter.Writer)
  • func (s MapSlice) MarshalJSON() ([]byte, error)
  • func (s MapSlice) OrderedItems() iter.Seq2[string, any]
  • func (s MapSlice) OrderedMarshalJSON() ([]byte, error)
  • func (s *MapSlice) OrderedUnmarshalJSON(data []byte) error
  • func (s *MapSlice) SetOrderedItems(items iter.Seq2[string, any])
  • func (s *MapSlice) UnmarshalEasyJSON(in *jlexer.Lexer)
  • func (s *MapSlice) UnmarshalJSON(data []byte) error
• type Option
  • func WithLexerUseMultipleErrors(enabled bool) Option
  • func WithWriterNilMapAsEmpty(enabled bool) Option
  • func WithWriterNilSliceAsEmpty(enabled bool) Option
  • func WithWriterNoEscapeHTML(noescape bool) Option

Functions

func BorrowAdapterIface

func BorrowAdapterIface() ifaces.Adapter

func BorrowLexer

func BorrowLexer(data []byte) *jlexer.Lexer

BorrowLexer borrows a jlexer.Lexer from the pool, recycling already allocated instances.

func BorrowWriter

func BorrowWriter() *jwriter.Writer

BorrowWriter borrows a jwriter.Writer from the pool, recycling already allocated instances.

func RedeemAdapter

func RedeemAdapter(a *Adapter)

RedeemAdapter redeems an Adapter to the pool, so it may be recycled.

func RedeemAdapterIface

func RedeemAdapterIface(a ifaces.Adapter)

func RedeemLexer

func RedeemLexer(l *jlexer.Lexer)

RedeemLexer redeems a jlexer.Lexer to the pool, so it may be recycled.

func RedeemWriter

func RedeemWriter(w *jwriter.Writer)

RedeemWriter redeems a jwriter.Writer to the pool, so it may be recycled.

func Register

func Register(dispatcher ifaces.Registrar, opts ...Option)

Register the easyjson implementation of a ifaces.Adapter to the an ifaces.Registrar, e.g. the global registry github.com/go-openapi/swag/jsonutils/adapters.Registry.

Register calls ifaces.Registrar.RegisterFor.

Some optional features proposed by the jwriter.Writer and jlexer.Lexer are available. See Option.

Types

type Adapter

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

func BorrowAdapter

func BorrowAdapter() *Adapter

BorrowAdapter borrows an Adapter from the pool, recycling already allocated instances.

func NewAdapter

func NewAdapter(opts ...Option) *Adapter

NewAdapter yields a JSON adapter for easyjson.

func (*Adapter) Marshal

func (a *Adapter) Marshal(value any) ([]byte, error)

func (*Adapter) NewOrderedMap

func (a *Adapter) NewOrderedMap(capacity int) ifaces.OrderedMap

func (*Adapter) OrderedMarshal

func (a *Adapter) OrderedMarshal(value ifaces.Ordered) ([]byte, error)

func (*Adapter) OrderedUnmarshal

func (a *Adapter) OrderedUnmarshal(data []byte, value ifaces.SetOrdered) error

func (*Adapter) Redeem

func (a *Adapter) Redeem()

func (*Adapter) Reset

func (a *Adapter) Reset()

func (*Adapter) Unmarshal

func (a *Adapter) Unmarshal(data []byte, value any) error

type MapItem

type MapItem struct {
	Key   string
	Value any
}

MapItem represents the value of a key in a JSON object held by MapSlice.

Notice that MapItem should not be marshaled to or unmarshaled from JSON directly, use this type as part of a MapSlice when dealing with JSON bytes.

func (MapItem) MarshalEasyJSON

func (s MapItem) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON renders a MapItem as JSON bytes, using easyJSON

func (*MapItem) UnmarshalEasyJSON

func (s *MapItem) UnmarshalEasyJSON(in *jlexer.Lexer)

UnmarshalEasyJSON builds a MapItem from JSON bytes, using easyJSON

type MapSlice

type MapSlice []MapItem

MapSlice represents a JSON object, with the order of keys maintained.

It implements ifaces.Ordered and ifaces.SetOrdered.

func (MapSlice) MarshalEasyJSON

func (s MapSlice) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON renders a MapSlice as JSON bytes, using easyJSON

func (MapSlice) MarshalJSON

func (s MapSlice) MarshalJSON() ([]byte, error)

MarshalJSON renders a MapSlice as JSON bytes, preserving the order of keys.

func (MapSlice) OrderedItems

func (s MapSlice) OrderedItems() iter.Seq2[string, any]

func (MapSlice) OrderedMarshalJSON

func (s MapSlice) OrderedMarshalJSON() ([]byte, error)

func (*MapSlice) OrderedUnmarshalJSON

func (s *MapSlice) OrderedUnmarshalJSON(data []byte) error

func (*MapSlice) SetOrderedItems

func (s *MapSlice) SetOrderedItems(items iter.Seq2[string, any])

func (*MapSlice) UnmarshalEasyJSON

func (s *MapSlice) UnmarshalEasyJSON(in *jlexer.Lexer)

UnmarshalEasyJSON builds a MapSlice from JSON bytes, using easyJSON

func (*MapSlice) UnmarshalJSON

func (s *MapSlice) UnmarshalJSON(data []byte) error

UnmarshalJSON builds a MapSlice from JSON bytes, preserving the order of keys.

Inner objects are unmarshaled as MapSlice slices and not map[string]any.

type Option

type Option func(o *options)

Option selects options for the easyjson adapter.

func WithLexerUseMultipleErrors

func WithLexerUseMultipleErrors(enabled bool) Option

func WithWriterNilMapAsEmpty

func WithWriterNilMapAsEmpty(enabled bool) Option

func WithWriterNilSliceAsEmpty

func WithWriterNilSliceAsEmpty(enabled bool) Option

func WithWriterNoEscapeHTML

func WithWriterNoEscapeHTML(noescape bool) Option