pagination

package

v1.13.1-rc3 Latest Latest Go to latest Published: Jul 29, 2024 License: Apache-2.0 Imports: 2 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type Options struct {
	Page     *int32 `json:"page,omitempty"`
	PageSize *int32 `json:"page_size,omitempty"`
}

Options can be used to supply pagination filter options to APIs.

type Paginator struct {
	DefaultPage     int32
	DefaultPageSize int32
	MaxPageSize     int32
}

Paginator handles common pagination workflows.

func NewPaginator(defaultPage int32, defaultPageSize int32, maxPageSize int32) Paginator

func (p Paginator) NewPaginationOptions(page *int32, pageSize *int32) Options

func (p Paginator) ValidatePaginationParams(page *int32, pageSize *int32) error

type Paging struct {
	Page  int32 `json:"page,omitempty"`
	Pages int32 `json:"pages,omitempty"`
	Total int32 `json:"total,omitempty"`
}

Paging can be used to capture paging information in API responses.

func ToPaging(opts Options, count int) *Paging