query

Documentation

Overview

Package query provides support for query paging.

Index

• type Result
  • func NewResult[T any](items []T, total int, page page.Page) Result[T]
  • func (r Result[T]) Encode() ([]byte, string, error)

Types

type Result

type Result[T any] struct {
	Items       []T `json:"items"`
	Total       int `json:"total"`
	Page        int `json:"page"`
	RowsPerPage int `json:"rowsPerPage"`
}

Result is the data model used when returning a query result.

func NewResult

func NewResult[T any](items []T, total int, page page.Page) Result[T]

NewResult constructs a result value to return query results.

func (Result[T]) Encode

func (r Result[T]) Encode() ([]byte, string, error)

Encode implements the encoder interface.