Crate stork_lib

Source

Structs§

BuildOutput
Config
DocumentError
Associates a WordListGenerationError with a File.
Entry
A document present in the search results.
Excerpt
An excerpt of a document’s contents, that contains words that were part of the search query.
HighlightRange
A range of characters in a string that should be highlighted. The start and end indices are inclusive.
IndexDescription
IndexMetadata
Contains metadata about an index, to be displayed to the user, often for debugging.
Output
The set of data needed to display search results to a user.
Result
A single document in the list of matches for a search query, along with its display information and excerpts.

Enums§

BuildError
ConfigReadError
IndexParseError
An error that may occur when trying to parse an index file.
InternalWordAnnotation
An annotation attached to a given excerpt.
ParsedIndex
SearchError

Functions§

build_index
index_from_bytes
register_index
search
search_from_cache

Type Aliases§

Fields