# PaginatedIterable

class PaginatedIterable < T >(pageSize: Int , countGetter: () -> Long , paginationResultGetter: Pagination .() -> PaginationResult < T >) : Iterable < T > (source)

## Constructors

PaginatedIterable
Link copied to clipboard
constructor(pageSize: Int , countGetter: () -> Long , paginationResultGetter: Pagination .() -> PaginationResult < T >)

## Functions

awaitFirst
Link copied to clipboard
suspend fun < T > Iterable <Deferred< T >>. awaitFirst (cancelOthers: Boolean = true): T

Trying to Deferred.await on all thiss. The first Deferred completed its work will interrupt all others awaits and, if cancelOthers passed as true (by default), will also cancel all the others Deferreds

suspend fun < T > Iterable <Deferred< T >>. awaitFirst (scope: CoroutineScope, cancelOnResult: Boolean = true): T

Trying to Deferred.await on all thiss. The first Deferred completed its work will interrupt all others awaits and, if cancelOnResult passed as true (by default), will also cancel all the others Deferreds

awaitFirstWithDeferred
Link copied to clipboard
suspend fun < T > Iterable <Deferred< T >>. awaitFirstWithDeferred (scope: CoroutineScope, cancelOnResult: Boolean = true): Pair <Deferred< T >, T >

Trying to Deferred.await on all thiss. The first Deferred completed its work will interrupt all others awaits and, if cancelOnResult passed as true (by default), will also cancel all the others Deferreds

calculateDiff
Link copied to clipboard
fun < T > Iterable < T >. calculateDiff (other: Iterable < T >, strictComparison: Boolean = false): Diff < T >
fun < T > Iterable < T >. calculateDiff (other: Iterable < T >, comparisonFun: ( T ?, T ?) -> Boolean ): Diff < T >

Calculating Diff object

calculateStrictDiff
Link copied to clipboard
inline fun < T > Iterable < T >. calculateStrictDiff (other: Iterable < T >): Diff < T >

This method call calculateDiff with strict mode enabled

diff
Link copied to clipboard
inline fun < T > Iterable < T >. diff (other: Iterable < T >, strictComparison: Boolean = false): Diff < T >
inline fun < T > Iterable < T >. diff (other: Iterable < T >, noinline comparisonFun: ( T ?, T ?) -> Boolean ): Diff < T >
firstNotNull
Link copied to clipboard
fun < T > Iterable < T ?>. firstNotNull (): <Error class: unknown class>
invokeFirstOf
Link copied to clipboard
suspend fun < O > Iterable < DeferredAction <*, O >>. invokeFirstOf (scope: CoroutineScope, cancelOnResult: Boolean = true): O
invokeOnFirst
Link copied to clipboard
suspend fun < T , O > Iterable <Deferred< T >>. invokeOnFirst (scope: CoroutineScope, cancelOnResult: Boolean = true, callback: suspend ( T ) -> O ): O
iterator
Link copied to clipboard
open operator override fun iterator (): Iterator < T >
joinFirst
Link copied to clipboard
suspend fun Iterable <Job>. joinFirst (cancelOthers: Boolean = true): Job
suspend fun Iterable <Job>. joinFirst (scope: CoroutineScope, cancelOthers: Boolean = true): Job

Trying to Job.join on all thiss. The first Job completed its work will interrupt all others joins and, if cancelOthers passed as true (by default), will also cancel all the others Jobs

joinTo
Link copied to clipboard
inline fun < I > Iterable < I >. joinTo (separator: I ? = null, prefix: I ? = null, postfix: I ? = null): List < I >
inline fun < I > Iterable < I >. joinTo (separatorFun: ( I ) -> I ?, prefix: I ? = null, postfix: I ? = null): List < I >
inline fun < I , R > Iterable < I >. joinTo (separator: R ? = null, prefix: R ? = null, postfix: R ? = null, transform: ( I ) -> R ?): List < R >
inline fun < I , R > Iterable < I >. joinTo (separatorFun: ( I ) -> R ?, prefix: R ? = null, postfix: R ? = null, transform: ( I ) -> R ?): List < R >
mapNotNullA
Link copied to clipboard
inline fun < T , R > Iterable < T >. mapNotNullA (transform: ( T ) -> R ?): List < R >
optionallyReverse
Link copied to clipboard
fun < T > Iterable < T >. optionallyReverse (reverse: Boolean ): Iterable < T >
paginate
Link copied to clipboard
fun < T > Iterable < T >. paginate (with: Pagination ): PaginationResult < T >
withReplaced
Link copied to clipboard
fun < T > Iterable < T >. withReplaced (t: T , block: ( T ) -> T ): List < T >
withReplacedAt
Link copied to clipboard
fun < T > Iterable < T >. withReplacedAt (i: Int , block: ( T ) -> T ): List < T >