sorts

Documentation

Index

• type Order
  • func (o Order) String() string
• type SortField
  • func (s *SortField) FormatQuery(q ...url.Values) url.Values
  • func (s *SortField) Order() Order
  • func (s *SortField) StructField() *mapping.StructField

Types

type Order

type Order int

Order is the enum used for the sorting values

const (
	// AscendingOrder defines the sorting ascending order
	AscendingOrder Order = iota

	// DescendingOrder defines the sorting descending order
	DescendingOrder
)

func (Order) String

func (o Order) String() string

String implements Stringer interface

type SortField

type SortField sorts.SortField

SortField is a field that contains sorting information

func (*SortField) FormatQuery

func (s *SortField) FormatQuery(q ...url.Values) url.Values

FormatQuery returns the sort field formatted for url query. If the optional argument 'q' is provided the format would be set into the provdied url.Values. Otherwise it creates new url.Values instance. Returns modified url.Values

func (*SortField) Order

func (s *SortField) Order() Order

Order returns sortfield's order

func (*SortField) StructField

func (s *SortField) StructField() *mapping.StructField

StructField returns sortfield's structure