pagination

Documentation

Index

• type InvalidError
  • func (e InvalidError) Error() string
• type Page
  • func NewPage(pageNumber int, pageSize int) Page
  • func NewPageFromRef(pageNumber *int, pageSize *int) Page
  • func (p Page) IsZero() bool
  • func (p Page) Limit() int
  • func (p Page) Offset() int
  • func (p Page) Validate() error
• type PagedResponse
  • func MapPagedResponse[Out any, In any](resp PagedResponse[In], m func(in In) Out) PagedResponse[Out]
  • func MapPagedResponseError[Out any, In any](resp PagedResponse[In], m func(in In) (Out, error)) (PagedResponse[Out], error)
  • func (p PagedResponse[T]) MarshalJSON() ([]byte, error)
• type Paginator

Types

type InvalidError

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

func (InvalidError) Error

func (e InvalidError) Error() string

type Page

type Page struct {
	PageSize   int `json:"pageSize"`
	PageNumber int `json:"page"`
}

func NewPage

func NewPage(pageNumber int, pageSize int) Page

NewPage creates a new Page with the given pageNumber and pageSize.

func NewPageFromRef

func NewPageFromRef(pageNumber *int, pageSize *int) Page

NewPageFromRef creates a new Page from pointers to pageNumber and pageSize. Useful for handling query parameters.

func (Page) IsZero

func (p Page) IsZero() bool

func (Page) Limit

func (p Page) Limit() int

func (Page) Offset

func (p Page) Offset() int

func (Page) Validate

func (p Page) Validate() error

type PagedResponse

type PagedResponse[T any] struct {
	Page       Page `json:"-"`
	TotalCount int  `json:"totalCount"`
	Items      []T  `json:"items"`
}

func MapPagedResponse

func MapPagedResponse[Out any, In any](resp PagedResponse[In], m func(in In) Out) PagedResponse[Out]

MapPagedResponse creates a new PagedResponse with the given page, totalCount and items.

func MapPagedResponseError

func MapPagedResponseError[Out any, In any](resp PagedResponse[In], m func(in In) (Out, error)) (PagedResponse[Out], error)

MapPagedResponseError is similar to MapPagedResponse but it allows the mapping function to return an error.

func (PagedResponse[T]) MarshalJSON

func (p PagedResponse[T]) MarshalJSON() ([]byte, error)

Implement json.Marshaler interface to flatten the Page struct

type Paginator

type Paginator[T any] interface {
	Paginate(ctx context.Context, page Page) (PagedResponse[T], error)
}