micro_utils.dokka/dev.inmo.micro_utils.pagination/PaginationResult

PaginationResult

@Serializable

data class PaginationResult<T>(val page: Int, val size: Int, val results: List<T>, val objectsNumber: Long) : Pagination

Parameters

page

Current page number

size

Current page size. It can be greater than size of results

results

Result objects

objectsNumber

Count of all objects across all pages

Constructors

PaginationResult

fun <T> PaginationResult(page: Int, results: List<T>, pagesNumber: Int, size: Int)

PaginationResult

fun <T> PaginationResult(page: Int, size: Int, results: List<T>, objectsNumber: Long)

Functions

contains

open operator fun contains(value: Int): Boolean

isEmpty

open fun isEmpty(): Boolean

Properties

endInclusive

open override val endInclusive: Int

objectsNumber

val objectsNumber: Long

page

open override val page: Int

pagesNumber

val pagesNumber: Int

Amount of pages for current pagination

results

val results: List<T>

size

open override val size: Int

start

open override val start: Int

Extensions

asUrlQueryArrayParts

val Pagination.asUrlQueryArrayParts: Array<Pair<String, String>>

asUrlQueryParts

val Pagination.asUrlQueryParts: Map<String, String>

changeResults

fun <I, O> PaginationResult<I>.changeResults(data: List<O>): PaginationResult<O>

changeResultsUnchecked

fun <I, O> PaginationResult<I>.changeResultsUnchecked(data: List<O>): PaginationResult<O>

currentPageIfNotEmpty

inline fun <T> PaginationResult<T>.currentPageIfNotEmpty(): PaginationResult<T>?

firstIndex

val Pagination.firstIndex: Int

First number in index of objects. It can be used as offset for databases or other data sources

intersect

fun Pagination.intersect(other: Pagination): Pagination?

fun <T : Comparable<T>> ClosedRange<T>.intersect(other: ClosedRange<T>): Pair<T, T>?

isFirstPage

val Pagination.isFirstPage: Boolean

Logical shortcut for comparison that page is 0

lastIndex

val Pagination.lastIndex: Int

Last number in index of objects. In fact, one Pagination object represent data in next range:

lastIndexExclusive

val Pagination.lastIndexExclusive: Int

Last number in index of objects. In fact, one Pagination object represent data in next range:

limitClause

fun Pagination.limitClause(): String

inline fun Pagination.nextPage(): SimplePagination

nextPageIfNotEmpty

inline fun PaginationResult<*>.nextPageIfNotEmpty(): SimplePagination?

optionallyReverse

fun Pagination.optionallyReverse(objectsCount: Int, reverse: Boolean): Pagination

fun Pagination.optionallyReverse(objectsCount: Long, reverse: Boolean): Pagination

reverse

fun Pagination.reverse(datasetSize: Long): SimplePagination

Example:

fun Pagination.reverse(objectsCount: Int): SimplePagination

Shortcut for reverse

thisPageIfNotEmpty

inline fun <T> PaginationResult<T>.thisPageIfNotEmpty(): PaginationResult<T>?