paginator

Documentation

Index

• Variables
• type Paginator
  • func New(total, pageSize, current int) *Paginator
  • func (p *Paginator) Current() int
  • func (p *Paginator) GetURL() *url.URL
  • func (p *Paginator) HasNext() bool
  • func (p *Paginator) HasPrevious() bool
  • func (p *Paginator) IsFirst() bool
  • func (p *Paginator) IsLast() bool
  • func (p *Paginator) Links() []string
  • func (p *Paginator) Next() int
  • func (p *Paginator) PageSize() int
  • func (p *Paginator) Previous() int
  • func (p *Paginator) SetURL(u *url.URL)
  • func (p *Paginator) Total() int
  • func (p *Paginator) TotalPages() int

Variables

var (
	// QueryParameterPage is URL query parameter to specify page number.
	QueryParameterPage = "page"
	// QueryParameterPage is URL query parameter to specify page size.
	QueryParameterPerPage = "per_page"
)

Types

type Paginator

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

Paginator represents a set of results of pagination calculations.

func New

func New(total, pageSize, current int) *Paginator

New initialize a new pagination calculation and returns a Paginator as result.

func (*Paginator) Current

func (p *Paginator) Current() int

Current returns current page number.

func (*Paginator) GetURL

func (p *Paginator) GetURL() *url.URL

GetURL gets the page URL used for link generation.

func (*Paginator) HasNext

func (p *Paginator) HasNext() bool

HasNext returns true if there is a next page relative to current page.

func (*Paginator) HasPrevious

func (p *Paginator) HasPrevious() bool

HasPrevious returns true if there is a previous page relative to current page.

func (*Paginator) IsFirst

func (p *Paginator) IsFirst() bool

IsFirst returns true if current page is the first page.

func (*Paginator) IsLast

func (p *Paginator) IsLast() bool

IsLast returns true if current page is the last page.

func (*Paginator) Links

func (p *Paginator) Links() []string

Links return the pagination links

func (*Paginator) Next

func (p *Paginator) Next() int

func (*Paginator) PageSize

func (p *Paginator) PageSize() int

PageSize returns page size.

func (*Paginator) Previous

func (p *Paginator) Previous() int

func (*Paginator) SetURL

func (p *Paginator) SetURL(u *url.URL)

SetURL sets the page URL used for link generation.

func (*Paginator) Total

func (p *Paginator) Total() int

Total returns number of total rows.

func (*Paginator) TotalPages

func (p *Paginator) TotalPages() int

TotalPage returns number of total pages.