Categorygithub.com/go-shafaq/encoding-json
modulepackage
0.0.0-20240422054922-6f069c4b7a8b
Repository: https://github.com/go-shafaq/encoding-json.git
Documentation: pkg.go.dev

# README

encoding-json

original library from golang.

Added future:

casting names automatically if needed

no more tagging every single field to specify its name

Basic Usage

Installation

go get github.com/go-shafaq/encoding-json

Code

Here is a minimal example.

package main

import (
	"fmt"
	"github.com/go-shafaq/defcase"
	json "github.com/go-shafaq/encoding-json"
)

func main() {
	// Get Public Default case
	dcase := defcase.Get()
	// Set a case for "json" tag and specific package
	// "*" means any package
	dcase.SetCase("json", "*", defcase.Snak_case)
	// You can also do:
	// dcase.SetCase("json", "github.com/my-username/my-repo", defcase.Snak_case)
	// dcase.SetCase("json", "github.com/my-username/my-repo/internal", defcase.Snak_case)
	// dcase.SetCase("json", "github.com/my-username/my-repo/cmd", defcase.Snak_case)

	// Set a Default_Case to library
	json.SetDefCase(dcase)
	// Marshal a struct (which has no tags)
	bytes, _ := json.Marshal(Item{Id: 3, Name: "laptop", CategoryId: 11})

	fmt.Println(string(bytes))
}

type Item struct {
	Id         int `casting:"no more tags"`
	Name       string
	CategoryId int
}

Terminal

Printed result

{"id":3,"name":"laptop","category_id":11}

Pretty json

{
  "id": 3,
  "name": "laptop",
  "category_id": 11
}

# Functions

Compact appends to dst the JSON-encoded src with insignificant space characters elided.
HTMLEscape appends to dst the JSON-encoded src with <, >, &, U+2028 and U+2029 characters inside string literals changed to \u003c, \u003e, \u0026, \u2028, \u2029 so that the JSON will be safe to embed inside HTML <script> tags.
Indent appends to dst an indented form of the JSON-encoded src.
Marshal returns the JSON encoding of v.
MarshalIndent is like Marshal but applies Indent to format the output.
NewDecoder returns a new decoder that reads from r.
NewEncoder returns a new encoder that writes to w.
No description provided by the author
Unmarshal parses the JSON-encoded data and stores the result in the value pointed to by v.
Valid reports whether data is a valid JSON encoding.

# Structs

A Decoder reads and decodes JSON values from an input stream.
An Encoder writes JSON values to an output stream.
An InvalidUnmarshalError describes an invalid argument passed to Unmarshal.
Before Go 1.2, an InvalidUTF8Error was returned by Marshal when attempting to encode a string value with invalid UTF-8 sequences.
A MarshalerError represents an error from calling a MarshalJSON or MarshalText method.
A SyntaxError is a description of a JSON syntax error.
An UnmarshalFieldError describes a JSON object key that led to an unexported (and therefore unwritable) struct field.
An UnmarshalTypeError describes a JSON value that was not appropriate for a value of a specific Go type.
An UnsupportedTypeError is returned by Marshal when attempting to encode an unsupported value type.
An UnsupportedValueError is returned by Marshal when attempting to encode an unsupported value.

# Interfaces

No description provided by the author
Marshaler is the interface implemented by types that can marshal themselves into valid JSON.
Unmarshaler is the interface implemented by types that can unmarshal a JSON description of themselves.

# Type aliases

A Delim is a JSON array or object delimiter, one of [ ] { or }.
A Number represents a JSON number literal.
RawMessage is a raw encoded JSON value.
A Token holds a value of one of these types: Delim, for the four JSON delimiters [ ] { } bool, for JSON booleans float64, for JSON numbers Number, for JSON numbers string, for JSON string literals nil, for JSON null.