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

Package-level declarations

Types

sealed class SearchError : Error

Represents an error which might occur during a search activity.

interface SearchIterator : Closeable

Iterates through search results.

interface SearchService : Publication.Service

Provides a way to search terms in a publication.

typealias SearchTry<SuccessT> = Try<SuccessT, SearchError>

StringSearchService

class StringSearchService(manifest: Manifest, container: Container<Resource>, services: PublicationServicesHolder, language: String?, snippetLength: Int, searchAlgorithm: StringSearchService.Algorithm, extractorFactory: ResourceContentExtractor.Factory) : SearchService

Base implementation of SearchService iterating through the content of Publication's resources.

Properties

val Publication.isSearchable: Boolean

Indicates whether the content of this publication can be searched.

val Publication.searchOptions: SearchService.Options

Default value for the search options of this publication.

searchServiceFactory

var Publication.ServicesBuilder.searchServiceFactory: ServiceFactory?

Factory to build a SearchService

Functions

suspend fun Publication.search(query: String, options: SearchService.Options? = null): SearchIterator?

Starts a new search through the publication content, with the given query.