properties

README

Properties

a module for marshal/unmarshal .properties config file

API

1. Marshal

func Marshal(v interface{}) ([]byte, error)

1. Unmarshal

func Unmarshal(data []byte, v interface{}) error

1. UnmarshalKey

func UnmarshalKey(key string, data []byte, v interface{}) error

1. UnmarshalKV

func UnmarshalKV(kv map[string]string, v interface{}) error

Usages

import (
	"fmt"
	"github.com/ZhengHe-MD/properties"
)

type Address struct {
	Country string `properties:"country"`
	City    string `properties:"city"`
	Street  string `properties:"street"`
}

type Contact struct {
	Name  string `properties:"name"`
	Phone string `properties:"phone"`
}

type Person struct {
	Name    string `properties:"name"`
	Age     int8   `properties:"age"`
	Email   string `properties:"email"`
	Bio     string `properties:"-"`
	Offline bool   `properties:"off"`

	EmergencyContact Contact   `properties:"emergency_contact"`
	AddressList      []Address `properties:"address_list"`
}

func main() {
	propsKV := map[string]string{
        "name": "zhenghe",
        "age": "18",
        "email": "ranchardzheng@gmail.com",
        "bio": "a boring guy",
        "offline": "true",
        "emergency_contact.name": "anonymous",
        "emergency_contact.phone": "13333333333",
        "address_list[0].country": "China",
        "address_list[0].city": "Beijing",
        "address_list[0].street": "Zhongguancun Street",
        "address_list[1].country": "China",
        "address_list[1].city": "Shanghai",
        "address_list[1].street": "Nanjing Road",
    }

    propsStr := `
    name=zhenghe
    age=18
    email=ranchardzheng@gmail.com
    bio=a boring guy
    offline=true
    emergency_contact.name=anonymous
    emergency_contact.phone=13333333333
    address_list[0].country=China
    address_list[0].city=Beijing
    address_list[0].street=Zhongguancun Street
    address_list[1].country=China
    address_list[1].city=Shanghai
    address_list[1].street=Nanjing Road
`

    var p1 Person
    var p2 Person
    var e1 Contact
    _ = properties.UnmarshalKV(propsKV, &p1)
    _ = properties.Unmarshal([]byte(propsStr), &p2)
    _ = properties.UnmarshalKey("emergency_contact", []byte(propsStr), &e1)

    fmt.Println(p1)
    fmt.Println(p2)
    fmt.Println(e1)

    var p3 = Person{
        Name: "zhenghe",
        Age: 18,
        Email: "ranchardzheng@gmail.com",
        Bio: "hahahaha",
        Offline: true,
        EmergencyContact: Contact{
            Name: "anonymous",
            Phone: "13333333333",
        },
        AddressList: []Address{
            {"China", "Beijing", "Zhongguancun Street"},
            {"China", "Shanghai", "Nanjing Road"},
        },
    }

    data, _ := properties.Marshal(p3)
    fmt.Println(string(data))
}

Install

$ go get -u github.com/ZhengHe-MD/properties

Documentation

Index

• Variables
• func Marshal(v interface{}) ([]byte, error)
• func Unmarshal(data []byte, v interface{}) error
• func UnmarshalKV(kv map[string]string, v interface{}) error
• func UnmarshalKey(key string, data []byte, v interface{}) error

Variables

var (
	InvalidUnmarshalError = errors.New("v must be a non-nil struct pointer")
	InvalidMarshalError   = errors.New("v must be of type map, map pointer, struct or struct pointer")
	InvalidPropBytes      = errors.New("bytes are not from valid .properties config")
	UnsupportedTypeError  = errors.New("unsupported type")
)

Functions

func Marshal

func Marshal(v interface{}) ([]byte, error)

func Unmarshal

func Unmarshal(data []byte, v interface{}) error

func UnmarshalKV

func UnmarshalKV(kv map[string]string, v interface{}) error

func UnmarshalKey

func UnmarshalKey(key string, data []byte, v interface{}) error