doc: add docment for new or fixed function

structs/field.go

@@ -26,26 +26,31 @@ func newField(v reflect.Value, f reflect.StructField, tagName string) *Field {
 }
 
 // Tag returns the value that the key in the tag string.
+// Play: https://go.dev/play/p/DVrx5HvvUJr
 func (f *Field) Tag() *Tag {
 	return f.tag
 }
 
 // Value returns the underlying value of the field.
+// Play: https://go.dev/play/p/qufYEU2o4Oi
 func (f *Field) Value() any {
 	return f.rvalue.Interface()
 }
 
 // IsEmbedded returns true if the given field is an embedded field.
+// Play: https://go.dev/play/p/wV2PrbYm3Ec
 func (f *Field) IsEmbedded() bool {
 	return len(f.field.Index) > 1
 }
 
 // IsExported returns true if the given field is exported.
+// Play: https://go.dev/play/p/csK4AXYaNbJ
 func (f *Field) IsExported() bool {
 	return f.field.IsExported()
 }
 
 // IsZero returns true if the given field is zero value.
+// Play: https://go.dev/play/p/RzqpGISf87r
 func (f *Field) IsZero() bool {
 	z := reflect.Zero(f.rvalue.Type()).Interface()
 	v := f.Value()
@@ -63,22 +68,26 @@ func (f *Field) IsNil() bool {
 }
 
 // Name returns the name of the given field
+// Play: https://go.dev/play/p/zfIGlqsatee
 func (f *Field) Name() string {
 	return f.field.Name
 }
 
 // Kind returns the field's kind
+// Play: https://go.dev/play/p/wg4NlcUNG5o
 func (f *Field) Kind() reflect.Kind {
 	return f.rvalue.Kind()
 }
 
 // IsSlice check if a struct field type is slice or not
+// Play: https://go.dev/play/p/MKz4CgBIUrU
 func (f *Field) IsSlice() bool {
 	k := f.rvalue.Kind()
 	return k == reflect.Slice
 }
 
 // IsTargetType check if a struct field type is target type or not
+// Play: https://go.dev/play/p/Ig75P-agN39
 func (f *Field) IsTargetType(targetType reflect.Kind) bool {
 	return f.rvalue.Kind() == targetType
 }

structs/struct.go

@@ -20,6 +20,7 @@ type Struct struct {
 }
 
 // New returns a new *Struct
+// Play: https://go.dev/play/p/O29l8kk-Z17
 func New(value any, tagName ...string) *Struct {
 	value = pointer.ExtractPointer(value)
 	v := reflect.ValueOf(value)
@@ -60,6 +61,7 @@ func New(value any, tagName ...string) *Struct {
 //	 	Name string `json:"myName"`
 //
 // ToMap convert the exported fields of a struct to map.
+// Play: https://go.dev/play/p/qQbLySBgerZ
 func (s *Struct) ToMap() (map[string]any, error) {
 	if !s.IsStruct() {
 		return nil, fmt.Errorf("invalid struct %v", s)
@@ -87,6 +89,7 @@ func (s *Struct) ToMap() (map[string]any, error) {
 }
 
 // Fields returns all the struct fields within a slice
+// Play: https://go.dev/play/p/w3Kk_CyVY7D
 func (s *Struct) Fields() []*Field {
 	fieldNum := s.rvalue.NumField()
 	fields := make([]*Field, 0, fieldNum)
@@ -100,6 +103,7 @@ func (s *Struct) Fields() []*Field {
 }
 
 // Field returns a Field if the given field name was found
+// Play: https://go.dev/play/p/KocZMSYarza
 func (s *Struct) Field(name string) (*Field, bool) {
 	f, ok := s.rtype.FieldByName(name)
 	if !ok {
@@ -109,6 +113,7 @@ func (s *Struct) Field(name string) (*Field, bool) {
 }
 
 // IsStruct returns true if the given rvalue is a struct
+// Play: https://go.dev/play/p/bU2FSdkbK1C
 func (s *Struct) IsStruct() bool {
 	k := s.rvalue.Kind()
 	if k == reflect.Invalid {
@@ -119,11 +124,13 @@ func (s *Struct) IsStruct() bool {
 
 // ToMap convert struct to map, only convert exported struct field
 // map key is specified same as struct field tag `json` value.
+// Play: https://go.dev/play/p/qQbLySBgerZ
 func ToMap(v any) (map[string]any, error) {
 	return New(v).ToMap()
 }
 
 // TypeName return struct type name
+// Play: https://go.dev/play/p/todo
 func (s *Struct) TypeName() string {
 	return s.rtype.Name()
 }