paging

Documentation

Index

• Constants
• func IsCountOnly(p *dsc2.PaginationRequest) bool
• func PageSize(input int32) int32
• type Cursor
  • func DecodeCursor(encoded string) (*Cursor, error)
  • func (c *Cursor) Encode() (string, error)
• type KeyComparer
• type KeyMapper
• type Result
  • func PaginateSlice[T any](s []T, page *dsc2.PaginationRequest, keyCount int, cmp KeyComparer[T], ...) (*Result[T], error)

Constants

const (
	// DefaultPageSize default pagination page size.
	DefaultPageSize = int32(100)
	// MinPageSize minimum pagination page size.
	MinPageSize = int32(1)
	// MaxPageSize maximum pagination page size.
	MaxPageSize = int32(100)
	// ServerSetPageSize .
	ServerSetPageSize = int32(0)
	// SingleResultSet (INTERNAL USE ONLY).
	SingleResultSet = int32(-1)
	// TotalsOnlyResultSet .
	TotalsOnlyResultSet = int32(-2)
)

Functions

func IsCountOnly

func IsCountOnly(p *dsc2.PaginationRequest) bool

func PageSize

func PageSize(input int32) int32

PageSize validator.

Types

type Cursor

type Cursor struct {
	OptsHash uint64
	Keys     []string
}

func DecodeCursor

func DecodeCursor(encoded string) (*Cursor, error)

func (*Cursor) Encode

func (c *Cursor) Encode() (string, error)

type KeyComparer

type KeyComparer[T any] func([]string, T) bool

type KeyMapper

type KeyMapper[T any] func(T) []string

type Result

type Result[T any] struct {
	Items    []T
	PageInfo *dsc2.PaginationResponse
}

func PaginateSlice

func PaginateSlice[T any](
	s []T,
	page *dsc2.PaginationRequest,
	keyCount int,
	cmp KeyComparer[T],
	mapper KeyMapper[T],
) (*Result[T], error)