encoder

Documentation

Index

• Variables
• type Encoder
• type Options
• type StreamEncoder

Variables

var (
	Encode         = encoder.Encode
	EncodeIndented = encoder.EncodeIndented
	EncodeInto     = encoder.EncodeInto
	HTMLEscape     = encoder.HTMLEscape
	Pretouch       = encoder.Pretouch
	Quote          = encoder.Quote
	Valid          = encoder.Valid
)

var NewStreamEncoder = encoder.NewStreamEncoder

Types

type Encoder

type Encoder = encoder.Encoder

type Options

type Options = encoder.Options

const (
	// SortMapKeys indicates that the keys of a map needs to be sorted
	// before serializing into JSON.
	// WARNING: This hurts performance A LOT, USE WITH CARE.
	SortMapKeys Options = encoder.SortMapKeys

	// EscapeHTML indicates encoder to escape all HTML characters
	// after serializing into JSON (see https://pkg.go.dev/encoding/json#HTMLEscape).
	// WARNING: This hurts performance A LOT, USE WITH CARE.
	EscapeHTML Options = encoder.EscapeHTML

	// CompactMarshaler indicates that the output JSON from json.Marshaler
	// is always compact and needs no validation
	CompactMarshaler Options = encoder.CompactMarshaler

	// NoQuoteTextMarshaler indicates that the output text from encoding.TextMarshaler
	// is always escaped string and needs no quoting
	NoQuoteTextMarshaler Options = encoder.NoQuoteTextMarshaler

	// NoNullSliceOrMap indicates all empty Array or Object are encoded as '[]' or '{}',
	// instead of 'null'
	NoNullSliceOrMap Options = encoder.NoNullSliceOrMap

	// ValidateString indicates that encoder should validate the input string
	// before encoding it into JSON.
	ValidateString Options = encoder.ValidateString

	// CompatibleWithStd is used to be compatible with std encoder.
	CompatibleWithStd Options = encoder.CompatibleWithStd
)

type StreamEncoder

type StreamEncoder = encoder.StreamEncoder