sorts

Documentation

Index

• Variables
• type Order
  • func (o Order) String() string
• type SortError
  • func (s *SortError) Error() string
• type SortField
  • func Copy(s *SortField) *SortField
  • func NewRawSortField(m *models.ModelStruct, sort string, disallowFK bool) (*SortField, error)
  • func NewSortField(sField *models.StructField, o Order, subs ...*SortField) *SortField
  • func (s *SortField) Order() Order
  • func (s *SortField) SetSubfield(sortSplitted []string, order Order, disallowFK bool) error
  • func (s *SortField) StructField() *models.StructField

Variables

var (
	MaxNestedRelLevel int = 1
)

Types

type Order

type Order int

Order is an enumerator that describes the order of sorting

const (
	AscendingOrder Order = iota
	DescendingOrder
)

func (Order) String

func (o Order) String() string

String implements Stringer interface

type SortError

type SortError struct {
	FieldName string
	Err       string
}

func (*SortError) Error

func (s *SortError) Error() string

type SortField

type SortField struct {
	// contains filtered or unexported fields
}

SortField is a field that describes the sorting rules for given

func Copy

func Copy(s *SortField) *SortField

Copy copies provided SortField

func NewRawSortField

func NewRawSortField(m *models.ModelStruct, sort string, disallowFK bool) (*SortField, error)

NewRawSortField returns raw sortfield

func NewSortField

func NewSortField(sField *models.StructField, o Order, subs ...*SortField) *SortField

NewSortField creates new sortField

func (*SortField) Order

func (s *SortField) Order() Order

Order returns sortFields order

func (*SortField) SetSubfield

func (s *SortField) SetSubfield(sortSplitted []string, order Order, disallowFK bool) error

SetSubfield sets the subfield for given sortfield

func (*SortField) StructField

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

StructField returns sortField's structure