micro_utils.dokka/dev.inmo.micro_utils.pagination

Package-level declarations

Types

interface Pagination : ClosedRange<Int>

Base interface of pagination

PaginationResult

@Serializable

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

SimplePagination

@Serializable

data class SimplePagination(val page: Int, val size: Int) : Pagination

Properties

asUrlQueryArrayParts

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

asUrlQueryParts

val Pagination.asUrlQueryParts: Map<String, String>

defaultExtraLargePageSize

const val defaultExtraLargePageSize: Int = 15

defaultLargePageSize

const val defaultLargePageSize: Int = 10

defaultMediumPageSize

const val defaultMediumPageSize: Int = 5

defaultPaginationPageSize

var defaultPaginationPageSize: Int

defaultSmallPageSize

const val defaultSmallPageSize: Int = 2

emptyPagination

val emptyPagination: SimplePagination

extractPagination

val Map<String, String?>.extractPagination: Pagination

val <Error class: unknown class>.extractPagination: Pagination

val <Error class: unknown class>.extractPagination: Pagination

val Pagination.firstIndex: Int

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

firstPageWithOneElementPagination

val firstPageWithOneElementPagination: SimplePagination

val Pagination.isFirstPage: Boolean

Logical shortcut for comparison that page is 0

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:

paginationPageKey

const val paginationPageKey: String

paginationSizeKey

const val paginationSizeKey: String

Functions

fun calculatePage(firstIndex: Int, resultsSize: Int): Int

calculatePagesNumber

fun calculatePagesNumber(datasetSize: Int, pageSize: Int): Int

fun calculatePagesNumber(datasetSize: Long, pageSize: Int): Int

Calculates pages count for given datasetSize

fun calculatePagesNumber(pageSize: Int, datasetSize: Long): Int

Calculates pages count for given datasetSize. As a fact, it is shortcut for calculatePagesNumber

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

changeResultsUnchecked

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

createPaginationResult

fun <T> Pair<Long, List<T>>.createPaginationResult(pagination: Pagination): PaginationResult<T>

fun <T> List<T>.createPaginationResult(pagination: Pagination, commonObjectsNumber: Long): PaginationResult<T>

fun <T> List<T>.createPaginationResult(firstIndex: Int, commonObjectsNumber: Long): PaginationResult<T>

currentPageIfNotEmpty

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

doWithPagination

inline fun doWithPagination(startPagination: Pagination = FirstPagePagination(), requestMaker: (pagination: Pagination) -> Pagination?)

emptyPaginationResult

fun <T> emptyPaginationResult(): PaginationResult<T>

fun <T> emptyPaginationResult(basePagination: Pagination): PaginationResult<T>

FirstPagePagination

inline fun FirstPagePagination(size: Int = defaultPaginationPageSize): SimplePagination

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

inline fun Pagination.nextPage(): SimplePagination

nextPageIfNotEmpty

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

fun <Error class: unknown class>.paginate(with: Pagination, orderBy: Pair<<Error class: unknown class><out <Error class: unknown class>>, <Error class: unknown class>>? = null): <Error class: unknown class>

fun <Error class: unknown class>.paginate(with: Pagination, orderBy: <Error class: unknown class><out <Error class: unknown class>>?, reversed: Boolean = false): <Error class: unknown class>

fun Pagination(page: Int, size: Int): SimplePagination

Factory for SimplePagination

PaginationByIndexes

fun PaginationByIndexes(firstIndex: Int, lastIndex: Int): SimplePagination

thisPageIfNotEmpty

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