pagination

Documentation

Index

• Constants
• func CalculatePageSize(c Calculation) int
• type Calculation
• type Result
  • func (r *Result) Description() string
  • func (r *Result) Identifier() string
  • func (r *Result) Type() types.TypeMeta
• type Token

Constants

const ResultKind = "PageInfo"

ResultKind represents the result object kind.

Functions

func CalculatePageSize

func CalculatePageSize(c Calculation) int

CalculatePageSize calculates the desired page size for paginated queries.

Types

type Calculation

type Calculation struct {
	// GotItems is how many items we currently have received.
	GotItems int
	// MaxItems is how many items we want in total.
	MaxItems int
	// MaxPageSize is the maximum number of items we want to query for per request.
	MaxPageSize int
}

Calculation contains all the info needed to calculate a request's page size.

type Result

type Result struct {
	Kind          string `json:"kind"`
	Message       string `json:"message"`
	NextPageToken Token  `json:"next_page_token"`
	FullCommand   string `json:"full_command"`
}

Result is a printable object that shows the pagination kind. Implements the types.Object interface as a noop.

func (*Result) Description

func (r *Result) Description() string

Description returns an empty description.

func (*Result) Identifier

func (r *Result) Identifier() string

Identifier returns an empty identifier.

func (*Result) Type

func (r *Result) Type() types.TypeMeta

Type returns an empty TypeMeta.

type Token

type Token string

Token represents a pagination token.