PagingState

Added in 3.0.0

Kotlin |Java

Cmn

class PagingState<Key : Any, Value : Any>

Snapshot state of Paging system including the loaded pages, the last accessed anchorPosition, and the config used.

Summary

Public constructors
`<Key : Any, Value : Any> PagingState( pages: List<PagingSource.LoadResult.Page<Key, Value>>, anchorPosition: Int?, config: PagingConfig, leadingPlaceholderCount: @IntRange(from = 0) Int )`	Cmn

Public functions
`Value?`	`closestItemToPosition(anchorPosition: Int)` Coerces `anchorPosition` to closest loaded value in `pages`.	Cmn
`PagingSource.LoadResult.Page<Key, Value>?`	`closestPageToPosition(anchorPosition: Int)` Coerces an index in the list, including placeholders, to closest loaded page in `pages`.	Cmn
`open operator Boolean`	`equals(other: Any?)`	Cmn
`Value?`	`firstItemOrNull()`	Cmn
`open Int`	`hashCode()`	Cmn
`Boolean`	`isEmpty()`	Cmn
`Value?`	`lastItemOrNull()`	Cmn
`open String`	`toString()`	Cmn

Public properties
`Int?`	`anchorPosition` Most recently accessed index in the list, including placeholders.	Cmn
`PagingConfig`	`config` `PagingConfig` that was given when initializing the `PagingData` stream.	Cmn
`List<PagingSource.LoadResult.Page<Key, Value>>`	`pages` Loaded pages of data in the list.	Cmn

Public constructors

PagingState

Cmn

<Key : Any, Value : Any> PagingState(
    pages: List<PagingSource.LoadResult.Page<Key, Value>>,
    anchorPosition: Int?,
    config: PagingConfig,
    leadingPlaceholderCount: @IntRange(from = 0) Int
)

Public functions

closestItemToPosition

Cmn

Added in 3.0.0

fun closestItemToPosition(anchorPosition: Int): Value?

Coerces anchorPosition to closest loaded value in pages.

This function can be called with anchorPosition to fetch the loaded item that is closest to the last accessed index in the list.

Parameters
`anchorPosition: Int`	Index in the list, including placeholders.

Returns
`Value?`	The closest loaded `Value` in `pages` to the provided `anchorPosition`. `null` if all loaded `pages` are empty.

closestPageToPosition

Cmn

Added in 3.0.0

fun closestPageToPosition(anchorPosition: Int): PagingSource.LoadResult.Page<Key, Value>?

Coerces an index in the list, including placeholders, to closest loaded page in pages.

This function can be called with anchorPosition to fetch the loaded page that is closest to the last accessed index in the list.

Parameters
`anchorPosition: Int`	Index in the list, including placeholders.

Returns
`PagingSource.LoadResult.Page<Key, Value>?`	The closest loaded `Value` in `pages` to the provided `anchorPosition`. `null` if all loaded `pages` are empty.

equals

Cmn

open operator fun equals(other: Any?): Boolean

firstItemOrNull

Cmn

Added in 3.0.0

fun firstItemOrNull(): Value?

Returns
`Value?`	The first loaded item in the list or `null` if all loaded pages are empty or no pages were loaded when this `PagingState` was created.

hashCode

Cmn

open fun hashCode(): Int

isEmpty

Cmn

Added in 3.0.0

fun isEmpty(): Boolean

Returns
`Boolean`	`true` if all loaded pages are empty or no pages were loaded when this `PagingState` was created, `false` otherwise.

lastItemOrNull

Cmn

Added in 3.0.0

fun lastItemOrNull(): Value?

Returns
`Value?`	The last loaded item in the list or `null` if all loaded pages are empty or no pages were loaded when this `PagingState` was created.

toString

Cmn

open fun toString(): String

Public properties

anchorPosition

Cmn

Added in 3.0.0

val anchorPosition: Int?

Most recently accessed index in the list, including placeholders.

null if no access in the PagingData has been made yet. E.g., if this snapshot was generated before or during the first load.

config

Cmn

Added in 3.0.0

val config: PagingConfig

PagingConfig that was given when initializing the PagingData stream.

pages

Cmn

Added in 3.0.0

val pages: List<PagingSource.LoadResult.Page<Key, Value>>

Loaded pages of data in the list.