PagingState

public final Value closestItemAroundPosition(
    int anchorPosition,
    @NonNull Function1<@NonNull value, @NonNull Boolean> predicate
)

Coerces anchorPosition to closest loaded value in pages that matches predicate.

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

This function searches for the matching predicate amongst items that are positioned both before and after the anchorPosition with this order of priority:

1. item closest to anchorPosition

2. item before anchorPosition

This means that given an anchorPosition of item10, if item8 and item11 both match the predicate, then item11 will be returned since it is closer to item10. If two matching items have the same proximity, then the item that comes first will be returned. So given an anchorPosition of item10, if item9 and item11 both match the predicate, then item9 will be returned since it comes before item11.

This method should be avoided if possible if used on Lists that do not support random access, otherwise performance will take a big hit.

public final Value closestItemToPosition(int anchorPosition)

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.

public final PagingSource.LoadResult.Page<@NonNull Key, @NonNull Value> closestPageToPosition(int anchorPosition)

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.

public final Integer getAnchorPosition()

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.

public final @NonNull PagingConfig getConfig()

PagingConfig that was given when initializing the PagingData stream.

public final @NonNull List<@NonNull PagingSource.LoadResult.Page<@NonNull Key, @NonNull Value>> getPages()

Loaded pages of data in the list.