flat

Documentation

Overview

Package flat provides a flat view of an arbitrary nested structs.

Index

• Variables
• type Field
• type Fields
  • func View(s any) (Fields, error)

Variables

var ErrUnexpectedType = errors.New("unexpected type, expecting a pointer to struct")

ErrUnexpectedType is returned when flatten sees an unsupported type.

Types

type Field

type Field interface {
	Name() string
	EnvName() string
	Tag(key string) (string, bool)

	Meta() map[string]string

	String() string
	Set(value string) error
	IsZero() bool

	FieldValue() reflect.Value
	FieldType() reflect.StructField
}

Field describe an interface to our flat structs fields.

type Fields

type Fields []Field

Fields is a slice of Field.

func View

func View(s any) (Fields, error)

View provides a flat view of the provided structs an array of fields. sub-struct fields are prefixed with the struct key (not type) followed by a dot, this is repeated for each nested level.