paging

Documentation

Index

• Variables
• type FirstSpec
  • func (f *FirstSpec) Query(query *url.Values)
  • func (f *FirstSpec) Size() int
• type FullSpec
  • func (p *FullSpec) Next() NextSpec
  • func (p *FullSpec) Prev() PreviousSpec
  • func (f *FullSpec) Query(query *url.Values)
  • func (f *FullSpec) Size() int
• type NextSpec
  • func (f *NextSpec) Query(query *url.Values)
  • func (f *NextSpec) Size() int
• type Page
  • func FromQuery(c *gin.Context) Page
• type Paging
• type PreviousSpec
  • func (f *PreviousSpec) Query(query *url.Values)
  • func (f *PreviousSpec) Size() int

Variables

var (
	DefaultPageSize     = 10
	PageStartQueryParam = "s"
	PageEndQueryParam   = "e"
	PageSizeQueryParam  = "l"
)

Types

type FirstSpec

type FirstSpec struct {
	PageSize int `json:"size"`
}

func (*FirstSpec) Query

func (f *FirstSpec) Query(query *url.Values)

func (*FirstSpec) Size

func (f *FirstSpec) Size() int

type FullSpec

type FullSpec struct {
	// StartIDIncl is the start ID (inclusive), might be empty if page contains no elements
	StartIDIncl string `json:"start,omitempty"`
	// EndIDIncl is the end ID (inclusive), might be empty if page contains no elements
	EndIDIncl string `json:"end,omitempty"`
	PageSize  int    `json:"size"`
}

func (*FullSpec) Next

func (p *FullSpec) Next() NextSpec

func (*FullSpec) Prev

func (p *FullSpec) Prev() PreviousSpec

func (*FullSpec) Query

func (f *FullSpec) Query(query *url.Values)

func (*FullSpec) Size

func (f *FullSpec) Size() int

type NextSpec

type NextSpec struct {
	StartIDExcl string `json:"start"`
	PageSize    int    `json:"size"`
}

func (*NextSpec) Query

func (f *NextSpec) Query(query *url.Values)

func (*NextSpec) Size

func (f *NextSpec) Size() int

type Page

type Page interface {
	Size() int
	Query(query *url.Values)
}

func FromQuery

func FromQuery(c *gin.Context) Page

type Paging

type Paging struct {
	Previous *PreviousSpec `json:"prev,omitempty"`
	Current  FullSpec      `json:"cur"`
	Next     *NextSpec     `json:"next,omitempty"`
}

type PreviousSpec

type PreviousSpec struct {
	EndIDExcl string `json:"end"`
	PageSize  int    `json:"size"`
}

func (*PreviousSpec) Query

func (f *PreviousSpec) Query(query *url.Values)

func (*PreviousSpec) Size

func (f *PreviousSpec) Size() int