repositories

Documentation

Index

• Variables
• type Order
  • func ParseOrder(order string) (Order, error)
  • func (o Order) String() string
• type OrderPaging
  • func (o OrderPaging) BuildPagingOrder(page uint32, size uint32, sorts []Sort) (string, error)
• type Sort

Variables

var (
	ErrOrderNotSupport     = errors.New("order not support")
	ErrPagingSize          = errors.New("paging size is too large")
	ErrNoFieldCanBeOrdered = errors.New("no field can be ordered")
	ErrFieldCannotOrder    = errors.New("field can't be ordered")
	ErrFieldCannotASC      = errors.New("field can't be ordered")
	ErrFieldCannotDESC     = errors.New("field can't be ordered")
)

Types

type Order

type Order uint8

const (
	ASC Order = 1 << iota
	DESC
)

func ParseOrder

func ParseOrder(order string) (Order, error)

func (Order) String

func (o Order) String() string

type OrderPaging

type OrderPaging struct {
	CanOrderFields map[string]Order
	MaxSize        uint32
}

func (OrderPaging) BuildPagingOrder

func (o OrderPaging) BuildPagingOrder(page uint32, size uint32, sorts []Sort) (string, error)

type Sort

type Sort struct {
	Name  string
	Order Order
}