jy2struct

README

jy2struct

A library for generating go struct code, supporting json and yaml.

Example of use

Main setting parameters.

type Args struct {
	Format    string // document format, json or yaml
	Data      string // json or yaml content
	InputFile string // file
	Name      string // name of structure
	SubStruct bool   // are sub-structures separated
	Tags      string // add additional tags, multiple tags separated by commas
}

Example of conversion.

    // json covert to struct
    code, err := jy2struct.Covert(&jy2struct.Args{
        Format: "json",
        // InputFile: "user.json", // source from json file
        SubStruct: true,
    })

    // yaml covert to struct
    code, err := jy2struct.Covert(&jy2struct.Args{
        Format: "yaml",
        // InputFile: "user.yaml", // Source from yaml file
        SubStruct: true,
    })

Documentation

Index

• Variables
• func Covert(args *Args) (string, error)
• func FmtFieldName(s string) string
• func ParseJSON(input io.Reader) (interface{}, error)
• func ParseYaml(input io.Reader) (interface{}, error)
• type Args
• type Parser

Variables

var ForceFloats bool

ForceFloats whether to force a change to float

Functions

func Covert

func Covert(args *Args) (string, error)

Covert json or yaml to go struct

func FmtFieldName

func FmtFieldName(s string) string

FmtFieldName formats a string as a struct key

Example:

FmtFieldName("foo_id")

Output: FooID

func ParseJSON

func ParseJSON(input io.Reader) (interface{}, error)

ParseJSON parse json to struct

func ParseYaml

func ParseYaml(input io.Reader) (interface{}, error)

ParseYaml parse yaml to struct

Types

type Args

type Args struct {
	Format    string // document format, json or yaml
	Data      string // json or yaml content
	InputFile string // file
	Name      string // name of structure
	SubStruct bool   // are sub-structures separated
	Tags      string // add additional tags, multiple tags separated by commas
	// contains filtered or unexported fields
}

Args covert arguments

type Parser

type Parser func(io.Reader) (interface{}, error)

Parser parser function