nutrient/io.nutrient.domain.search

Package-level declarations

Types

interface SearchActions<R : SearchResult, Q, S : SearchState<R, Q>>

Generic interface for handling searching the document with a query.

interface Searcher<R : SearchResult, Q>

Generic interface for searching the document with a query.

abstract class SearchResult

Base class for search results.

SearchResultSelectionController

interface SearchResultSelectionController<R : SearchResult>

Controller for a result navigation UI that allows to navigate between search results.

abstract class SearchState<R : SearchResult, Q>

Generic search state interface that can be used to search and manage the results

enum SearchStatus : Enum<SearchStatus>

Current status of the search

Functions

rememberQueryAndSearchOnChange

fun <Q, S : SearchState<*, Q>> rememberQueryAndSearchOnChange(actions: SearchActions<*, Q, S>, initialQuery: Q, debounceTime: Long = 300, resultCollectionContext: CoroutineContext = Dispatchers.Main): MutableState<Q>

Utility composable function to remember a search query, observe changes to it and start the search after a debounce time. While the actual search is always executed on the Dispatchers.Default context, the results are collected on resultCollectionContext, which defaults to Dispatchers.Main.