struct.field.go

package dstruct

import (
	"fmt"
	"reflect"
	"strconv"
)

type StructField struct {
	name              string
	tag               reflect.StructTag
	value             reflect.Value
	dstructType       reflect.Type
	typeHash          string
	pkgPath           string
	anonymous         bool
	jsonName          string
	qualifiedName     string
	ptrDepth          int
	ptrKind           reflect.Kind
	structIndex       *int
	numberOfSubFields *int
}

func (f StructField) IsFieldDereferencable() bool {
	if f.value.Kind() == reflect.Pointer {
		return f.ptrKind != reflect.Invalid
	}

	return true
}

// GetFieldName returns the name of the field.
func (f StructField) GetFieldName() string {
	return f.name
}

// GetValue returns the value of the field.
func (f StructField) GetValue() any {
	return f.value.Interface()
}

// GetDstructType returns the Dstruct type of the field which can be different from the Go type (reflect.TypeOf(val))
func (f StructField) GetDstructType() reflect.Type {
	return f.dstructType
}

// GetTypeHash returns the hash of the type of the field.
func (f StructField) GetTypeHash() string {
	return f.typeHash
}

// GetQualifiedName returns the fully qualified name of the field.
func (f StructField) GetQualifiedName() string {
	return f.qualifiedName
}

// GetTag returns the tag of the field.
func (f StructField) GetTag(t string) string {
	return f.tag.Get(t)
}

// GetJsonName returns the json name of the field.
func (f StructField) GetJsonName() string {
	return f.jsonName
}

// TODO: shoudl this even be here as it is not used ?
func (f StructField) GetEnumValues() (enumValues map[string]int) {
	enum, ok := f.tag.Lookup("enum")
	if ok {
		numEnums, err := strconv.Atoi(enum)
		if err != nil {
			return
		}
		enumValues = make(map[string]int)
		for i := 1; i <= numEnums; i++ {
			if key := f.tag.Get(fmt.Sprintf("enum_%d", i)); key != "" {
				enumValues[key] = i
			}
		}
	}
	return
}