micro_utils.dokka/dev.inmo.micro_utils.pagination

Package dev.inmo.micro_utils.pagination

Types

Pagination

interface Pagination : ClosedRange<Int>

Base interface of pagination

interface Pagination : ClosedRange<Int>

Base interface of pagination

interface Pagination : ClosedRange<Int>

Base interface of pagination

PaginationResult

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

SimplePagination

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

Functions

calculatePage

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 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 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

changeResults

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>

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>

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>

FirstPagePagination

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

intersect

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

inline fun Pagination.nextPage(): SimplePagination

nextPageIfNotEmpty

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

paginate

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>

Pagination