DataPage

Description

The DataPage class allows you to create a data transfer object that can be used to pass the results of a paginated query. This object contains items of the retrieved page.

Important points

• Most often, this object type is used to send responses to paginated queries.
• Pagination parameters are defined by a PagingParams object.
• The skip parameter in the PagingParams indicates how many items to skip.
• The takes parameter sets number of items to return in the page.
• An optional total paramter allows you to specify the total number of items returned from a request. However, not all implementations support the total parameter because its generation may lead to severe performance implications.

Constructors

NewDataPage

Creates a new instance of data page and assigns its values.

NewDataPage[T any](data []T, total int) *DataPage[T]

• data: *int64 - list of items from the retrieved page.
• total: []any - total amount of items in a request.

NewEmptyDataPage

Creates a new empty instance of data page.

NewEmptyDataPageT any *DataPage

Fields

Methods

HasData

HasData method check if data exists

(d *DataPage[T]) HasData() bool

• returns: bool - result flag.

MarshalJSON

Converts DataPage to json bytes

(d DataPage[T]) MarshalJSON() ([]byte, error)

• returns: ([]byte, error) - marshal result or error.

Examples

page, err := myDataClient.GetDataByFilter(
	context.Background(),
	"123",
	NewFilterParamsFromTuples("completed": true),
	NewPagingParams(0, 100, true),
)

if err != nil {
	panic(err)
}

for item range page.Data {
    fmt.Println(item)
}

See also

• PagingParams