paginator

Documentation

Index

• Constants
• type Iterator
• type PaginatedResponse
• type PaginationArgs
  • func (pa *PaginationArgs) Parse(c *webcontext.Context)
• type PaginationLinks
• type Paginator
  • func New[T any]() *Paginator[T]
  • func (pr *Paginator[T]) Paginate(c *webcontext.Context, getPage func(limit, offset int) (Iterator[T], error)) (*PaginatedResponse[T], error)

Constants

const (
	DEFAULT_PAGINATION_LIMIT     = 100
	DEFAULT_MAX_PAGINATION_LIMIT = 500
)

Types

type Iterator

type Iterator[T any] interface {
	HasNext() bool
	GetRow() (T, error)
	Count() (uint64, error)
}

type PaginatedResponse

type PaginatedResponse[Obj interface{}] struct {
	Links   PaginationLinks `json:"_links"`
	Count   uint64          `json:"count"`
	Results []Obj           `json:"results"`
}

type PaginationArgs

type PaginationArgs struct {
	Limit  *int `json:"limit"`
	Offset *int `json:"offset"`
	// contains filtered or unexported fields
}

func (*PaginationArgs) Parse

func (pa *PaginationArgs) Parse(c *webcontext.Context)

type PaginationLinks

type PaginationLinks struct {
	Next     *string `json:"next"`
	Previous *string `json:"previous"`
}

type Paginator

type Paginator[T any] struct {
	DefaultLimit  int
	DefaultOffset int
	MaxLimit      int
}

func New

func New[T any]() *Paginator[T]

func (*Paginator[T]) Paginate

func (pr *Paginator[T]) Paginate(c *webcontext.Context, getPage func(limit, offset int) (Iterator[T], error)) (*PaginatedResponse[T], error)

Paginate mounts a PaginatedResponse. It expects a getPage function that receives limit and offset integers and returns an iterator, the total of rows and an error