field

Documentation

Index

• Constants
• type BoolParser
  • func (BoolParser) ParseForm(field string) (any, error)
• type CannotParseErr
  • func (i CannotParseErr) Error() string
• type Complex64Parser
  • func (Complex64Parser) ParseForm(field string) (any, error)
• type Complex128Parser
  • func (Complex128Parser) ParseForm(field string) (any, error)
• type Field
  • func New(f reflect.StructField) (Field, error)
  • func (f *Field) Decode(values url.Values, target reflect.Value) error
• type Float32Parser
  • func (Float32Parser) ParseForm(field string) (any, error)
• type Float64Parser
  • func (Float64Parser) ParseForm(field string) (any, error)
• type Int8Parser
  • func (Int8Parser) ParseForm(field string) (any, error)
• type Int16Parser
  • func (Int16Parser) ParseForm(field string) (any, error)
• type Int32Parser
  • func (Int32Parser) ParseForm(field string) (any, error)
• type Int64Parser
  • func (Int64Parser) ParseForm(field string) (any, error)
• type IntParser
  • func (IntParser) ParseForm(field string) (any, error)
• type Parser
• type RequiredFieldMissingErr
  • func (r RequiredFieldMissingErr) Error() string
• type StringParser
  • func (StringParser) ParseForm(field string) (any, error)
• type Tag
  • func ParseTag(tag string) Tag
  • func (t Tag) FieldName(fieldName string) string
• type Uint8Parser
  • func (Uint8Parser) ParseForm(field string) (any, error)
• type Uint16Parser
  • func (Uint16Parser) ParseForm(field string) (any, error)
• type Uint32Parser
  • func (Uint32Parser) ParseForm(field string) (any, error)
• type Uint64Parser
  • func (Uint64Parser) ParseForm(field string) (any, error)
• type UintParser
  • func (UintParser) ParseForm(field string) (any, error)

Constants

const (
	TagName = "form"
)

Types

type BoolParser

type BoolParser struct{}

func (BoolParser) ParseForm

func (BoolParser) ParseForm(field string) (any, error)

type CannotParseErr

type CannotParseErr struct {
	Kind reflect.Kind
}

func (CannotParseErr) Error

func (i CannotParseErr) Error() string

type Complex64Parser

type Complex64Parser struct{}

func (Complex64Parser) ParseForm

func (Complex64Parser) ParseForm(field string) (any, error)

type Complex128Parser

type Complex128Parser struct{}

func (Complex128Parser) ParseForm

func (Complex128Parser) ParseForm(field string) (any, error)

type Field

type Field struct {
	// Name is the name of the field inside the struct
	Name string
	// Parser used to turn string value into Field type
	Parser Parser
	// MetaData contains additional Tag metadata used during decoding
	MetaData Tag
	// contains filtered or unexported fields
}

Field contains the metadata and type parser to decode a key-value pair from url.Values into a struct field.

func New

func New(f reflect.StructField) (Field, error)

func (*Field) Decode

func (f *Field) Decode(values url.Values, target reflect.Value) error

Decode retrieves value from url.Values, converts its value into the target type and then sets the value on target

type Float32Parser

type Float32Parser struct{}

func (Float32Parser) ParseForm

func (Float32Parser) ParseForm(field string) (any, error)

type Float64Parser

type Float64Parser struct{}

func (Float64Parser) ParseForm

func (Float64Parser) ParseForm(field string) (any, error)

type Int8Parser

type Int8Parser struct{}

func (Int8Parser) ParseForm

func (Int8Parser) ParseForm(field string) (any, error)

type Int16Parser

type Int16Parser struct{}

func (Int16Parser) ParseForm

func (Int16Parser) ParseForm(field string) (any, error)

type Int32Parser

type Int32Parser struct{}

func (Int32Parser) ParseForm

func (Int32Parser) ParseForm(field string) (any, error)

type Int64Parser

type Int64Parser struct{}

func (Int64Parser) ParseForm

func (Int64Parser) ParseForm(field string) (any, error)

type IntParser

type IntParser struct{}

IntParser parses the field string as a 64 bit int and casts it to int

func (IntParser) ParseForm

func (IntParser) ParseForm(field string) (any, error)

type Parser

type Parser interface {
	// ParseForm converts a string into a type.
	ParseForm(field string) (any, error)
}

Parser converts a string into a type. Which type is controlled by the implementation of the Parser. Parser must always return the same type.

type RequiredFieldMissingErr

type RequiredFieldMissingErr struct {
	Field string
}

func (RequiredFieldMissingErr) Error

func (r RequiredFieldMissingErr) Error() string

type StringParser

type StringParser struct{}

StringParser returns the field string unchanged

func (StringParser) ParseForm

func (StringParser) ParseForm(field string) (any, error)

type Tag

type Tag struct {
	// If Alias is not an empty string, it will be used instead of the struct field name.
	Alias string
	// If Required is true decode will fail if FieldName is not present in url.Values.
	Required bool
	// If Regex is not nil it will be used to validate the field value before decoding it.
	Regex *regexp.Regexp
}

Tag represents the configuration options that can be with the struct tag (see TagName) set on struct fields.

func ParseTag

func ParseTag(tag string) Tag

ParseTag parses the string of the struct tag into a Tag struct

func (Tag) FieldName

func (t Tag) FieldName(fieldName string) string

FieldName returns the key for the url.Values lookup.

type Uint8Parser

type Uint8Parser struct{}

func (Uint8Parser) ParseForm

func (Uint8Parser) ParseForm(field string) (any, error)

type Uint16Parser

type Uint16Parser struct{}

func (Uint16Parser) ParseForm

func (Uint16Parser) ParseForm(field string) (any, error)

type Uint32Parser

type Uint32Parser struct{}

func (Uint32Parser) ParseForm

func (Uint32Parser) ParseForm(field string) (any, error)

type Uint64Parser

type Uint64Parser struct{}

func (Uint64Parser) ParseForm

func (Uint64Parser) ParseForm(field string) (any, error)

type UintParser

type UintParser struct{}

UintParser parses the field string as a 64 bit uint and casts it to uint

func (UintParser) ParseForm

func (UintParser) ParseForm(field string) (any, error)