jsonutil

Documentation

Index

• Constants
• Variables
• func Equal(x, y io.Reader) (bool, error)
• func EqualBytes(x, y []byte) (bool, error)
• func EqualFiles(x, y string) (bool, error)
• func IndentBytes(data []byte, prefix, indent string) ([]byte, error)
• func IndentReader(r io.Reader, prefix, indent string) ([]byte, error)
• func MarshalBase64(v any) (string, error)
• func MarshalOrDefault(v any, def []byte) ([]byte, error)
• func MarshalSimple(v any, prefix, indent string) ([]byte, error)
• func MustMarshal(v any, embedError bool) []byte
• func MustMarshalIndent(v any, prefix, indent string, embedError bool) []byte
• func MustMarshalOrDefault(v any, def []byte) []byte
• func MustMarshalSimple(v any, prefix, indent string) []byte
• func MustMarshalString(v any, embedError bool) string
• func MustUnmarshal(b []byte, v any)
• func PrintReaderIndent(r io.Reader, prefix, indent string) ([]byte, error)
• func Unescape(b []byte, prefix, indent string) ([]byte, error)
• func UnmarshalAny(data, v any) error
• func UnmarshalFile(filename string, v any) ([]byte, error)
• func UnmarshalKeys(b []byte) ([]string, error)
• func UnmarshalKeysFile(filename string) ([]string, error)
• func UnmarshalMSI(data map[string]any, v any) error
• func UnmarshalReader(r io.Reader, v any) ([]byte, error)
• func UnmarshalStrict(b []byte, v any) error
• func WriteFile(filename string, v any, prefix, indent string, perm fs.FileMode) error
• func WriteFileIndentBytes(name string, data []byte, prefix, indent string, perm fs.FileMode) error
• type Bool
  • func (b *Bool) UnmarshalJSON(data []byte) error
• type Int64
  • func (i64 *Int64) UnmarshalJSON(data []byte) error
• type String
  • func (s *String) UnmarshalJSON(data []byte) error

Constants

const (
	EmptyArray  = "[]"
	EmptyObject = "{}"
	FileExt     = ".json"
)

Variables

var (
	MarshalPrefix = ""
	MarshalIndent = "    "
)

Functions

func Equal

func Equal(x, y io.Reader) (bool, error)

func EqualBytes

func EqualBytes(x, y []byte) (bool, error)

func EqualFiles

func EqualFiles(x, y string) (bool, error)

func IndentBytes

func IndentBytes(data []byte, prefix, indent string) ([]byte, error)

IndentBytes converts a JSON byte array into a prettified byte array.

func IndentReader

func IndentReader(r io.Reader, prefix, indent string) ([]byte, error)

IndentReader returns a byte slice of indented JSON given an `io.Reader`. It is useful to use with `http.Response.Body` which is an `io.ReadCloser`.

func MarshalBase64

func MarshalBase64(v any) (string, error)

func MarshalOrDefault

func MarshalOrDefault(v any, def []byte) ([]byte, error)

MarshalOrDefault returns the supplied default value in the event of an error. It also returns the error for processing.

func MarshalSimple

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

func MustMarshal

func MustMarshal(v any, embedError bool) []byte

func MustMarshalIndent

func MustMarshalIndent(v any, prefix, indent string, embedError bool) []byte

func MustMarshalOrDefault

func MustMarshalOrDefault(v any, def []byte) []byte

func MustMarshalSimple

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

func MustMarshalString

func MustMarshalString(v any, embedError bool) string

func MustUnmarshal

func MustUnmarshal(b []byte, v any)

func PrintReaderIndent

func PrintReaderIndent(r io.Reader, prefix, indent string) ([]byte, error)

PrintReaderIndent returns an indented JSON byte array given an `io.Reader`.

func Unescape

func Unescape(b []byte, prefix, indent string) ([]byte, error)

Unescape is designed to unescape a stringified JSON. It is typically used after a stringified JSON has been embedded as a value in an wrapper JSON object. When using this, do not include outer quotes.

func UnmarshalAny

func UnmarshalAny(data, v any) error

UnmarshalAny will unmarshal anything to `v`, including first marshalling anything that is not a byte array to a JSON byte array.

func UnmarshalFile

func UnmarshalFile(filename string, v any) ([]byte, error)

func UnmarshalKeys

func UnmarshalKeys(b []byte) ([]string, error)

func UnmarshalKeysFile

func UnmarshalKeysFile(filename string) ([]string, error)

func UnmarshalMSI

func UnmarshalMSI(data map[string]any, v any) error

func UnmarshalReader

func UnmarshalReader(r io.Reader, v any) ([]byte, error)

func UnmarshalStrict

func UnmarshalStrict(b []byte, v any) error

UnmarshalStrict returns an error when the destination is a struct and the input contains object keys which do not match any non-ignored, exported fields in the destination.

func WriteFile

func WriteFile(filename string, v any, prefix, indent string, perm fs.FileMode) error

func WriteFileIndentBytes

func WriteFileIndentBytes(name string, data []byte, prefix, indent string, perm fs.FileMode) error

Types

type Bool

type Bool bool

Bool implements a tolerant reader for `bool` type.

func (*Bool) UnmarshalJSON

func (b *Bool) UnmarshalJSON(data []byte) error

type Int64

type Int64 int64

Int64 implements a tolerant reader for `int64` type.

func (*Int64) UnmarshalJSON

func (i64 *Int64) UnmarshalJSON(data []byte) error

type String

type String string

String implements a tolerant reader for `string` type, including flexible input conversion to strings from numbers and integers.

func (*String) UnmarshalJSON

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