jsonutil

Documentation

Overview

Package jsonutil provide some util functions for quick operate JSON data

Index

• func Decode(bts []byte, ptr any) error
• func DecodeReader(r io.Reader, ptr any) error
• func DecodeString(str string, ptr any) error
• func Encode(v any) ([]byte, error)
• func EncodePretty(v any) ([]byte, error)
• func EncodeString(v any) (string, error)
• func EncodeToWriter(v any, w io.Writer) error
• func EncodeUnescapeHTML(v any) ([]byte, error)
• func IsArray(s string) bool
• func IsJSON(s string) bool
• func IsJSONFast(s string) bool
• func IsObject(s string) bool
• func Mapping(src, dst any) error
• func MustPretty(v any) string
• func MustString(v any) string
• func Pretty(v any) (string, error)
• func ReadFile(filePath string, v any) error
• func StripComments(src string) string
• func WriteFile(filePath string, data any) error
• func WritePretty(filePath string, data any) error

Functions

func Decode

func Decode(bts []byte, ptr any) error

Decode json bytes to data ptr. alias of json.Unmarshal

func DecodeReader

func DecodeReader(r io.Reader, ptr any) error

DecodeReader decode JSON from io reader.

func DecodeString

func DecodeString(str string, ptr any) error

DecodeString json string to data ptr.

func Encode

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

Encode data to json bytes. alias of json.Marshal

func EncodePretty

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

EncodePretty encode data to pretty JSON bytes.

func EncodeString

func EncodeString(v any) (string, error)

EncodeString encode data to JSON string.

func EncodeToWriter

func EncodeToWriter(v any, w io.Writer) error

EncodeToWriter encode data to json and write to writer.

func EncodeUnescapeHTML

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

EncodeUnescapeHTML data to json bytes. will close escape HTML

func IsArray

func IsArray(s string) bool

IsArray check if the string is valid JSON array.

func IsJSON

func IsJSON(s string) bool

IsJSON check if the string is valid JSON. (Note: uses json.Valid)

func IsJSONFast

func IsJSONFast(s string) bool

IsJSONFast simple and fast check input is valid JSON array or object.

func IsObject

func IsObject(s string) bool

IsObject check if the string is valid JSON object.

func Mapping

func Mapping(src, dst any) error

Mapping src data(map,struct) to dst struct use json tags.

On src, dst both is struct, equivalent to merging two structures (src should be a subset of dsc)

func MustPretty

func MustPretty(v any) string

MustPretty data to JSON string, will panic on error

func MustString

func MustString(v any) string

MustString encode data to json string, will panic on error

func Pretty

func Pretty(v any) (string, error)

Pretty JSON string and return

func ReadFile

func ReadFile(filePath string, v any) error

ReadFile Read JSON file data

func StripComments

func StripComments(src string) string

StripComments strip comments for a JSON string

func WriteFile

func WriteFile(filePath string, data any) error

WriteFile write data to JSON file

func WritePretty

func WritePretty(filePath string, data any) error

WritePretty write pretty data to JSON file