summavy/core/
mod.rs

1mod executor;
2pub mod index;
3mod index_meta;
4mod inverted_index_reader;
5pub mod searcher;
6mod segment;
7mod segment_attributes;
8mod segment_component;
9mod segment_id;
10mod segment_reader;
11mod single_segment_index_writer;
12
13use std::path::Path;
14
15use once_cell::sync::Lazy;
16
17pub use self::executor::Executor;
18pub use self::index::{Index, IndexBuilder};
19pub use self::index_meta::{
20    IndexMeta, IndexSettings, IndexSortByField, Order, SegmentMeta, SegmentMetaInventory,
21};
22pub use self::inverted_index_reader::InvertedIndexReader;
23pub use self::searcher::{Searcher, SearcherGeneration};
24pub use self::segment::Segment;
25pub use self::segment_attributes::SegmentAttributesMerger;
26pub use self::segment_component::SegmentComponent;
27pub use self::segment_id::SegmentId;
28pub use self::segment_reader::SegmentReader;
29pub use self::single_segment_index_writer::SingleSegmentIndexWriter;
30
31/// The meta file contains all the information about the list of segments and the schema
32/// of the index.
33pub static META_FILEPATH: Lazy<&'static Path> = Lazy::new(|| Path::new("meta.json"));
34
35/// The managed file contains a list of files that were created by the tantivy
36/// and will therefore be garbage collected when they are deemed useless by tantivy.
37///
38/// Removing this file is safe, but will prevent the garbage collection of all of the file that
39/// are currently in the directory
40pub static MANAGED_FILEPATH: Lazy<&'static Path> = Lazy::new(|| Path::new(".managed.json"));