readium-shared/org.readium.r2.shared.publication.services.search/SearchIterator

SearchIterator

interface SearchIterator : Closeable

Iterates through search results.

Properties

open val resultCount: Int?

Number of matches for this search, if known.

Functions

open override fun close()

Closes any resources allocated for the search query, such as a cursor. To be called when the user dismisses the search.

open suspend fun forEach(action: (LocatorCollection) -> Unit): SearchTry<Unit>

Performs the given operation on each result page of this SearchIterator.

abstract suspend fun next(): SearchTry<LocatorCollection?>

Retrieves the next page of results.