Golang structs

Package structs implements a generic interface for manipulating Go structs. The related API is powered and inspired from the Go reflection package.

Installation

go get github.com/roninzo/structs

Usage

Example

main.go:

package main

import (
	"fmt"

	"github.com/roninzo/structs"
)

func main() {
	type T struct {
		String string
		Uint   uint
		Bool   bool
		Int    int32
	}

	t := T{
		String: "Roninzo",
		Uint:   123456,
		Bool:   true,
		Int:    5,
	}

	s, err := structs.New(&t)
	if err != nil {
		fmt.Printf("New[Error]: %v.\n", err)
		return
	}

	fmt.Printf("Name               : %v.\n", s.Name())
	fmt.Printf("Value of 1st field : %v.\n", s.Field(0).Value())
	fmt.Printf("Value of Uint      : %v.\n", s.Field("Uint").Value())
	fmt.Printf("Value of Int       : %v.\n", s.Field("Int").Value())
	fmt.Printf("Sprint: %s.\n", s.Sprint())

	err = s.Field("Uint").Set(uint(654321))
	if err != nil {
		fmt.Printf("Set[Error]: %v.\n", err)
	}

	err = s.Field("Int").Set(6)
	if err != nil {
		fmt.Printf("Set[Error]: %v.\n", err)
	}

	err = s.Field("Bool").Set(6)
	if err != nil {
		fmt.Printf("Set[Error]: %v.\n", err)
	}

	fmt.Printf("Value of String    : %s.\n", s.Field("String").String()) // syntax for %s verb
	fmt.Printf("Value of Uint      : %d.\n", s.Field("Uint").Uint())     // syntax for %d verb
	fmt.Printf("Value of Int       : %d.\n", s.Field("Int").Int())       // syntax for %d verb
	fmt.Printf("Sprint: %s.\n", s.Sprint())
	fmt.Printf("\nVerification       :\n")
	fmt.Printf("t.String           : %s.\n", t.String)
	fmt.Printf("t.Uint             : %d.\n", t.Uint)
	fmt.Printf("t.Int              : %d.\n", t.Int)
}

Execute

go run main.go

Output

Name               : T.
Value of 1st field : Roninzo.
Value of Uint      : 123456.
Value of Int       : 5.
Sprint: {
	"String": "Roninzo",
	"Uint": 123456,
	"Bool": true,
	"Int": 5
	}.
Set[Error]: wrong kind of value for field T.Bool. got: 'int' want: 'bool'.
Value of String    : Roninzo.
Value of Uint      : 654321.
Value of Int       : 6.
Sprint: {
	"String": "Roninzo",
	"Uint": 654321,
	"Bool": true,
	"Int": 6
	}.

Verification       :
t.String           : Roninzo.
t.Uint             : 654321.
t.Int              : 6.

Caveat

Package API is not final yet.

Documentation

• pkg.go.dev/github.com/roninzo/structs

Dependencies

• github.com/pkg/errors
• github.com/stretchr/testify

Inspired/forked from

• github.com/fatih/structs (No longer maintained)
• github.com/PumpkinSeed/structs

To Do

• Extend support for Pointer to struct fields
• Extend support for Slice of any Type as struct fields
• Extend support for Map of any Type as struct fields
• Extend support for Method of struct
• Extend support for complex64/128 field types
• Implement Map
• Improve performance
• Improve coverage