Documentation
¶
Index ¶
- Variables
- func Color(src []byte, style *Style) []byte
- func Marshal(v interface{}) ([]byte, error)
- func NewDecoder(r io.Reader) *json.Decoder
- func NewEncoder(r io.Writer) *json.Encoder
- func NewJSONEncoder(cfg *encoding.EncoderConfig) encoding.Encoder
- func Pretty(json []byte) []byte
- func PrettyOptions(json []byte, opts *Options) []byte
- func Ugly(json []byte) []byte
- func UglyInPlace(json []byte) []byte
- func Unmarshal(data []byte, v any) error
- type Number
- type Options
- type Style
Constants ¶
This section is empty.
Variables ¶
var DefaultOptions = &Options{Width: 80, Prefix: "", Indent: " ", SortKeys: false}
DefaultOptions is the default options for pretty formats.
Functions ¶
func Color ¶
Color will colorize the json. The style parma is used for customizing the colors. Passing nil to the style param will use the default TerminalStyle.
func NewJSONEncoder ¶
func NewJSONEncoder(cfg *encoding.EncoderConfig) encoding.Encoder
NewJSONEncoder creates a fast, low-allocation JSON encoder. The encoder appropriately escapes all field keys and values.
Note that the encoder doesn't deduplicate keys, so it's possible to produce a message like
{"foo":"bar","foo":"baz"}
This is permitted by the JSON specification, but not encouraged. Many libraries will ignore duplicate key-value pairs (typically keeping the last pair) when unmarshaling, but users should attempt to avoid adding duplicate keys.
func Pretty ¶
Pretty converts the input json into a more human readable format where each element is on it's own line with clear indentation.
func PrettyOptions ¶
PrettyOptions is like Pretty but with customized options.
func Ugly ¶
Ugly removes insignificant space characters from the input json byte slice and returns the compacted result.
func UglyInPlace ¶
UglyInPlace removes insignificant space characters from the input json byte slice and returns the compacted result. This method reuses the input json buffer to avoid allocations. Do not use the original bytes slice upon return.
Types ¶
type Options ¶
type Options struct {
// Width is an max column width for single line arrays
// Default is 80
Width int
// Prefix is a prefix for all lines
// Default is an empty string
Prefix string
// Indent is the nested indentation
// Default is two spaces
Indent string
// SortKeys will sort the keys alphabetically
// Default is false
SortKeys bool
}
Options is Pretty options
Source Files
Directories