micro_utils.dokka/dev.inmo.micro_utils.pagination/SimplePagination

SimplePagination

@Serializable

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

Parameters

page

Current page number

size

Current page size

Constructors

SimplePagination

constructor(page: Int, size: Int)

Functions

contains

open operator fun contains(value: Int): Boolean

intersect

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

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

isEmpty

open fun isEmpty(): Boolean

limitClause

fun Pagination.limitClause(): String

inline fun Pagination.nextPage(): SimplePagination

optionallyReverse

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

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

reverse

fun Pagination.reverse(objectsCount: Int): SimplePagination

Shortcut for reverse

fun Pagination.reverse(datasetSize: Long): SimplePagination

Example:

Properties

asUrlQueryArrayParts

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

asUrlQueryParts

val Pagination.asUrlQueryParts: Map<String, String>

endInclusive

open override val endInclusive: Int

firstIndex

val Pagination.firstIndex: Int

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

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:

page

open override val page: Int

size

open override val size: Int

start

open override val start: Int