1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

//! A light-weight (2 total dependencies, including descendants)
//! embeddable search engine with support for typo tolerance, result relevance, and complex queries,
//! powered by [iterators](#iterators).
//!
//! If you want *page relevancy* (like [PageRank](https://en.wikipedia.org/wiki/PageRank)),
//! you have to implement it on your own.
//!
//! Also note that you have to provide this library with data and data updates.
//! See [`kvarn-search`](https://github.com/Icelk/kvarn-search) for an example on this.
//!
//! # Iterators
//!
//! When we search for occurrences of a requested word, we get a sorted [`Iterator`].
//! This allows [`query`] to chain iterators together to perform complex queries with few
//! allocations. Only once the client iterates over the occurrences and their relevance do they get
//! processed, ensuring minimal computational expense.
//!
//! Say you want to get the best result, then you can just call [`Iterator::next`] once, and
//! only one occurrence is processed.
//!
//! You may want to read the
//! [article on writing the first iteration](https://icelk.dev/articles/search-engine.)
//! of elipdotter.
#![deny(
    clippy::pedantic,
    unreachable_pub,
    missing_debug_implementations,
    // missing_docs
)]
#![allow(clippy::doc_markdown)]
#![doc(html_root_url = "https://doc.icelk.dev/elipdotter/elipdotter/")]

pub mod index;
pub mod proximity;
pub mod query;
pub mod set;

pub use index::{
    DocumentMap, Lossless as LosslessIndex, LosslessOccurrences as LosslessOccurrencesProvider,
    Simple as SimpleIndex, SimpleOccurences as SimpleOccurrencesProvider,
};
pub use query::{Hit, Part, Query};