urlstruct

Documentation

Index

• func Unmarshal(ctx context.Context, values url.Values, strct interface{}) error
• type Field
  • func (f *Field) Omit(value reflect.Value) bool
  • func (f *Field) Value(strct reflect.Value) reflect.Value
• type OpCode
• type Pager
  • func NewPager(values url.Values) *Pager
  • func (p *Pager) GetLimit() int
  • func (p *Pager) GetOffset() int
  • func (p *Pager) GetPage() int
  • func (p *Pager) SetPage(page int)
  • func (p *Pager) UnmarshalValues(ctx context.Context, values url.Values) error
• type ParamUnmarshaler
• type StructInfo
  • func DescribeStruct(typ reflect.Type) *StructInfo
  • func (s *StructInfo) Field(name string) *Field
• type Unmarshaler
• type Values
  • func (v Values) Bool(name string) (bool, error)
  • func (v Values) Duration(name string) (time.Duration, error)
  • func (v Values) Float64(name string) (float64, error)
  • func (v Values) Has(name string) bool
  • func (v Values) Int(name string) (int, error)
  • func (v Values) Int64(name string) (int64, error)
  • func (v Values) MaybeBool(name string) bool
  • func (v Values) MaybeDuration(name string) time.Duration
  • func (v Values) MaybeFloat64(name string) float64
  • func (v Values) MaybeInt(name string) int
  • func (v Values) MaybeInt64(name string) int64
  • func (v Values) MaybeTime(name string) time.Time
  • func (v Values) Pager() *Pager
  • func (v Values) SetDefault(name string, values ...string)
  • func (v Values) String(name string) string
  • func (v Values) Strings(name string) []string
  • func (v Values) Time(name string) (time.Time, error)

Functions

func Unmarshal

func Unmarshal(ctx context.Context, values url.Values, strct interface{}) error

Unmarshal unmarshals url values into the struct.

Types

type Field

type Field struct {
	Type  reflect.Type
	Name  string
	Index []int
	Tag   *tagparser.Tag

	Column string
	Op     OpCode
	// contains filtered or unexported fields
}

func (*Field) Omit

func (f *Field) Omit(value reflect.Value) bool

func (*Field) Value

func (f *Field) Value(strct reflect.Value) reflect.Value

type OpCode

type OpCode int

const (
	OpEq OpCode = iota + 1
	OpNotEq
	OpLT
	OpLTE
	OpGT
	OpGTE
	OpIEq
	OpMatch
)

type Pager

type Pager struct {
	Limit  int `urlstruct:"-"`
	Offset int `urlstruct:"-"`

	// Default max limit is 1000.
	MaxLimit int `urlstruct:"-"`
	// Default max offset is 1000000.
	MaxOffset int `urlstruct:"-"`
	// contains filtered or unexported fields
}

func NewPager

func NewPager(values url.Values) *Pager

func (*Pager) GetLimit

func (p *Pager) GetLimit() int

func (*Pager) GetOffset

func (p *Pager) GetOffset() int

func (*Pager) GetPage

func (p *Pager) GetPage() int

func (*Pager) SetPage

func (p *Pager) SetPage(page int)

func (*Pager) UnmarshalValues

func (p *Pager) UnmarshalValues(ctx context.Context, values url.Values) error

type ParamUnmarshaler

type ParamUnmarshaler interface {
	UnmarshalParam(ctx context.Context, name string, values []string) error
}

type StructInfo

type StructInfo struct {
	TableName string
	Fields    []*Field
	// contains filtered or unexported fields
}

func DescribeStruct

func DescribeStruct(typ reflect.Type) *StructInfo

func (*StructInfo) Field

func (s *StructInfo) Field(name string) *Field

type Unmarshaler

type Unmarshaler interface {
	UnmarshalValues(ctx context.Context, values url.Values) error
}

type Values

type Values url.Values

func (Values) Bool

func (v Values) Bool(name string) (bool, error)

func (Values) Duration

func (v Values) Duration(name string) (time.Duration, error)

func (Values) Float64

func (v Values) Float64(name string) (float64, error)

func (Values) Has

func (v Values) Has(name string) bool

func (Values) Int

func (v Values) Int(name string) (int, error)

func (Values) Int64

func (v Values) Int64(name string) (int64, error)

func (Values) MaybeBool

func (v Values) MaybeBool(name string) bool

func (Values) MaybeDuration

func (v Values) MaybeDuration(name string) time.Duration

func (Values) MaybeFloat64

func (v Values) MaybeFloat64(name string) float64

func (Values) MaybeInt

func (v Values) MaybeInt(name string) int

func (Values) MaybeInt64

func (v Values) MaybeInt64(name string) int64

func (Values) MaybeTime

func (v Values) MaybeTime(name string) time.Time

func (Values) Pager

func (v Values) Pager() *Pager

func (Values) SetDefault

func (v Values) SetDefault(name string, values ...string)

func (Values) String

func (v Values) String(name string) string

func (Values) Strings

func (v Values) Strings(name string) []string

func (Values) Time

func (v Values) Time(name string) (time.Time, error)