abstract class SearchEngine[F[_]] extends AnyRef
The basic definition of a search engine. All engines must implement this class.
- F
A higher kinded type which is usually an applicative or monad in the concrete application.
- Alphabetic
- By Inheritance
- SearchEngine
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new SearchEngine()
Abstract Value Members
- abstract def capabilities: NonEmptyList[SearchEngineCapabilities]
Returns the capabilities that the search engine supports and that are implemented.
Returns the capabilities that the search engine supports and that are implemented.
- returns
A non empty list with supported / implemented capabilities.
- abstract def modes: NonEmptyList[SearchMode]
Returns all supported and implemented search modes of the engine.
Returns all supported and implemented search modes of the engine.
This list will never be empty because at least one mode is supported.
- returns
A non empty list of supported search modes.
- abstract def name: SearchEngineName
Returns the unique search engine name.
Returns the unique search engine name.
- returns
The name of the search engine which is unique across the application.
- abstract def parser: SearchEngineParser[F]
Returns the implementation of the parser for the search engine.
Returns the implementation of the parser for the search engine.
- returns
The search engine's custom parser.
- See also
- abstract def search(query: SearchQuery)(implicit backend: SttpBackend[F, Fs2Streams[F] with WebSockets]): Stream[F, SearchResult]
Perform the actual search and return the parsed results.
Perform the actual search and return the parsed results.
- query
The search query to be passed to the engine.
- backend
An implicitly provided backend for HTTP operations.
- returns
A stream of search results extracted from the search engine.
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])