Removed redundant check

Closes #997

ARCHITECTURE.md

@@ -0,0 +1,297 @@
+# Tantivy
+
+## What is tantivy?
+
+Tantivy is a library that is meant to build search engines. Although it is by no mean a port of Lucene, its architecture is strongly inspired by it. If you are familiar with Lucene, you may be struck by the overlapping vocabulary.
+This is not fortuitous.
+
+Tantivy's bread and butter is to address the problem of full-text search :
+
+Given a large set of textual documents, and a text query, return the K-most relevant documents in a very efficient way. In order to execute these queries rapidly, the tantivy need to build an index beforehand. The relevance score implemented in the tantivy is not configurable. Tantivy uses the same score as the default similarity used in Lucene / Elasticsearch, called [BM25](https://en.wikipedia.org/wiki/Okapi_BM25).
+
+But tantivy's scope does not stop there. Numerous features are required to power rich search applications. For instance, one may want to:
+- compute the count of documents matching a query in the different section of an e-commerce website,
+- display an average price per meter square for a real estate search engine,
+- take in account historical user data to rank documents in a specific way,
+- or even use tantivy to power an OLAP database.
+
+A more abstract description of the problem space tantivy is trying to address is the following.
+
+Ingest a large set of documents, create an index that makes it possible to
+rapidly select all documents matching a given predicate (also known as a query) and
+collect some information about them (See collector).
+
+Roughly speaking the design is following these guiding principles:
+- Search should be O(1) in memory.
+- Indexing should be O(1) in memory. (In practise it is just sublinear)
+- Search should be as fast as possible
+
+This comes at the cost of the dynamicity of the index : while it is possible to add, and delete documents from our corpus, the tantivy is designed to handle these updates in large batches.
+
+## [core/](src/core): Index, segments, searchers.
+
+Core contains all of the high level code to make it possible for to create an index, add documents, delete documents and commit.
+
+This is both the most high-level part of tantivy, the least performance sensitive one, the seemingly most mundane code... And paradoxically the most complicated part.
+
+### Index and Segments...
+
+A tantivy index is in fact a collection of smaller independent immutable segments.
+Each segment contains its own independent set of datastructures.
+
+A segment is identified by a segment id that is in fact a UUID.
+The file of a segment has the format
+
+ ```segment-id . ext ```
+
+The extension signals which datastructure (or [`SegmentComponent`](src/core/segment_component.rs)) is stored in the file.
+
+A small `meta.json` file is in charge keeping track of the list of segments, as well as the schema.
+
+On commit, one segment per indexing thread is written to disk, and the `meta.json` is then updated atomically.
+
+For a better idea of how indexing works, you may read the [following blog post](https://fulmicoton.com/posts/behold-tantivy-part2/).
+
+
+### Deletes
+
+Deletes happen by deleting a "term". Tantivy does not offer any notion of primary id, so it is up to the user to use a field in their schema as if it was a primary id, and delete the associated term if they want to delete only one specific document.
+
+On commit, tantivy will find all of the segments with documents matching this existing term and create a [tombstone file](src/fastfield/delete.rs) that represents the bitset of the document that are deleted.
+Like all segment files, this file is immutable. Because it is possible to have more than one tombstone file at a given instant, the tombstone filename has the format ``` segment_id . commit_opstamp . del```.
+
+An opstamp is simply an incremental id that identifies any operation applied to the index. For instance, performing a commit or adding a document.
+
+
+### DocId
+
+Within a segment, all documents are identified by a DocId that ranges within `[0, max_doc)`.
+where max doc is the number of documents in the segment, (deleted or not). Having such a compact `DocId` space is key to the compression of our datastructures.
+
+The DocIds are simply allocated in the order documents are added to the index.
+
+### Merges
+
+In separate threads, tantivy's index writer search for opportunities to merge segments.
+The point of segment merges is to:
+- eventually get rid of tombstoned documents
+- reduce the otherwise evergrowing number of segments.
+
+Indeed, while having several segments instead of one does not hurt search too much, having hundreds can have a measurable impact on the search performance.
+
+### Searcher
+
+The user of the library usually does not need to know about the existence of Segments.
+Searching is done through an object called a [`Searcher`](src/core/searcher.rs), that captures a
+snapshot of the index at one point of time, by holding a list of [SegmentReader](src/core/segment_reader.rs).
+
+In other words, regardless of commits, file garbage collection, or segment merge that might happen, as long as the user holds and reuse the same [Searcher](src/core/searcher.rs), search will happen on an immutable snapshot of the index.
+
+## [directory/](src/directory): Where should the data be stored?
+
+Tantivy, like Lucene, abstracts the place where the data should be stored in a key-trait
+called [`Directory`](src/directory/directory.rs).
+Contrary to Lucene however, "files" are quite different from some kind of `io::Read` object.
+Check out [`src/directory/directory.rs`](src/directory/directory.rs) trait for more details.
+
+Tantivy ships two main directory implementation: the `MMapDirectory` and the `RAMDirectory`,
+but users can extend tantivy with their own implementation.
+
+## [schema/](src/schema): What are documents?
+
+Tantivy's document follow a very strict schema , decided before building any index.
+
+The schema defines all of the fields that the indexes [`Document`](src/schema/document.rs) may and should contain, their types (`text`, `i64`, `u64`, `Date`, ...) as well as how it should be indexed / represented in tantivy.
+
+Depending on the type of the field, you can decide to
+- put it in the docstore
+- store it as a fast field
+- index it
+
+Practically, tantivy will push values associated to this type to up to 3 respective
+datastructures.
+
+*Limitations*
+
+As of today, tantivy's schema impose a 1:1 relationship between a field that is being ingested and a field represented in the search index. In sophisticated search application, it is fairly common to want to index a field twice using different tokenizers, or to index the concatenation of several fields together into one field.
+
+This is not something tantivy supports, and it is up to the user to duplicate field / concatenate fields before feeding them to tantivy.
+
+## General information about these datastructures.
+
+All datastructures in tantivy, have:
+- a writer
+- a serializer
+- a reader
+
+The writer builds a in-memory representation of a batch of documents. This representation is not searchable. It is just meant as intermediary mutable representation, to which we can sequentially add
+the document of a batch. At the end of the batch (or if a memory limit is reached), this representation
+is then converted in an on-disk immutable representation, that is extremely compact.
+This conversion is done by the serializer.
+
+Finally, the reader is in charge of offering an API to read on this on-disk read-only representation.
+In tantivy, readers are designed to require very little anonymous memory. The data is read straight from an mmapped file, and loading an index is as fast as mmapping its files.
+
+## [store/](src/store): Here is my DocId, Gimme my document!
+
+The docstore is a row-oriented storage that, for each documents, stores a subset of the fields
+that are marked as stored in the schema. The docstore is compressed using a general purpose algorithm
+like LZ4.
+
+**Useful for**
+
+In search engines, it is often used to display search results.
+Once the top 10 documents have been identified, we fetch them from the store, and display them or their snippet on the search result page (aka SERP).
+
+**Not useful for**
+
+Fetching a document from the store is typically a "slow" operation. It usually consists in
+- searching into a compact tree-like datastructure to find the position of the right block.
+- decompressing a small block
+- returning the document from this block.
+
+It is NOT meant to be called for every document matching a query.
+
+As a rule of thumb, if you hit the docstore more than 100 times per search query, you are probably misusing tantivy.
+
+
+## [fastfield/](src/fastfield): Here is my DocId, Gimme my value!
+
+Fast fields are stored in a column-oriented storage that allows for random access.
+The only compression applied is bitpacking. The column comes with two meta data.
+The minimum value in the column and the number of bits per doc.
+
+Fetching a value for a `DocId` is then as simple as computing
+
+```
+min_value + fetch_bits(num_bits * doc_id..num_bits * (doc_id+1))
+```
+
+This operation just requires one memory fetch.
+Because, DocSets are scanned through in order (DocId are iterated in a sorted manner) which
+also help locality.
+
+In Lucene's jargon, fast fields are called DocValues.
+
+**Useful for**
+
+They are typically integer values that are useful to either rank or compute aggregate over
+all of the documents matching a query (aka [DocSet](src/docset.rs)).
+
+For instance, one could define a function to combine upvotes with tantivy's internal relevancy score.
+This can be done by fetching a fast field during scoring.
+Once could also compute the mean price of the items matching a query in an e-commerce website.
+This can be done by fetching a fast field in a collector.
+Finally one could decide to post filter a docset to remove docset with a price within a specific range.
+If the ratio of filtered out documents is not too low, an efficient way to do this is to fetch the price, and apply the filter on the collector side.
+
+Aside from integer values, it is also possible to store an actual byte payload.
+For advanced search engine, it is possible to store all of the features required for learning-to-rank in a byte payload, access it during search, and apply the learning-to-rank model.
+
+Finally facets are a specific kind of fast field, and the associated source code is in [`fastfield/facet_reader.rs`](src/fastfield/facet_reader.rs).
+
+# The inverted search index.
+
+The inverted index is the core part of full-text search.
+When presented a new document with the text field "Hello, happy tax payer!", tantivy breaks it into a list of so-called token. In addition to just splitting this strings into tokens, it might also do different kind of operations like dropping the punctuation, converting the character to lowercase, apply stemming etc. Tantivy makes it possible to configure the operations to be applied in the schema
+(tokenizer/ is the place where these operations are implemented).
+
+For instance, the default tokenizer of tantivy would break our text into: `[hello, happy, tax, payer]`.
+The document will therefore be registered in the inverted index as containing the terms
+`[text:hello, text:happy, text:tax, text:payer]`.
+
+The role of the inverted index is, when given a term, supply us with a very fast iterator over
+the sorted doc ids that match the term.
+
+Such an iterator is called a posting list. In addition to giving us `DocId`, they can also give us optionally to the number of occurrence of the term for each document, also called term frequency or TF.
+
+These iterators being sorted by DocId, one can create an iterator over the document containing `text:tax AND text:payer`, `(text:tax AND text:payer) OR (text:contribuable)` or any boolean expression.
+
+In order to represent the function
+```Term ⟶ Posting```
+
+The inverted index actually consists of two datastructures chained together.
+
+- [Term](src/schema/term.rs) ⟶ [TermInfo](src/postings/term_info.rs) is addressed by the term dictionary.
+- [TermInfo](src/postings/term_info.rs) ⟶ [Posting](src/postings/postings.rs) is addressed by the posting lists.
+
+Where [TermInfo](src/postings/term_info.rs) is an object containing some meta data about a term.
+
+
+## [termdict/](src/termdict): Here is a term, give me the [TermInfo](src/postings/term_info.rs)!
+
+Tantivy's term dictionary is mainly in charge of supplying the function
+
+[Term](src/schema/term.rs) ⟶ [TermInfo](src/postings/term_info.rs)
+
+It is itself is broken into two parts.
+- [Term](src/schema/term.rs) ⟶ [TermOrdinal](src/termdict/mod.rs) is addressed by a finite state transducer, implemented by the fst crate.
+- [TermOrdinal](src/termdict/mod.rs) ⟶ [TermInfo](src/postings/term_info.rs) is addressed by the term info store.
+
+
+## [postings/](src/postings): Iterate over documents... very fast!
+
+A posting list makes it possible to store a sorted list of doc ids and for each doc store
+a term frequency as well.
+
+The posting list are stored in a separate file. The [TermInfo](src/postings/term_info.rs) contains an offset into that file and a number of documents for the given posting list. Both are required and sufficient to read the posting list.
+
+The posting list is organized in block of 128 documents.
+One block of doc ids is followed by one block of term frequencies.
+
+The doc ids are delta encoded and bitpacked.
+The term frequencies are bitpacked.
+
+Because the number of docs is rarely a multiple of 128, the last block my contain an arbitrary number of docs between 1 and 127 documents. We then use variable int encoding instead of bitpacking.
+
+## [positions/](src/positions): Where are my terms within the documents?
+
+Phrase queries make it possible to search for documents containing a specific sequence of document.
+For instance, when the phrase query "the art of war" does not match "the war of art".
+To make it possible, it is possible to specify in the schema that a field should store positions in addition to being indexed.
+
+The token positions of all of the terms are then stored in a separate file with the extension `.pos`.
+The [TermInfo](src/postings/term_info.rs) gives an offset (expressed in position this time) in this file. As we iterate throught the docset,
+we advance the position reader by the number of term frequencies of the current document.
+
+## [fieldnorms/](src/fieldnorms): Here is my doc, how many tokens in this field?
+
+The [BM25](https://en.wikipedia.org/wiki/Okapi_BM25) formula also requires to know the number of tokens stored in a specific field for a given document. We store this information on one byte per document in the fieldnorm.
+The fieldnorm is therefore compressed. Values up to 40 are encoded unchanged. There is then a logarithmic mapping that
+
+
+## [tokenizer/](src/tokenizer): How should we process text?
+
+Text processing is key to a good search experience.
+Splits or normalize your text too much, and the search results will have a less precision and a higher recall.
+Do not normalize, or under split your text, you will end up with a higher precision and a lesser recall.
+
+Text processing can be configured by selecting an off-the-shelf [`Tokenizer`](./src/tokenizer/tokenizer.rs) or implementing your own to first split the text into tokens, and then chain different [`TokenFilter`](src/tokenizer/tokenizer.rs)'s to it.
+
+Tantivy's comes with few tokenizers, but external crates are offering advanced tokenizers, such as [Lindera](https://crates.io/crates/lindera) for Japanese.
+
+
+## [query/](src/query): Define and compose queries
+
+The [Query](src/query/query.rs) trait defines what a query is.
+Due to the necessity for some query to compute some statistics over the entire index, and because the
+index is composed of several `SegmentReader`, the path from transforming a `Query` to a iterator over document is slightly convoluted, but fundamentally, this is what a Query is.
+
+The iterator over a document comes with some scoring function. The resulting trait is called a
+[Scorer](src/query/scorer.rs) and is specific to a segment.
+
+Different queries can be combined using the [BooleanQuery](src/query/boolean_query/).
+Tantivy comes with different types of queries, and can be extended by implementing
+the Query`, `Weight` and `Scorer` traits.
+
+## [collector](src/collector): Define what to do with matched documents
+
+Collectors define how to aggregate the documents matching a query, in the broadest sense possible.
+The search will push matched document one by one, calling their
+`fn collect(doc: DocId, score: Score);` method.
+
+Users may implement their own collectors by implementing the [Collector](src/collector/mod.rs) trait.
+
+## [query-grammar](query-grammar): Defines the grammar of the query parser
+
+While the [QueryParser](src/query/query_parser/query_parser.rs) struct is located in the `query/` directory, the actual parser combinator used to convert user queries into an AST is in an external crate called `query-grammar`. This part was externalize to lighten the work of the compiler.

CHANGELOG.md

@@ -1,18 +1,31 @@
+Tantivy 0.15.0
+=========================
+- API Changes. Using Range instead of (start, end) in the API and internals (`FileSlice`, `OwnedBytes`, `Snippets`, ...)
+  This change is breaking but migration is trivial.
+- Added an Histogram collector. (@fulmicoton) #994
+- Added support for Option<TCollector>.  (@fulmicoton) 
+
+
 Tantivy 0.14.0
 =========================
-- Remove dependency to atomicwrites #833 .Implemented by @pmasurel upon suggestion and research from @asafigan). 
+- Remove dependency to atomicwrites #833 .Implemented by @fulmicoton upon suggestion and research from @asafigan).
 - Migrated tantivy error from the now deprecated `failure` crate to `thiserror` #760. (@hirevo)
-- API Change. Accessing the typed value off a `Schema::Value` now returns an Option instead of panicking if the type does not match. 
+- API Change. Accessing the typed value off a `Schema::Value` now returns an Option instead of panicking if the type does not match.
 - Large API Change in the Directory API. Tantivy used to assume that all files could be somehow memory mapped. After this change, Directory return a `FileSlice` that can be reduced and eventually read into an `OwnedBytes` object. Long and blocking io operation are still required by they do not span over the entire file.
 - Added support for Brotli compression in the DocStore. (@ppodolsky)
 - Added helper for building intersections and unions in BooleanQuery (@guilload)
 - Bugfix in `Query::explain`
 - Removed dependency on `notify` #924. Replaced with `FileWatcher` struct that polls meta file every 500ms in background thread. (@halvorboe @guilload)
 - Added `FilterCollector`, which wraps another collector and filters docs using a predicate over a fast field (@barrotsteindev)
+- Simplified the encoding of the skip reader struct. BlockWAND max tf is now encoded over a single byte. (@fulmicoton)
+- `FilterCollector` now supports all Fast Field value types (@barrotsteindev)
+- FastField are not all loaded when opening the segment reader. (@fulmicoton)
+
+This version breaks compatibility and requires users to reindex everything.
 
 Tantivy 0.13.2
 ===================
-Bugfix. Acquiring a facet reader on a segment that does not contain any 
+Bugfix. Acquiring a facet reader on a segment that does not contain any
 doc with this facet returns `None`. (#896)
 
 Tantivy 0.13.1
@@ -23,7 +36,7 @@ Updated misc dependency versions.
 Tantivy 0.13.0
 ======================
 Tantivy 0.13 introduce a change in the index format that will require
-you to reindex your index (BlockWAND information are added in the skiplist). 
+you to reindex your index (BlockWAND information are added in the skiplist).
 The index size increase is minor as this information is only added for
 full blocks.
 If you have a massive index for which reindexing is not an option, please contact me
@@ -32,7 +45,7 @@ so that we can discuss possible solutions.
 - Bugfix in `FuzzyTermQuery` not matching terms by prefix when it should (@Peachball)
 - Relaxed constraints on the custom/tweak score functions. At the segment level, they can be mut, and they are not required to be Sync + Send.
 - `MMapDirectory::open` does not return a `Result` anymore.
-- Change in the DocSet and Scorer API. (@fulmicoton). 
+- Change in the DocSet and Scorer API. (@fulmicoton).
 A freshly created DocSet point directly to their first doc. A sentinel value called TERMINATED marks the end of a DocSet.
 `.advance()` returns the new DocId. `Scorer::skip(target)` has been replaced by `Scorer::seek(target)` and returns the resulting DocId.
 As a result, iterating through DocSet now looks as follows
@@ -46,7 +59,7 @@ while doc != TERMINATED {
 The change made it possible to greatly simplify a lot of the docset's code.
 - Misc internal optimization and introduction of the `Scorer::for_each_pruning` function. (@fulmicoton)
 - Added an offset option to the Top(.*)Collectors. (@robyoung)
-- Added Block WAND. Performance on TOP-K on term-unions should be greatly increased. (@fulmicoton, and special thanks 
+- Added Block WAND. Performance on TOP-K on term-unions should be greatly increased. (@fulmicoton, and special thanks
 to the PISA team for answering all my questions!)
 
 Tantivy 0.12.0
@@ -54,14 +67,14 @@ Tantivy 0.12.0
 - Removing static dispatch in tokenizers for simplicity. (#762)
 - Added backward iteration for `TermDictionary` stream. (@halvorboe)
 - Fixed a performance issue when searching for the posting lists of a missing term (@audunhalland)
-- Added a configurable maximum number of docs (10M by default) for a segment to be considered for merge (@hntd187, landed by @halvorboe #713) 
+- Added a configurable maximum number of docs (10M by default) for a segment to be considered for merge (@hntd187, landed by @halvorboe #713)
 - Important Bugfix #777, causing tantivy to retain memory mapping. (diagnosed by @poljar)
 - Added support for field boosting. (#547, @fulmicoton)
 
 ## How to update?
 
-Crates relying on custom tokenizer, or registering tokenizer in the manager will require some 
-minor changes. Check https://github.com/tantivy-search/tantivy/blob/master/examples/custom_tokenizer.rs
+Crates relying on custom tokenizer, or registering tokenizer in the manager will require some
+minor changes. Check https://github.com/tantivy-search/tantivy/blob/main/examples/custom_tokenizer.rs
 to check for some code sample.
 
 Tantivy 0.11.3
@@ -97,7 +110,7 @@ Tantivy 0.11.0
 
 ## How to update?
 
-- The index format is changed. You are required to reindex your data to use tantivy 0.11. 
+- The index format is changed. You are required to reindex your data to use tantivy 0.11.
 - `Box<dyn BoxableTokenizer>` has been replaced by a `BoxedTokenizer` struct.
 - Regex are now compiled when the `RegexQuery` instance is built. As a result, it can now return
 an error and handling the `Result` is required.
@@ -121,26 +134,26 @@ Tantivy 0.10.0
 
 *Tantivy 0.10.0 index format is compatible with the index format in 0.9.0.*
 
-- Added an API to easily tweak or entirely replace the 
- default score. See `TopDocs::tweak_score`and `TopScore::custom_score` (@pmasurel)
+- Added an API to easily tweak or entirely replace the
+ default score. See `TopDocs::tweak_score`and `TopScore::custom_score` (@fulmicoton)
 - Added an ASCII folding filter (@drusellers)
-- Bugfix in `query.count` in presence of deletes (@pmasurel)
-- Added `.explain(...)` in `Query` and `Weight` to (@pmasurel)
-- Added an efficient way to `delete_all_documents` in `IndexWriter` (@petr-tik). 
+- Bugfix in `query.count` in presence of deletes (@fulmicoton)
+- Added `.explain(...)` in `Query` and `Weight` to (@fulmicoton)
+- Added an efficient way to `delete_all_documents` in `IndexWriter` (@petr-tik).
   All segments are simply removed.
 
 Minor
 ---------
 - Switched to Rust 2018 (@uvd)
-- Small simplification of the code. 
+- Small simplification of the code.
 Calling .freq() or .doc() when .advance() has never been called
 on segment postings should panic from now on.
 - Tokens exceeding `u16::max_value() - 4` chars are discarded silently instead of panicking.
 - Fast fields are now preloaded when the `SegmentReader` is created.
 - `IndexMeta` is now public.  (@hntd187)
 - `IndexWriter` `add_document`, `delete_term`. `IndexWriter` is `Sync`, making it possible to use it with a `
-Arc<RwLock<IndexWriter>>`. `add_document` and `delete_term` can 
-only require a read lock. (@pmasurel)
+Arc<RwLock<IndexWriter>>`. `add_document` and `delete_term` can
+only require a read lock. (@fulmicoton)
 - Introducing `Opstamp` as an expressive type alias for `u64`. (@petr-tik)
 - Stamper now relies on `AtomicU64` on all platforms (@petr-tik)
 - Bugfix - Files get deleted slightly earlier
@@ -154,7 +167,7 @@ Your program should be usable as is.
 
 Fast fields used to be accessed directly from the `SegmentReader`.
 The API changed, you are now required to acquire your fast field reader via the
-`segment_reader.fast_fields()`, and use one of the typed method: 
+`segment_reader.fast_fields()`, and use one of the typed method:
 - `.u64()`, `.i64()` if your field is single-valued ;
 - `.u64s()`, `.i64s()` if your field is multi-valued ;
 - `.bytes()` if your field is bytes fast field.
@@ -163,16 +176,16 @@ The API changed, you are now required to acquire your fast field reader via the
 
 Tantivy 0.9.0
 =====================
-*0.9.0 index format is not compatible with the 
+*0.9.0 index format is not compatible with the
 previous index format.*
-- MAJOR BUGFIX : 
+- MAJOR BUGFIX :
   Some `Mmap` objects were being leaked, and would never get released. (@fulmicoton)
 - Removed most unsafe (@fulmicoton)
 - Indexer memory footprint improved. (VInt comp, inlining the first block. (@fulmicoton)
 - Stemming in other language possible (@pentlander)
 - Segments with no docs are deleted earlier (@barrotsteindev)
-- Added grouped add and delete operations. 
-  They are guaranteed to happen together (i.e. they cannot be split by a commit). 
+- Added grouped add and delete operations.
+  They are guaranteed to happen together (i.e. they cannot be split by a commit).
   In addition, adds are guaranteed to happen on the same segment. (@elbow-jason)
 - Removed `INT_STORED` and `INT_INDEXED`. It is now possible to use `STORED` and `INDEXED`
   for int fields. (@fulmicoton)
@@ -186,26 +199,26 @@ tantivy 0.9 brought some API breaking change.
 To update from tantivy 0.8, you will need to go through the following steps.
 
 - `schema::INT_INDEXED` and `schema::INT_STORED`  should be replaced by `schema::INDEXED` and `schema::INT_STORED`.
-- The index now does not hold the pool of searcher anymore. You are required to create an intermediary object called 
-`IndexReader` for this. 
-    
+- The index now does not hold the pool of searcher anymore. You are required to create an intermediary object called
+`IndexReader` for this.
+
     ```rust
     // create the reader. You typically need to create 1 reader for the entire
     // lifetime of you program.
     let reader = index.reader()?;
-    
+
     // Acquire a searcher (previously `index.searcher()`) is now written:
     let searcher = reader.searcher();
-    
-    // With the default setting of the reader, you are not required to 
+
+    // With the default setting of the reader, you are not required to
     // call `index.load_searchers()` anymore.
     //
     // The IndexReader will pick up that change automatically, regardless
     // of whether the update was done in a different process or not.
-    // If this behavior is not wanted, you can create your reader with 
+    // If this behavior is not wanted, you can create your reader with
     // the `ReloadPolicy::Manual`, and manually decide when to reload the index
     // by calling `reader.reload()?`.
-  
+
     ```
 
 
@@ -220,7 +233,7 @@ Tantivy 0.8.1
 =====================
 Hotfix of #476.
 
-Merge was reflecting deletes before commit was passed. 
+Merge was reflecting deletes before commit was passed.
 Thanks @barrotsteindev  for reporting the bug.
 
 
@@ -228,7 +241,7 @@ Tantivy 0.8.0
 =====================
 *No change in the index format*
 - API Breaking change in the collector API. (@jwolfe, @fulmicoton)
-- Multithreaded search (@jwolfe, @fulmicoton) 
+- Multithreaded search (@jwolfe, @fulmicoton)
 
 
 Tantivy 0.7.1
@@ -256,7 +269,7 @@ Tantivy 0.6.1
         - Exclusive `field:{startExcl to endExcl}`
         - Mixed `field:[startIncl to endExcl}` and vice versa
         - Unbounded `field:[start to *]`, `field:[* to end]`
- 
+
 
 Tantivy 0.6
 ==========================
@@ -264,10 +277,10 @@ Tantivy 0.6
 Special thanks to @drusellers and @jason-wolfe for their contributions
 to this release!
 
-- Removed C code. Tantivy is now pure Rust. (@pmasurel)
-- BM25 (@pmasurel)
-- Approximate field norms encoded over 1 byte. (@pmasurel)
-- Compiles on stable rust (@pmasurel)
+- Removed C code. Tantivy is now pure Rust. (@fulmicoton)
+- BM25 (@fulmicoton)
+- Approximate field norms encoded over 1 byte. (@fulmicoton)
+- Compiles on stable rust (@fulmicoton)
 - Add &[u8] fastfield for associating arbitrary bytes to each document (@jason-wolfe) (#270)
     - Completely uncompressed
     - Internally: One u64 fast field for indexes, one fast field for the bytes themselves.
@@ -275,7 +288,7 @@ to this release!
 - Add Stopword Filter support (@drusellers)
 - Add a FuzzyTermQuery (@drusellers)
 - Add a RegexQuery (@drusellers)
-- Various performance improvements (@pmasurel)_
+- Various performance improvements (@fulmicoton)_
 
 
 Tantivy 0.5.2

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "tantivy"
-version = "0.14.0-dev"
+version = "0.14.0"
 authors = ["Paul Masurel <paul.masurel@gmail.com>"]
 license = "MIT"
 categories = ["database-implementations", "data-structures"]
@@ -33,7 +33,7 @@ levenshtein_automata = "0.2"
 uuid = { version = "0.8", features = ["v4", "serde"] }
 crossbeam = "0.8"
 futures = {version = "0.3",  features=["thread-pool"] }
-tantivy-query-grammar = { version="0.14.0-dev", path="./query-grammar" }
+tantivy-query-grammar = { version="0.14.0", path="./query-grammar" }
 stable_deref_trait = "1"
 rust-stemmers = "1"
 downcast-rs = "1"
@@ -48,15 +48,17 @@ chrono = "0.4"
 smallvec = "1"
 rayon = "1"
 lru = "0.6"
+fastdivide = "0.3"
 
 [target.'cfg(windows)'.dependencies]
 winapi = "0.3"
 
 [dev-dependencies]
-rand = "0.7"
+rand = "0.8"
 maplit = "1"
 matches = "0.1.8"
-proptest = "0.10"
+proptest = "1.0"
+criterion = "0.3"
 
 [dev-dependencies.fail]
 version = "0.4"
@@ -97,3 +99,7 @@ travis-ci = { repository = "tantivy-search/tantivy" }
 name = "failpoints"
 path = "tests/failpoints/mod.rs"
 required-features = ["fail/failpoints"]
+
+[[bench]]
+name = "analyzer"
+harness = false

README.md

@@ -1,9 +1,9 @@
 
-[![Build Status](https://travis-ci.org/tantivy-search/tantivy.svg?branch=master)](https://travis-ci.org/tantivy-search/tantivy)
-[![codecov](https://codecov.io/gh/tantivy-search/tantivy/branch/master/graph/badge.svg)](https://codecov.io/gh/tantivy-search/tantivy)
+[![Build Status](https://travis-ci.org/tantivy-search/tantivy.svg?branch=main)](https://travis-ci.org/tantivy-search/tantivy)
+[![codecov](https://codecov.io/gh/tantivy-search/tantivy/branch/main/graph/badge.svg)](https://codecov.io/gh/tantivy-search/tantivy)
 [![Join the chat at https://gitter.im/tantivy-search/tantivy](https://badges.gitter.im/tantivy-search/tantivy.svg)](https://gitter.im/tantivy-search/tantivy?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![Build status](https://ci.appveyor.com/api/projects/status/r7nb13kj23u8m9pj/branch/master?svg=true)](https://ci.appveyor.com/project/fulmicoton/tantivy/branch/master)
+[![Build status](https://ci.appveyor.com/api/projects/status/r7nb13kj23u8m9pj/branch/main?svg=true)](https://ci.appveyor.com/project/fulmicoton/tantivy/branch/main)
 [![Crates.io](https://img.shields.io/crates/v/tantivy.svg)](https://crates.io/crates/tantivy)
 
 ![Tantivy](https://tantivy-search.github.io/logo/tantivy-logo.png)

benches/analyzer.rs

@@ -0,0 +1,22 @@
+use criterion::{criterion_group, criterion_main, Criterion};
+use tantivy::tokenizer::TokenizerManager;
+
+const ALICE_TXT: &'static str = include_str!("alice.txt");
+
+pub fn criterion_benchmark(c: &mut Criterion) {
+    let tokenizer_manager = TokenizerManager::default();
+    let tokenizer = tokenizer_manager.get("default").unwrap();
+    c.bench_function("default-tokenize-alice", |b| {
+        b.iter(|| {
+            let mut word_count = 0;
+            let mut token_stream = tokenizer.token_stream(ALICE_TXT);
+            while token_stream.advance() {
+                word_count += 1;
+            }
+            assert_eq!(word_count, 30_731);
+        })
+    });
+}
+
+criterion_group!(benches, criterion_benchmark);
+criterion_main!(benches);

examples/custom_collector.rs

@@ -14,7 +14,7 @@ use tantivy::fastfield::FastFieldReader;
 use tantivy::query::QueryParser;
 use tantivy::schema::Field;
 use tantivy::schema::{Schema, FAST, INDEXED, TEXT};
-use tantivy::{doc, Index, Score, SegmentReader, TantivyError};
+use tantivy::{doc, Index, Score, SegmentReader};
 
 #[derive(Default)]
 struct Stats {
@@ -72,16 +72,7 @@ impl Collector for StatsCollector {
         _segment_local_id: u32,
         segment_reader: &SegmentReader,
     ) -> tantivy::Result<StatsSegmentCollector> {
-        let fast_field_reader = segment_reader
-            .fast_fields()
-            .u64(self.field)
-            .ok_or_else(|| {
-                let field_name = segment_reader.schema().get_field_name(self.field);
-                TantivyError::SchemaError(format!(
-                    "Field {:?} is not a u64 fast field.",
-                    field_name
-                ))
-            })?;
+        let fast_field_reader = segment_reader.fast_fields().u64(self.field)?;
         Ok(StatsSegmentCollector {
             fast_field_reader,
             stats: Stats::default(),

examples/faceted_search.rs

@@ -23,7 +23,7 @@ fn main() -> tantivy::Result<()> {
 
     let name = schema_builder.add_text_field("felin_name", TEXT | STORED);
     // this is our faceted field: its scientific classification
-    let classification = schema_builder.add_facet_field("classification");
+    let classification = schema_builder.add_facet_field("classification", INDEXED);
 
     let schema = schema_builder.build();
     let index = Index::create_in_ram(schema);

examples/faceted_search_with_tweaked_score.rs

@@ -9,7 +9,7 @@ fn main() -> tantivy::Result<()> {
     let mut schema_builder = Schema::builder();
 
     let title = schema_builder.add_text_field("title", STORED);
-    let ingredient = schema_builder.add_facet_field("ingredient");
+    let ingredient = schema_builder.add_facet_field("ingredient", INDEXED);
 
     let schema = schema_builder.build();
     let index = Index::create_in_ram(schema.clone());

examples/iterating_docs_and_positions.rs

@@ -1,4 +1,4 @@
-// # Iterating docs and positioms.
+// # Iterating docs and positions.
 //
 // At its core of tantivy, relies on a data structure
 // called an inverted index.

examples/pre_tokenized_text.rs

@@ -1,6 +1,6 @@
 // # Pre-tokenized text example
 //
-// This example shows how to use pre-tokenized text. Sometimes yout might
+// This example shows how to use pre-tokenized text. Sometimes you might
 // want to index and search through text which is already split into
 // tokens by some external tool.
 //

examples/snippet.rs

@@ -69,12 +69,12 @@ fn highlight(snippet: Snippet) -> String {
     let mut result = String::new();
     let mut start_from = 0;
 
-    for (start, end) in snippet.highlighted().iter().map(|h| h.bounds()) {
-        result.push_str(&snippet.fragments()[start_from..start]);
+    for fragment_range in snippet.highlighted() {
+        result.push_str(&snippet.fragments()[start_from..fragment_range.start]);
         result.push_str(" --> ");
-        result.push_str(&snippet.fragments()[start..end]);
+        result.push_str(&snippet.fragments()[fragment_range.clone()]);
         result.push_str(" <-- ");
-        start_from = end;
+        start_from = fragment_range.end;
     }
 
     result.push_str(&snippet.fragments()[start_from..]);

query-grammar/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "tantivy-query-grammar"
-version = "0.14.0-dev"
+version = "0.14.0"
 authors = ["Paul Masurel <paul.masurel@gmail.com>"]
 license = "MIT"
 categories = ["database-implementations", "data-structures"]

src/collector/custom_score_top_collector.rs

@@ -58,9 +58,7 @@ where
         segment_local_id: u32,
         segment_reader: &SegmentReader,
     ) -> crate::Result<Self::Child> {
-        let segment_collector = self
-            .collector
-            .for_segment(segment_local_id, segment_reader)?;
+        let segment_collector = self.collector.for_segment(segment_local_id, segment_reader);
         let segment_scorer = self.custom_scorer.segment_scorer(segment_reader)?;
         Ok(CustomScoreTopSegmentCollector {
             segment_collector,

src/collector/facet_collector.rs

@@ -12,8 +12,8 @@ use std::collections::btree_map;
 use std::collections::BTreeMap;
 use std::collections::BTreeSet;
 use std::collections::BinaryHeap;
-use std::collections::Bound;
 use std::iter::Peekable;
+use std::ops::Bound;
 use std::{u64, usize};
 
 struct Hit<'a> {
@@ -80,7 +80,7 @@ fn facet_depth(facet_bytes: &[u8]) -> usize {
 /// ```rust
 /// use tantivy::collector::FacetCollector;
 /// use tantivy::query::AllQuery;
-/// use tantivy::schema::{Facet, Schema, TEXT};
+/// use tantivy::schema::{Facet, Schema, INDEXED, TEXT};
 /// use tantivy::{doc, Index};
 ///
 /// fn example() -> tantivy::Result<()> {
@@ -89,7 +89,7 @@ fn facet_depth(facet_bytes: &[u8]) -> usize {
 ///     // Facet have their own specific type.
 ///     // It is not a bad practise to put all of your
 ///     // facet information in the same field.
-///     let facet = schema_builder.add_facet_field("facet");
+///     let facet = schema_builder.add_facet_field("facet", INDEXED);
 ///     let title = schema_builder.add_text_field("title", TEXT);
 ///     let schema = schema_builder.build();
 ///     let index = Index::create_in_ram(schema);
@@ -368,9 +368,12 @@ impl SegmentCollector for FacetSegmentCollector {
             }
             let mut facet = vec![];
             let facet_ord = self.collapse_facet_ords[collapsed_facet_ord];
-            facet_dict.ord_to_term(facet_ord as u64, &mut facet);
-            // TODO
-            facet_counts.insert(Facet::from_encoded(facet).unwrap(), count);
+            // TODO handle errors.
+            if facet_dict.ord_to_term(facet_ord as u64, &mut facet).is_ok() {
+                if let Ok(facet) = Facet::from_encoded(facet) {
+                    facet_counts.insert(facet, count);
+                }
+            }
         }
         FacetCounts { facet_counts }
     }
@@ -395,6 +398,8 @@ impl<'a> Iterator for FacetChildIterator<'a> {
 }
 
 impl FacetCounts {
+    /// Returns an iterator over all of the facet count pairs inside this result.
+    /// See the documentation for `FacetCollector` for a usage example.
     pub fn get<T>(&self, facet_from: T) -> FacetChildIterator<'_>
     where
         Facet: From<T>,
@@ -414,6 +419,8 @@ impl FacetCounts {
         FacetChildIterator { underlying }
     }
 
+    /// Returns a vector of top `k` facets with their counts, sorted highest-to-lowest by counts.
+    /// See the documentation for `FacetCollector` for a usage example.
     pub fn top_k<T>(&self, facet: T, k: usize) -> Vec<(&Facet, u64)>
     where
         Facet: From<T>,
@@ -454,7 +461,7 @@ mod tests {
     use crate::collector::Count;
     use crate::core::Index;
     use crate::query::{AllQuery, QueryParser, TermQuery};
-    use crate::schema::{Document, Facet, Field, IndexRecordOption, Schema};
+    use crate::schema::{Document, Facet, Field, IndexRecordOption, Schema, INDEXED};
     use crate::Term;
     use rand::distributions::Uniform;
     use rand::prelude::SliceRandom;
@@ -464,7 +471,7 @@ mod tests {
     #[test]
     fn test_facet_collector_drilldown() {
         let mut schema_builder = Schema::builder();
-        let facet_field = schema_builder.add_facet_field("facet");
+        let facet_field = schema_builder.add_facet_field("facet", INDEXED);
         let schema = schema_builder.build();
         let index = Index::create_in_ram(schema);
 
@@ -524,7 +531,7 @@ mod tests {
     #[test]
     fn test_doc_unsorted_multifacet() {
         let mut schema_builder = Schema::builder();
-        let facet_field = schema_builder.add_facet_field("facets");
+        let facet_field = schema_builder.add_facet_field("facets", INDEXED);
         let schema = schema_builder.build();
         let index = Index::create_in_ram(schema);
         let mut index_writer = index.writer_for_tests().unwrap();
@@ -548,7 +555,7 @@ mod tests {
     #[test]
     fn test_doc_search_by_facet() -> crate::Result<()> {
         let mut schema_builder = Schema::builder();
-        let facet_field = schema_builder.add_facet_field("facet");
+        let facet_field = schema_builder.add_facet_field("facet", INDEXED);
         let schema = schema_builder.build();
         let index = Index::create_in_ram(schema);
         let mut index_writer = index.writer_for_tests()?;
@@ -605,7 +612,7 @@ mod tests {
     #[test]
     fn test_facet_collector_topk() {
         let mut schema_builder = Schema::builder();
-        let facet_field = schema_builder.add_facet_field("facet");
+        let facet_field = schema_builder.add_facet_field("facet", INDEXED);
         let schema = schema_builder.build();
         let index = Index::create_in_ram(schema);
 
@@ -657,7 +664,7 @@ mod bench {
 
     use crate::collector::FacetCollector;
     use crate::query::AllQuery;
-    use crate::schema::{Facet, Schema};
+    use crate::schema::{Facet, Schema, INDEXED};
     use crate::Index;
     use rand::seq::SliceRandom;
     use rand::thread_rng;
@@ -666,7 +673,7 @@ mod bench {
     #[bench]
     fn bench_facet_collector(b: &mut Bencher) {
         let mut schema_builder = Schema::builder();
-        let facet_field = schema_builder.add_facet_field("facet");
+        let facet_field = schema_builder.add_facet_field("facet", INDEXED);
         let schema = schema_builder.build();
         let index = Index::create_in_ram(schema);
 

src/collector/filter_collector_wrapper.rs

@@ -9,8 +9,10 @@
 
 // ---
 // Importing tantivy...
+use std::marker::PhantomData;
+
 use crate::collector::{Collector, SegmentCollector};
-use crate::fastfield::FastFieldReader;
+use crate::fastfield::{FastFieldReader, FastValue};
 use crate::schema::Field;
 use crate::{Score, SegmentReader, TantivyError};
 
@@ -41,78 +43,98 @@ use crate::{Score, SegmentReader, TantivyError};
 ///
 /// let query_parser = QueryParser::for_index(&index, vec![title]);
 /// let query = query_parser.parse_query("diary").unwrap();
-/// let no_filter_collector = FilterCollector::new(price, &|value| value > 20_120u64, TopDocs::with_limit(2));
+/// let no_filter_collector = FilterCollector::new(price, &|value: u64| value > 20_120u64, TopDocs::with_limit(2));
 /// let top_docs = searcher.search(&query, &no_filter_collector).unwrap();
 ///
 /// assert_eq!(top_docs.len(), 1);
 /// assert_eq!(top_docs[0].1, DocAddress(0, 1));
 ///
-/// let filter_all_collector = FilterCollector::new(price, &|value| value < 5u64, TopDocs::with_limit(2));
+/// let filter_all_collector: FilterCollector<_, _, u64> = FilterCollector::new(price, &|value| value < 5u64, TopDocs::with_limit(2));
 /// let filtered_top_docs = searcher.search(&query, &filter_all_collector).unwrap();
 ///
 /// assert_eq!(filtered_top_docs.len(), 0);
 /// ```
-pub struct FilterCollector<TCollector, TPredicate>
+pub struct FilterCollector<TCollector, TPredicate, TPredicateValue: FastValue>
 where
-    TPredicate: 'static,
+    TPredicate: 'static + Clone,
 {
     field: Field,
     collector: TCollector,
-    predicate: &'static TPredicate,
+    predicate: TPredicate,
+    t_predicate_value: PhantomData<TPredicateValue>,
 }
 
-impl<TCollector, TPredicate> FilterCollector<TCollector, TPredicate>
+impl<TCollector, TPredicate, TPredicateValue: FastValue>
+    FilterCollector<TCollector, TPredicate, TPredicateValue>
 where
     TCollector: Collector + Send + Sync,
-    TPredicate: Fn(u64) -> bool + Send + Sync,
+    TPredicate: Fn(TPredicateValue) -> bool + Send + Sync + Clone,
 {
     /// Create a new FilterCollector.
     pub fn new(
         field: Field,
-        predicate: &'static TPredicate,
+        predicate: TPredicate,
         collector: TCollector,
-    ) -> FilterCollector<TCollector, TPredicate> {
+    ) -> FilterCollector<TCollector, TPredicate, TPredicateValue> {
         FilterCollector {
             field,
             predicate,
             collector,
+            t_predicate_value: PhantomData,
         }
     }
 }
 
-impl<TCollector, TPredicate> Collector for FilterCollector<TCollector, TPredicate>
+impl<TCollector, TPredicate, TPredicateValue: FastValue> Collector
+    for FilterCollector<TCollector, TPredicate, TPredicateValue>
 where
     TCollector: Collector + Send + Sync,
-    TPredicate: 'static + Fn(u64) -> bool + Send + Sync,
+    TPredicate: 'static + Fn(TPredicateValue) -> bool + Send + Sync + Clone,
+    TPredicateValue: FastValue,
 {
     // That's the type of our result.
     // Our standard deviation will be a float.
     type Fruit = TCollector::Fruit;
 
-    type Child = FilterSegmentCollector<TCollector::Child, TPredicate>;
+    type Child = FilterSegmentCollector<TCollector::Child, TPredicate, TPredicateValue>;
 
     fn for_segment(
         &self,
         segment_local_id: u32,
         segment_reader: &SegmentReader,
-    ) -> crate::Result<FilterSegmentCollector<TCollector::Child, TPredicate>> {
+    ) -> crate::Result<FilterSegmentCollector<TCollector::Child, TPredicate, TPredicateValue>> {
+        let schema = segment_reader.schema();
+        let field_entry = schema.get_field_entry(self.field);
+        if !field_entry.is_fast() {
+            return Err(TantivyError::SchemaError(format!(
+                "Field {:?} is not a fast field.",
+                field_entry.name()
+            )));
+        }
+        let requested_type = TPredicateValue::to_type();
+        let field_schema_type = field_entry.field_type().value_type();
+        if requested_type != field_schema_type {
+            return Err(TantivyError::SchemaError(format!(
+                "Field {:?} is of type {:?}!={:?}",
+                field_entry.name(),
+                requested_type,
+                field_schema_type
+            )));
+        }
+
         let fast_field_reader = segment_reader
             .fast_fields()
-            .u64(self.field)
-            .ok_or_else(|| {
-                let field_name = segment_reader.schema().get_field_name(self.field);
-                TantivyError::SchemaError(format!(
-                    "Field {:?} is not a u64 fast field.",
-                    field_name
-                ))
-            })?;
+            .typed_fast_field_reader(self.field)?;
+
         let segment_collector = self
             .collector
             .for_segment(segment_local_id, segment_reader)?;
+
         Ok(FilterSegmentCollector {
             fast_field_reader,
             segment_collector,
-            predicate: self.predicate,
+            predicate: self.predicate.clone(),
+            t_predicate_value: PhantomData,
         })
     }
 
@@ -128,20 +150,23 @@ where
     }
 }
 
-pub struct FilterSegmentCollector<TSegmentCollector, TPredicate>
+pub struct FilterSegmentCollector<TSegmentCollector, TPredicate, TPredicateValue>
 where
     TPredicate: 'static,
+    TPredicateValue: FastValue,
 {
-    fast_field_reader: FastFieldReader<u64>,
+    fast_field_reader: FastFieldReader<TPredicateValue>,
     segment_collector: TSegmentCollector,
-    predicate: &'static TPredicate,
+    predicate: TPredicate,
+    t_predicate_value: PhantomData<TPredicateValue>,
 }
 
-impl<TSegmentCollector, TPredicate> SegmentCollector
-    for FilterSegmentCollector<TSegmentCollector, TPredicate>
+impl<TSegmentCollector, TPredicate, TPredicateValue> SegmentCollector
+    for FilterSegmentCollector<TSegmentCollector, TPredicate, TPredicateValue>
 where
     TSegmentCollector: SegmentCollector,
-    TPredicate: 'static + Fn(u64) -> bool + Send + Sync,
+    TPredicate: 'static + Fn(TPredicateValue) -> bool + Send + Sync,
+    TPredicateValue: FastValue,
 {
     type Fruit = TSegmentCollector::Fruit;
 

src/collector/histogram_collector.rs

@@ -0,0 +1,291 @@
+use crate::collector::{Collector, SegmentCollector};
+use crate::fastfield::{FastFieldReader, FastValue};
+use crate::schema::{Field, Type};
+use crate::{DocId, Score};
+use fastdivide::DividerU64;
+
+/// Histogram builds an histogram of the values of a fastfield for the
+/// collected DocSet.
+///
+/// At construction, it is given parameters that define a partition of an interval
+/// [min_val, max_val) into N buckets with the same width.
+/// The ith bucket is then defined by `[min_val + i * bucket_width, min_val + (i+1) * bucket_width)`
+///
+/// An histogram is then defined as a `Vec<u64>` of length `num_buckets`, that contains a count of
+/// documents for each value bucket.
+///
+/// See also [`HistogramCollector::new()`].
+///
+/// # Warning
+///
+/// f64 field. are not supported.
+#[derive(Clone)]
+pub struct HistogramCollector {
+    min_value: u64,
+    num_buckets: usize,
+    divider: DividerU64,
+    field: Field,
+}
+
+impl HistogramCollector {
+    /// Builds a new HistogramCollector.
+    ///
+    /// The scale/range of the histogram is not dynamic. It is required to
+    /// define it by supplying following parameter:
+    ///  - `min_value`: the minimum value that can be recorded in the histogram.
+    ///  - `bucket_width`: the length of the interval that is associated to each buckets.
+    ///  - `num_buckets`: The overall number of buckets.
+    ///
+    /// Together, this parameters define a partition of `[min_value, min_value + num_buckets * bucket_width)`
+    /// into `num_buckets` intervals of width bucket that we call `bucket`.
+    ///
+    /// # Disclaimer
+    /// This function panics if the field given is of type f64.
+    pub fn new<TFastValue: FastValue>(
+        field: Field,
+        min_value: TFastValue,
+        bucket_width: u64,
+        num_buckets: usize,
+    ) -> HistogramCollector {
+        let fast_type = TFastValue::to_type();
+        assert!(fast_type == Type::U64 || fast_type == Type::I64 || fast_type == Type::Date);
+        HistogramCollector {
+            min_value: min_value.to_u64(),
+            num_buckets,
+            field,
+            divider: DividerU64::divide_by(bucket_width),
+        }
+    }
+}
+
+struct HistogramComputer {
+    counts: Vec<u64>,
+    min_value: u64,
+    divider: DividerU64,
+}
+
+impl HistogramComputer {
+    #[inline]
+    pub(crate) fn add_value(&mut self, value: u64) {
+        if value < self.min_value {
+            return;
+        }
+        let delta = value - self.min_value;
+        let delta_u64 = delta.to_u64();
+        let bucket_id: usize = self.divider.divide(delta_u64) as usize;
+        if bucket_id < self.counts.len() {
+            self.counts[bucket_id] += 1;
+        }
+    }
+
+    fn harvest(self) -> Vec<u64> {
+        self.counts
+    }
+}
+pub struct SegmentHistogramCollector {
+    histogram_computer: HistogramComputer,
+    ff_reader: FastFieldReader<u64>,
+}
+
+impl SegmentCollector for SegmentHistogramCollector {
+    type Fruit = Vec<u64>;
+
+    fn collect(&mut self, doc: DocId, _score: Score) {
+        let value = self.ff_reader.get(doc);
+        self.histogram_computer.add_value(value);
+    }
+
+    fn harvest(self) -> Self::Fruit {
+        self.histogram_computer.harvest()
+    }
+}
+
+impl Collector for HistogramCollector {
+    type Fruit = Vec<u64>;
+    type Child = SegmentHistogramCollector;
+
+    fn for_segment(
+        &self,
+        _segment_local_id: crate::SegmentLocalId,
+        segment: &crate::SegmentReader,
+    ) -> crate::Result<Self::Child> {
+        let ff_reader = segment.fast_fields().u64_lenient(self.field)?;
+        Ok(SegmentHistogramCollector {
+            histogram_computer: HistogramComputer {
+                counts: vec![0; self.num_buckets],
+                min_value: self.min_value,
+                divider: self.divider,
+            },
+            ff_reader,
+        })
+    }
+
+    fn requires_scoring(&self) -> bool {
+        false
+    }
+
+    fn merge_fruits(&self, child_histograms: Vec<Vec<u64>>) -> crate::Result<Vec<u64>> {
+        Ok(add_vecs(child_histograms, self.num_buckets))
+    }
+}
+
+pub fn add_arrays_into(acc: &mut [u64], add: &[u64]) {
+    assert_eq!(acc.len(), add.len());
+    for (dest_bucket, bucket_count) in acc.iter_mut().zip(add) {
+        *dest_bucket += bucket_count;
+    }
+}
+
+fn add_vecs(mut vals_list: Vec<Vec<u64>>, len: usize) -> Vec<u64> {
+    let mut acc = vals_list.pop().unwrap_or_else(|| vec![0u64; len]);
+    assert_eq!(acc.len(), len);
+    for vals in vals_list {
+        add_arrays_into(&mut acc, &vals);
+    }
+    acc
+}
+
+#[cfg(test)]
+mod tests {
+    use super::{add_vecs, HistogramCollector, HistogramComputer};
+    use crate::chrono::{TimeZone, Utc};
+    use crate::schema::{Schema, FAST};
+    use crate::{doc, query, Index};
+    use fastdivide::DividerU64;
+    use query::AllQuery;
+
+    #[test]
+    fn test_add_histograms_simple() {
+        assert_eq!(
+            add_vecs(vec![vec![1, 0, 3], vec![11, 2, 3], vec![0, 0, 1]], 3),
+            vec![12, 2, 7]
+        )
+    }
+
+    #[test]
+    fn test_add_histograms_empty() {
+        assert_eq!(add_vecs(vec![], 3), vec![0, 0, 0])
+    }
+
+    #[test]
+    fn test_histogram_builder_simple() {
+        // [1..3)
+        // [3..5)
+        // ..
+        // [9..11)
+        let mut histogram_computer = HistogramComputer {
+            counts: vec![0; 5],
+            min_value: 1,
+            divider: DividerU64::divide_by(2),
+        };
+        histogram_computer.add_value(1);
+        histogram_computer.add_value(7);
+        assert_eq!(histogram_computer.harvest(), vec![1, 0, 0, 1, 0]);
+    }
+
+    #[test]
+    fn test_histogram_too_low_is_ignored() {
+        let mut histogram_computer = HistogramComputer {
+            counts: vec![0; 5],
+            min_value: 2,
+            divider: DividerU64::divide_by(2),
+        };
+        histogram_computer.add_value(0);
+        assert_eq!(histogram_computer.harvest(), vec![0, 0, 0, 0, 0]);
+    }
+
+    #[test]
+    fn test_histogram_too_high_is_ignored() {
+        let mut histogram_computer = HistogramComputer {
+            counts: vec![0u64; 5],
+            min_value: 0,
+            divider: DividerU64::divide_by(2),
+        };
+        histogram_computer.add_value(10);
+        assert_eq!(histogram_computer.harvest(), vec![0, 0, 0, 0, 0]);
+    }
+    #[test]
+    fn test_no_segments() -> crate::Result<()> {
+        let mut schema_builder = Schema::builder();
+        let val_field = schema_builder.add_u64_field("val_field", FAST);
+        let schema = schema_builder.build();
+        let index = Index::create_in_ram(schema);
+        let reader = index.reader()?;
+        let searcher = reader.searcher();
+        let all_query = AllQuery;
+        let histogram_collector = HistogramCollector::new(val_field, 0u64, 2, 5);
+        let histogram = searcher.search(&all_query, &histogram_collector)?;
+        assert_eq!(histogram, vec![0; 5]);
+        Ok(())
+    }
+
+    #[test]
+    fn test_histogram_i64() -> crate::Result<()> {
+        let mut schema_builder = Schema::builder();
+        let val_field = schema_builder.add_i64_field("val_field", FAST);
+        let schema = schema_builder.build();
+        let index = Index::create_in_ram(schema);
+        let mut writer = index.writer_with_num_threads(1, 4_000_000)?;
+        writer.add_document(doc!(val_field=>12i64));
+        writer.add_document(doc!(val_field=>-30i64));
+        writer.add_document(doc!(val_field=>-12i64));
+        writer.add_document(doc!(val_field=>-10i64));
+        writer.commit()?;
+        let reader = index.reader()?;
+        let searcher = reader.searcher();
+        let all_query = AllQuery;
+        let histogram_collector = HistogramCollector::new(val_field, -20i64, 10u64, 4);
+        let histogram = searcher.search(&all_query, &histogram_collector)?;
+        assert_eq!(histogram, vec![1, 1, 0, 1]);
+        Ok(())
+    }
+
+    #[test]
+    fn test_histogram_merge() -> crate::Result<()> {
+        let mut schema_builder = Schema::builder();
+        let val_field = schema_builder.add_i64_field("val_field", FAST);
+        let schema = schema_builder.build();
+        let index = Index::create_in_ram(schema);
+        let mut writer = index.writer_with_num_threads(1, 4_000_000)?;
+        writer.add_document(doc!(val_field=>12i64));
+        writer.commit()?;
+        writer.add_document(doc!(val_field=>-30i64));
+        writer.commit()?;
+        writer.add_document(doc!(val_field=>-12i64));
+        writer.commit()?;
+        writer.add_document(doc!(val_field=>-10i64));
+        writer.commit()?;
+        let reader = index.reader()?;
+        let searcher = reader.searcher();
+        let all_query = AllQuery;
+        let histogram_collector = HistogramCollector::new(val_field, -20i64, 10u64, 4);
+        let histogram = searcher.search(&all_query, &histogram_collector)?;
+        assert_eq!(histogram, vec![1, 1, 0, 1]);
+        Ok(())
+    }
+
+    #[test]
+    fn test_histogram_dates() -> crate::Result<()> {
+        let mut schema_builder = Schema::builder();
+        let date_field = schema_builder.add_date_field("date_field", FAST);
+        let schema = schema_builder.build();
+        let index = Index::create_in_ram(schema);
+        let mut writer = index.writer_with_num_threads(1, 4_000_000)?;
+        writer.add_document(doc!(date_field=>Utc.ymd(1982, 9, 17).and_hms(0, 0,0)));
+        writer.add_document(doc!(date_field=>Utc.ymd(1986, 3, 9).and_hms(0, 0, 0)));
+        writer.add_document(doc!(date_field=>Utc.ymd(1983, 9, 27).and_hms(0, 0, 0)));
+        writer.commit()?;
+        let reader = index.reader()?;
+        let searcher = reader.searcher();
+        let all_query = AllQuery;
+        let week_histogram_collector = HistogramCollector::new(
+            date_field,
+            Utc.ymd(1980, 1, 1).and_hms(0, 0, 0),
+            3600 * 24 * 365, // it is just for a unit test... sorry leap years.
+            10,
+        );
+        let week_histogram = searcher.search(&all_query, &week_histogram_collector)?;
+        assert_eq!(week_histogram, vec![0, 0, 1, 1, 0, 0, 1, 0, 0, 0]);
+        Ok(())
+    }
+}

src/collector/mod.rs

@@ -93,6 +93,9 @@ use downcast_rs::impl_downcast;
 mod count_collector;
 pub use self::count_collector::Count;
 
+mod histogram_collector;
+pub use histogram_collector::HistogramCollector;
+
 mod multi_collector;
 pub use self::multi_collector::MultiCollector;
 
@@ -109,6 +112,7 @@ pub use self::tweak_score_top_collector::{ScoreSegmentTweaker, ScoreTweaker};
 
 mod facet_collector;
 pub use self::facet_collector::FacetCollector;
+pub use self::facet_collector::FacetCounts;
 use crate::query::Weight;
 
 mod docset_collector;
@@ -189,6 +193,61 @@ pub trait Collector: Sync + Send {
     }
 }
 
+impl<TSegmentCollector: SegmentCollector> SegmentCollector for Option<TSegmentCollector> {
+    type Fruit = Option<TSegmentCollector::Fruit>;
+
+    fn collect(&mut self, doc: DocId, score: Score) {
+        if let Some(segment_collector) = self {
+            segment_collector.collect(doc, score);
+        }
+    }
+
+    fn harvest(self) -> Self::Fruit {
+        self.map(|segment_collector| segment_collector.harvest())
+    }
+}
+
+impl<TCollector: Collector> Collector for Option<TCollector> {
+    type Fruit = Option<TCollector::Fruit>;
+
+    type Child = Option<<TCollector as Collector>::Child>;
+
+    fn for_segment(
+        &self,
+        segment_local_id: SegmentLocalId,
+        segment: &SegmentReader,
+    ) -> crate::Result<Self::Child> {
+        Ok(if let Some(inner) = self {
+            let inner_segment_collector = inner.for_segment(segment_local_id, segment)?;
+            Some(inner_segment_collector)
+        } else {
+            None
+        })
+    }
+
+    fn requires_scoring(&self) -> bool {
+        self.as_ref()
+            .map(|inner| inner.requires_scoring())
+            .unwrap_or(false)
+    }
+
+    fn merge_fruits(
+        &self,
+        segment_fruits: Vec<<Self::Child as SegmentCollector>::Fruit>,
+    ) -> crate::Result<Self::Fruit> {
+        if let Some(inner) = self.as_ref() {
+            let inner_segment_fruits: Vec<_> = segment_fruits
+                .into_iter()
+                .flat_map(|fruit_opt| fruit_opt.into_iter())
+                .collect();
+            let fruit = inner.merge_fruits(inner_segment_fruits)?;
+            Ok(Some(fruit))
+        } else {
+            Ok(None)
+        }
+    }
+}
+
 /// The `SegmentCollector` is the trait in charge of defining the
 /// collect operation at the scale of the segment.
 ///

src/collector/tests.rs

@@ -3,10 +3,17 @@ use crate::core::SegmentReader;
 use crate::fastfield::BytesFastFieldReader;
 use crate::fastfield::FastFieldReader;
 use crate::schema::Field;
-use crate::DocAddress;
 use crate::DocId;
 use crate::Score;
 use crate::SegmentLocalId;
+use crate::{DocAddress, Document, Searcher};
+
+use crate::collector::{Count, FilterCollector, TopDocs};
+use crate::query::{AllQuery, QueryParser};
+use crate::schema::{Schema, FAST, TEXT};
+use crate::DateTime;
+use crate::{doc, Index};
+use std::str::FromStr;
 
 pub const TEST_COLLECTOR_WITH_SCORE: TestCollector = TestCollector {
     compute_score: true,
@@ -16,6 +23,54 @@ pub const TEST_COLLECTOR_WITHOUT_SCORE: TestCollector = TestCollector {
     compute_score: true,
 };
 
+#[test]
+pub fn test_filter_collector() {
+    let mut schema_builder = Schema::builder();
+    let title = schema_builder.add_text_field("title", TEXT);
+    let price = schema_builder.add_u64_field("price", FAST);
+    let date = schema_builder.add_date_field("date", FAST);
+    let schema = schema_builder.build();
+    let index = Index::create_in_ram(schema);
+
+    let mut index_writer = index.writer_with_num_threads(1, 10_000_000).unwrap();
+    index_writer.add_document(doc!(title => "The Name of the Wind", price => 30_200u64, date => DateTime::from_str("1898-04-09T00:00:00+00:00").unwrap()));
+    index_writer.add_document(doc!(title => "The Diary of Muadib", price => 29_240u64, date => DateTime::from_str("2020-04-09T00:00:00+00:00").unwrap()));
+    index_writer.add_document(doc!(title => "The Diary of Anne Frank", price => 18_240u64, date => DateTime::from_str("2019-04-20T00:00:00+00:00").unwrap()));
+    index_writer.add_document(doc!(title => "A Dairy Cow", price => 21_240u64, date => DateTime::from_str("2019-04-09T00:00:00+00:00").unwrap()));
+    index_writer.add_document(doc!(title => "The Diary of a Young Girl", price => 20_120u64, date => DateTime::from_str("2018-04-09T00:00:00+00:00").unwrap()));
+    assert!(index_writer.commit().is_ok());
+
+    let reader = index.reader().unwrap();
+    let searcher = reader.searcher();
+
+    let query_parser = QueryParser::for_index(&index, vec![title]);
+    let query = query_parser.parse_query("diary").unwrap();
+    let filter_some_collector = FilterCollector::new(
+        price,
+        &|value: u64| value > 20_120u64,
+        TopDocs::with_limit(2),
+    );
+    let top_docs = searcher.search(&query, &filter_some_collector).unwrap();
+
+    assert_eq!(top_docs.len(), 1);
+    assert_eq!(top_docs[0].1, DocAddress(0, 1));
+
+    let filter_all_collector: FilterCollector<_, _, u64> =
+        FilterCollector::new(price, &|value| value < 5u64, TopDocs::with_limit(2));
+    let filtered_top_docs = searcher.search(&query, &filter_all_collector).unwrap();
+
+    assert_eq!(filtered_top_docs.len(), 0);
+
+    fn date_filter(value: DateTime) -> bool {
+        (value - DateTime::from_str("2019-04-09T00:00:00+00:00").unwrap()).num_weeks() > 0
+    }
+
+    let filter_dates_collector = FilterCollector::new(date, &date_filter, TopDocs::with_limit(5));
+    let filtered_date_docs = searcher.search(&query, &filter_dates_collector).unwrap();
+
+    assert_eq!(filtered_date_docs.len(), 2);
+}
+
 /// Stores all of the doc ids.
 /// This collector is only used for tests.
 /// It is unusable in pr
@@ -185,12 +240,7 @@ impl Collector for BytesFastFieldTestCollector {
         _segment_local_id: u32,
         segment_reader: &SegmentReader,
     ) -> crate::Result<BytesFastFieldSegmentCollector> {
-        let reader = segment_reader
-            .fast_fields()
-            .bytes(self.field)
-            .ok_or_else(|| {
-                crate::TantivyError::InvalidArgument("Field is not a bytes fast field.".to_string())
-            })?;
+        let reader = segment_reader.fast_fields().bytes(self.field)?;
         Ok(BytesFastFieldSegmentCollector {
             vals: Vec::new(),
             reader,
@@ -218,3 +268,30 @@ impl SegmentCollector for BytesFastFieldSegmentCollector {
         self.vals
     }
 }
+
+fn make_test_searcher() -> crate::Result<crate::LeasedItem<Searcher>> {
+    let schema = Schema::builder().build();
+    let index = Index::create_in_ram(schema);
+    let mut index_writer = index.writer_for_tests()?;
+    index_writer.add_document(Document::default());
+    index_writer.add_document(Document::default());
+    index_writer.commit()?;
+    Ok(index.reader()?.searcher())
+}
+
+#[test]
+fn test_option_collector_some() -> crate::Result<()> {
+    let searcher = make_test_searcher()?;
+    let counts = searcher.search(&AllQuery, &Some(Count))?;
+    assert_eq!(counts, Some(2));
+    Ok(())
+}
+
+#[test]
+fn test_option_collector_none() -> crate::Result<()> {
+    let searcher = make_test_searcher()?;
+    let none_collector: Option<Count> = None;
+    let counts = searcher.search(&AllQuery, &none_collector)?;
+    assert_eq!(counts, None);
+    Ok(())
+}

src/collector/top_collector.rs

@@ -2,9 +2,9 @@ use crate::DocAddress;
 use crate::DocId;
 use crate::SegmentLocalId;
 use crate::SegmentReader;
-use serde::export::PhantomData;
 use std::cmp::Ordering;
 use std::collections::BinaryHeap;
+use std::marker::PhantomData;
 
 /// Contains a feature (field, score, etc.) of a document along with the document address.
 ///
@@ -120,11 +120,8 @@ where
         &self,
         segment_id: SegmentLocalId,
         _: &SegmentReader,
-    ) -> crate::Result<TopSegmentCollector<F>> {
-        Ok(TopSegmentCollector::new(
-            segment_id,
-            self.limit + self.offset,
-        ))
+    ) -> TopSegmentCollector<F> {
+        TopSegmentCollector::new(segment_id, self.limit + self.offset)
     }
 
     /// Create a new TopCollector with the same limit and offset.

src/collector/top_score_collector.rs

@@ -29,7 +29,7 @@ struct FastFieldConvertCollector<
 impl<TCollector, TFastValue> Collector for FastFieldConvertCollector<TCollector, TFastValue>
 where
     TCollector: Collector<Fruit = Vec<(u64, DocAddress)>>,
-    TFastValue: FastValue + 'static,
+    TFastValue: FastValue,
 {
     type Fruit = Vec<(TFastValue, DocAddress)>;
 
@@ -146,15 +146,14 @@ impl CustomScorer<u64> for ScorerByField {
     type Child = ScorerByFastFieldReader;
 
     fn segment_scorer(&self, segment_reader: &SegmentReader) -> crate::Result<Self::Child> {
-        let ff_reader = segment_reader
+        // We interpret this field as u64, regardless of its type, that way,
+        // we avoid needless conversion. Regardless of the fast field type, the
+        // mapping is monotonic, so it is sufficient to compute our top-K docs.
+        //
+        // The conversion will then happen only on the top-K docs.
+        let ff_reader: FastFieldReader<u64> = segment_reader
             .fast_fields()
-            .u64_lenient(self.field)
-            .ok_or_else(|| {
-                crate::TantivyError::SchemaError(format!(
-                    "Field requested ({:?}) is not a fast field.",
-                    self.field
-                ))
-            })?;
+            .typed_fast_field_reader(self.field)?;
         Ok(ScorerByFastFieldReader { ff_reader })
     }
 }
@@ -232,7 +231,7 @@ impl TopDocs {
     /// #   let title = schema_builder.add_text_field("title", TEXT);
     /// #   let rating = schema_builder.add_u64_field("rating", FAST);
     /// #   let schema = schema_builder.build();
-    /// #  
+    /// #
     /// #   let index = Index::create_in_ram(schema);
     /// #   let mut index_writer = index.writer_with_num_threads(1, 10_000_000)?;
     /// #   index_writer.add_document(doc!(title => "The Name of the Wind", rating => 92u64));
@@ -262,7 +261,7 @@ impl TopDocs {
     ///     let top_books_by_rating = TopDocs
     ///                 ::with_limit(10)
     ///                  .order_by_u64_field(rating_field);
-    ///     
+    ///
     ///     // ... and here are our documents. Note this is a simple vec.
     ///     // The `u64` in the pair is the value of our fast field for
     ///     // each documents.
@@ -272,13 +271,13 @@ impl TopDocs {
     ///     // query.
     ///     let resulting_docs: Vec<(u64, DocAddress)> =
     ///          searcher.search(query, &top_books_by_rating)?;
-    ///     
+    ///
     ///     Ok(resulting_docs)
     /// }
     /// ```
     ///
     /// # See also
-    ///  
+    ///
     /// To confortably work with `u64`s, `i64`s, `f64`s, or `date`s, please refer to
     /// [.order_by_fast_field(...)](#method.order_by_fast_field) method.
     pub fn order_by_u64_field(
@@ -290,7 +289,7 @@ impl TopDocs {
 
     /// Set top-K to rank documents by a given fast field.
     ///
-    /// If the field is not a fast field, or its field type does not match the generic type, this method does not panic,  
+    /// If the field is not a fast field, or its field type does not match the generic type, this method does not panic,
     /// but an explicit error will be returned at the moment of collection.
     ///
     /// Note that this method is a generic. The requested fast field type will be often
@@ -314,7 +313,7 @@ impl TopDocs {
     /// #   let title = schema_builder.add_text_field("company", TEXT);
     /// #   let rating = schema_builder.add_i64_field("revenue", FAST);
     /// #   let schema = schema_builder.build();
-    /// #  
+    /// #
     /// #   let index = Index::create_in_ram(schema);
     /// #   let mut index_writer = index.writer_with_num_threads(1, 10_000_000)?;
     /// #   index_writer.add_document(doc!(title => "MadCow Inc.", rating => 92_000_000i64));
@@ -343,7 +342,7 @@ impl TopDocs {
     ///     let top_company_by_revenue = TopDocs
     ///                 ::with_limit(2)
     ///                  .order_by_fast_field(revenue_field);
-    ///     
+    ///
     ///     // ... and here are our documents. Note this is a simple vec.
     ///     // The `i64` in the pair is the value of our fast field for
     ///     // each documents.
@@ -353,7 +352,7 @@ impl TopDocs {
     ///     // query.
     ///     let resulting_docs: Vec<(i64, DocAddress)> =
     ///          searcher.search(query, &top_company_by_revenue)?;
-    ///     
+    ///
     ///     Ok(resulting_docs)
     /// }
     /// ```
@@ -362,7 +361,7 @@ impl TopDocs {
         fast_field: Field,
     ) -> impl Collector<Fruit = Vec<(TFastValue, DocAddress)>>
     where
-        TFastValue: FastValue + 'static,
+        TFastValue: FastValue,
     {
         let u64_collector = self.order_by_u64_field(fast_field);
         FastFieldConvertCollector {
@@ -392,7 +391,7 @@ impl TopDocs {
     ///
     /// In the following example will will tweak our ranking a bit by
     /// boosting popular products a notch.
-    ///  
+    ///
     /// In more serious application, this tweaking could involved running a
     /// learning-to-rank model over various features
     ///
@@ -523,7 +522,7 @@ impl TopDocs {
     /// #   let index = Index::create_in_ram(schema);
     /// #   let mut index_writer = index.writer_with_num_threads(1, 10_000_000)?;
     /// #   let product_name = index.schema().get_field("product_name").unwrap();
-    /// #   
+    /// #
     /// let popularity: Field = index.schema().get_field("popularity").unwrap();
     /// let boosted: Field = index.schema().get_field("boosted").unwrap();
     /// #   index_writer.add_document(doc!(boosted=>1u64, product_name => "The Diary of Muadib", popularity => 1u64));
@@ -557,7 +556,7 @@ impl TopDocs {
     ///                 segment_reader.fast_fields().u64(popularity).unwrap();
     ///             let boosted_reader =
     ///                 segment_reader.fast_fields().u64(boosted).unwrap();
-    ///    
+    ///
     ///             // We can now define our actual scoring function
     ///             move |doc: DocId| {
     ///                 let popularity: u64 = popularity_reader.get(doc);
@@ -604,7 +603,7 @@ impl Collector for TopDocs {
         segment_local_id: SegmentLocalId,
         reader: &SegmentReader,
     ) -> crate::Result<Self::Child> {
-        let collector = self.0.for_segment(segment_local_id, reader)?;
+        let collector = self.0.for_segment(segment_local_id, reader);
         Ok(TopScoreSegmentCollector(collector))
     }
 
@@ -728,7 +727,7 @@ mod tests {
     }
 
     #[test]
-    fn test_top_collector_not_at_capacity() {
+    fn test_top_collector_not_at_capacity_without_offset() {
         let index = make_index();
         let field = index.schema().get_field("text").unwrap();
         let query_parser = QueryParser::for_index(&index, vec![field]);
@@ -994,9 +993,7 @@ mod tests {
         let segment = searcher.segment_reader(0);
         let top_collector = TopDocs::with_limit(4).order_by_u64_field(size);
         let err = top_collector.for_segment(0, segment).err().unwrap();
-        assert!(
-            matches!(err, crate::TantivyError::SchemaError(msg) if msg == "Field requested (Field(0)) is not a fast field.")
-        );
+        assert!(matches!(err, crate::TantivyError::SchemaError(_)));
         Ok(())
     }
 

src/collector/tweak_score_top_collector.rs

@@ -62,9 +62,7 @@ where
         segment_reader: &SegmentReader,
     ) -> Result<Self::Child> {
         let segment_scorer = self.score_tweaker.segment_tweaker(segment_reader)?;
-        let segment_collector = self
-            .collector
-            .for_segment(segment_local_id, segment_reader)?;
+        let segment_collector = self.collector.for_segment(segment_local_id, segment_reader);
         Ok(TopTweakedScoreSegmentCollector {
             segment_collector,
             segment_scorer,

src/common/composite_file.rs

@@ -8,6 +8,8 @@ use crate::space_usage::FieldUsage;
 use crate::space_usage::PerFieldSpaceUsage;
 use std::collections::HashMap;
 use std::io::{self, Read, Write};
+use std::iter::ExactSizeIterator;
+use std::ops::Range;
 
 use super::HasLen;
 
@@ -105,7 +107,7 @@ impl<W: TerminatingWrite + Write> CompositeWrite<W> {
 #[derive(Clone)]
 pub struct CompositeFile {
     data: FileSlice,
-    offsets_index: HashMap<FileAddr, (usize, usize)>,
+    offsets_index: HashMap<FileAddr, Range<usize>>,
 }
 
 impl CompositeFile {
@@ -117,7 +119,7 @@ impl CompositeFile {
         let footer_len = u32::deserialize(&mut footer_len_data.as_slice())? as usize;
         let footer_start = end - 4 - footer_len;
         let footer_data = data
-            .slice(footer_start, footer_start + footer_len)
+            .slice(footer_start..footer_start + footer_len)
             .read_bytes()?;
         let mut footer_buffer = footer_data.as_slice();
         let num_fields = VInt::deserialize(&mut footer_buffer)?.0 as usize;
@@ -138,7 +140,7 @@ impl CompositeFile {
             let file_addr = file_addrs[i];
             let start_offset = offsets[i];
             let end_offset = offsets[i + 1];
-            field_index.insert(file_addr, (start_offset, end_offset));
+            field_index.insert(file_addr, start_offset..end_offset);
         }
 
         Ok(CompositeFile {
@@ -167,16 +169,16 @@ impl CompositeFile {
     pub fn open_read_with_idx(&self, field: Field, idx: usize) -> Option<FileSlice> {
         self.offsets_index
             .get(&FileAddr { field, idx })
-            .map(|&(from, to)| self.data.slice(from, to))
+            .map(|byte_range| self.data.slice(byte_range.clone()))
     }
 
     pub fn space_usage(&self) -> PerFieldSpaceUsage {
         let mut fields = HashMap::new();
-        for (&field_addr, &(start, end)) in self.offsets_index.iter() {
+        for (&field_addr, byte_range) in &self.offsets_index {
             fields
                 .entry(field_addr.field)
                 .or_insert_with(|| FieldUsage::empty(field_addr.field))
-                .add_field_idx(field_addr.idx, end - start);
+                .add_field_idx(field_addr.idx, byte_range.len());
         }
         PerFieldSpaceUsage::new(fields)
     }

src/common/mod.rs

@@ -115,11 +115,16 @@ pub fn u64_to_i64(val: u64) -> i64 {
 /// For simplicity, tantivy internally handles `f64` as `u64`.
 /// The mapping is defined by this function.
 ///
-/// Maps `f64` to `u64` so that lexical order is preserved.
+/// Maps `f64` to `u64` in a monotonic manner, so that bytes lexical order is preserved.
 ///
 /// This is more suited than simply casting (`val as u64`)
 /// which would truncate the result
 ///
+/// # Reference
+///
+/// Daniel Lemire's [blog post](https://lemire.me/blog/2020/12/14/converting-floating-point-numbers-to-integers-while-preserving-order/)
+/// explains the mapping in a clear manner.
+///
 /// # See also
 /// The [reverse mapping is `u64_to_f64`](./fn.u64_to_f64.html).
 #[inline(always)]
@@ -148,6 +153,7 @@ pub(crate) mod test {
     pub use super::minmax;
     pub use super::serialize::test::fixed_size_test;
     use super::{compute_num_bits, f64_to_u64, i64_to_u64, u64_to_f64, u64_to_i64};
+    use proptest::prelude::*;
     use std::f64;
 
     fn test_i64_converter_helper(val: i64) {
@@ -158,6 +164,15 @@ pub(crate) mod test {
         assert_eq!(u64_to_f64(f64_to_u64(val)), val);
     }
 
+    proptest! {
+        #[test]
+        fn test_f64_converter_monotonicity_proptest((left, right) in (proptest::num::f64::NORMAL, proptest::num::f64::NORMAL)) {
+            let left_u64 = f64_to_u64(left);
+            let right_u64 = f64_to_u64(right);
+            assert_eq!(left_u64 < right_u64,  left < right);
+        }
+    }
+
     #[test]
     fn test_i64_converter() {
         assert_eq!(i64_to_u64(i64::min_value()), u64::min_value());

src/core/index.rs

@@ -35,12 +35,21 @@ fn load_metas(
     inventory: &SegmentMetaInventory,
 ) -> crate::Result<IndexMeta> {
     let meta_data = directory.atomic_read(&META_FILEPATH)?;
-    let meta_string = String::from_utf8_lossy(&meta_data);
+    let meta_string = String::from_utf8(meta_data).map_err(|_utf8_err| {
+        error!("Meta data is not valid utf8.");
+        DataCorruption::new(
+            META_FILEPATH.to_path_buf(),
+            "Meta file does not contain valid utf8 file.".to_string(),
+        )
+    })?;
     IndexMeta::deserialize(&meta_string, &inventory)
         .map_err(|e| {
             DataCorruption::new(
                 META_FILEPATH.to_path_buf(),
-                format!("Meta file cannot be deserialized. {:?}.", e),
+                format!(
+                    "Meta file cannot be deserialized. {:?}. Content: {:?}",
+                    e, meta_string
+                ),
             )
         })
         .map_err(From::from)
@@ -156,7 +165,8 @@ impl Index {
     fn from_directory(directory: ManagedDirectory, schema: Schema) -> crate::Result<Index> {
         save_new_metas(schema.clone(), &directory)?;
         let metas = IndexMeta::with_schema(schema);
-        Index::create_from_metas(directory, &metas, SegmentMetaInventory::default())
+        let index = Index::create_from_metas(directory, &metas, SegmentMetaInventory::default());
+        Ok(index)
     }
 
     /// Creates a new index given a directory and an `IndexMeta`.
@@ -164,15 +174,15 @@ impl Index {
         directory: ManagedDirectory,
         metas: &IndexMeta,
         inventory: SegmentMetaInventory,
-    ) -> crate::Result<Index> {
+    ) -> Index {
         let schema = metas.schema.clone();
-        Ok(Index {
+        Index {
             directory,
             schema,
             tokenizers: TokenizerManager::default(),
             executor: Arc::new(Executor::single_thread()),
             inventory,
-        })
+        }
     }
 
     /// Accessor for the tokenizer manager.
@@ -247,7 +257,8 @@ impl Index {
         let directory = ManagedDirectory::wrap(directory)?;
         let inventory = SegmentMetaInventory::default();
         let metas = load_metas(&directory, &inventory)?;
-        Index::create_from_metas(directory, &metas, inventory)
+        let index = Index::create_from_metas(directory, &metas, inventory);
+        Ok(index)
     }
 
     /// Reads the index meta file from the directory.
@@ -511,28 +522,28 @@ mod tests {
         }
 
         #[test]
-        fn test_index_manual_policy_mmap() {
+        fn test_index_manual_policy_mmap() -> crate::Result<()> {
             let schema = throw_away_schema();
             let field = schema.get_field("num_likes").unwrap();
-            let mut index = Index::create_from_tempdir(schema).unwrap();
-            let mut writer = index.writer_for_tests().unwrap();
-            writer.commit().unwrap();
+            let mut index = Index::create_from_tempdir(schema)?;
+            let mut writer = index.writer_for_tests()?;
+            writer.commit()?;
             let reader = index
                 .reader_builder()
                 .reload_policy(ReloadPolicy::Manual)
-                .try_into()
-                .unwrap();
+                .try_into()?;
             assert_eq!(reader.searcher().num_docs(), 0);
             writer.add_document(doc!(field=>1u64));
             let (sender, receiver) = crossbeam::channel::unbounded();
             let _handle = index.directory_mut().watch(WatchCallback::new(move || {
                 let _ = sender.send(());
             }));
-            writer.commit().unwrap();
+            writer.commit()?;
             assert!(receiver.recv().is_ok());
             assert_eq!(reader.searcher().num_docs(), 0);
-            reader.reload().unwrap();
+            reader.reload()?;
             assert_eq!(reader.searcher().num_docs(), 1);
+            Ok(())
         }
 
         #[test]

src/core/inverted_index_reader.rs

@@ -90,9 +90,9 @@ impl InvertedIndexReader {
         term_info: &TermInfo,
         block_postings: &mut BlockSegmentPostings,
     ) -> io::Result<()> {
-        let start_offset = term_info.postings_start_offset as usize;
-        let stop_offset = term_info.postings_stop_offset as usize;
-        let postings_slice = self.postings_file_slice.slice(start_offset, stop_offset);
+        let postings_slice = self
+            .postings_file_slice
+            .slice(term_info.postings_range.clone());
         block_postings.reset(term_info.doc_freq, postings_slice.read_bytes()?);
         Ok(())
     }
@@ -120,10 +120,9 @@ impl InvertedIndexReader {
         term_info: &TermInfo,
         requested_option: IndexRecordOption,
     ) -> io::Result<BlockSegmentPostings> {
-        let postings_data = self.postings_file_slice.slice(
-            term_info.postings_start_offset as usize,
-            term_info.postings_stop_offset as usize,
-        );
+        let postings_data = self
+            .postings_file_slice
+            .slice(term_info.postings_range.clone());
         BlockSegmentPostings::open(
             term_info.doc_freq,
             postings_data,

src/core/segment_reader.rs

@@ -108,24 +108,22 @@ impl SegmentReader {
     /// Accessor to the `FacetReader` associated to a given `Field`.
     pub fn facet_reader(&self, field: Field) -> crate::Result<FacetReader> {
         let field_entry = self.schema.get_field_entry(field);
-        if field_entry.field_type() != &FieldType::HierarchicalFacet {
-            return Err(crate::TantivyError::InvalidArgument(format!(
+
+        match field_entry.field_type() {
+            FieldType::HierarchicalFacet(_) => {
+                let term_ords_reader = self.fast_fields().u64s(field)?;
+                let termdict = self
+                    .termdict_composite
+                    .open_read(field)
+                    .map(TermDictionary::open)
+                    .unwrap_or_else(|| Ok(TermDictionary::empty()))?;
+                Ok(FacetReader::new(term_ords_reader, termdict))
+            }
+            _ => Err(crate::TantivyError::InvalidArgument(format!(
                 "Field {:?} is not a facet field.",
                 field_entry.name()
-            )));
+            ))),
         }
-        let term_ords_reader = self.fast_fields().u64s(field).ok_or_else(|| {
-            DataCorruption::comment_only(format!(
-                "Cannot find data for hierarchical facet {:?}",
-                field_entry.name()
-            ))
-        })?;
-        let termdict = self
-            .termdict_composite
-            .open_read(field)
-            .map(TermDictionary::open)
-            .unwrap_or_else(|| Ok(TermDictionary::empty()))?;
-        Ok(FacetReader::new(term_ords_reader, termdict))
     }
 
     /// Accessor to the segment's `Field norms`'s reader.
@@ -184,7 +182,7 @@ impl SegmentReader {
         let fast_fields_data = segment.open_read(SegmentComponent::FASTFIELDS)?;
         let fast_fields_composite = CompositeFile::open(&fast_fields_data)?;
         let fast_field_readers =
-            Arc::new(FastFieldReaders::load_all(&schema, &fast_fields_composite)?);
+            Arc::new(FastFieldReaders::new(schema.clone(), fast_fields_composite));
 
         let fieldnorm_data = segment.open_read(SegmentComponent::FIELDNORMS)?;
         let fieldnorm_readers = FieldNormReaders::open(fieldnorm_data)?;
@@ -310,7 +308,7 @@ impl SegmentReader {
     }
 
     /// Returns an iterator that will iterate over the alive document ids
-    pub fn doc_ids_alive<'a>(&'a self) -> impl Iterator<Item = DocId> + 'a {
+    pub fn doc_ids_alive(&self) -> impl Iterator<Item = DocId> + '_ {
         (0u32..self.max_doc).filter(move |doc| !self.is_deleted(*doc))
     }
 

src/directory/error.rs

@@ -58,7 +58,8 @@ pub enum OpenWriteError {
 }
 
 impl OpenWriteError {
-    pub(crate) fn wrap_io_error(io_error: io::Error, filepath: PathBuf) -> Self {
+    /// Wraps an io error.
+    pub fn wrap_io_error(io_error: io::Error, filepath: PathBuf) -> Self {
         Self::IOError { io_error, filepath }
     }
 }
@@ -143,7 +144,8 @@ pub enum OpenReadError {
 }
 
 impl OpenReadError {
-    pub(crate) fn wrap_io_error(io_error: io::Error, filepath: PathBuf) -> Self {
+    /// Wraps an io error.
+    pub fn wrap_io_error(io_error: io::Error, filepath: PathBuf) -> Self {
         Self::IOError { io_error, filepath }
     }
 }

src/directory/file_slice.rs

@@ -2,6 +2,8 @@ use stable_deref_trait::StableDeref;
 
 use crate::common::HasLen;
 use crate::directory::OwnedBytes;
+use std::fmt;
+use std::ops::Range;
 use std::sync::{Arc, Weak};
 use std::{io, ops::Deref};
 
@@ -16,23 +18,23 @@ pub type WeakArcBytes = Weak<dyn Deref<Target = [u8]> + Send + Sync + 'static>;
 /// The underlying behavior is therefore specific to the `Directory` that created it.
 /// Despite its name, a `FileSlice` may or may not directly map to an actual file
 /// on the filesystem.
-pub trait FileHandle: 'static + Send + Sync + HasLen {
+pub trait FileHandle: 'static + Send + Sync + HasLen + fmt::Debug {
     /// Reads a slice of bytes.
     ///
     /// This method may panic if the range requested is invalid.
-    fn read_bytes(&self, from: usize, to: usize) -> io::Result<OwnedBytes>;
+    fn read_bytes(&self, range: Range<usize>) -> io::Result<OwnedBytes>;
 }
 
 impl FileHandle for &'static [u8] {
-    fn read_bytes(&self, from: usize, to: usize) -> io::Result<OwnedBytes> {
-        let bytes = &self[from..to];
+    fn read_bytes(&self, range: Range<usize>) -> io::Result<OwnedBytes> {
+        let bytes = &self[range];
         Ok(OwnedBytes::new(bytes))
     }
 }
 
 impl<T: Deref<Target = [u8]>> HasLen for T {
     fn len(&self) -> usize {
-        self.as_ref().len()
+        self.deref().len()
     }
 }
 
@@ -46,14 +48,19 @@ where
 }
 
 /// Logical slice of read only file in tantivy.
-//
+///
 /// It can be cloned and sliced cheaply.
 ///
 #[derive(Clone)]
 pub struct FileSlice {
     data: Arc<dyn FileHandle>,
-    start: usize,
-    stop: usize,
+    range: Range<usize>,
+}
+
+impl fmt::Debug for FileSlice {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        write!(f, "FileSlice({:?}, {:?})", &self.data, self.range)
+    }
 }
 
 impl FileSlice {
@@ -68,8 +75,7 @@ impl FileSlice {
     pub fn new_with_num_bytes(file_handle: Box<dyn FileHandle>, num_bytes: usize) -> Self {
         FileSlice {
             data: Arc::from(file_handle),
-            start: 0,
-            stop: num_bytes,
+            range: 0..num_bytes,
         }
     }
 
@@ -77,14 +83,12 @@ impl FileSlice {
     ///
     /// # Panics
     ///
-    /// Panics if `to < from` or if `to` exceeds the filesize.
-    pub fn slice(&self, from: usize, to: usize) -> FileSlice {
-        assert!(to <= self.len());
-        assert!(to >= from);
+    /// Panics if `byte_range.end` exceeds the filesize.
+    pub fn slice(&self, byte_range: Range<usize>) -> FileSlice {
+        assert!(byte_range.end <= self.len());
         FileSlice {
             data: self.data.clone(),
-            start: self.start + from,
-            stop: self.start + to,
+            range: self.range.start + byte_range.start..self.range.start + byte_range.end,
         }
     }
 
@@ -101,19 +105,21 @@ impl FileSlice {
     /// In particular, it is  up to the `Directory` implementation
     /// to handle caching if needed.
     pub fn read_bytes(&self) -> io::Result<OwnedBytes> {
-        self.data.read_bytes(self.start, self.stop)
+        self.data.read_bytes(self.range.clone())
     }
 
     /// Reads a specific slice of data.
     ///
     /// This is equivalent to running `file_slice.slice(from, to).read_bytes()`.
-    pub fn read_bytes_slice(&self, from: usize, to: usize) -> io::Result<OwnedBytes> {
-        assert!(from <= to);
+    pub fn read_bytes_slice(&self, range: Range<usize>) -> io::Result<OwnedBytes> {
         assert!(
-            self.start + to <= self.stop,
-            "`to` exceeds the fileslice length"
+            range.end <= self.len(),
+            "end of requested range exceeds the fileslice length ({} > {})",
+            range.end,
+            self.len()
         );
-        self.data.read_bytes(self.start + from, self.start + to)
+        self.data
+            .read_bytes(self.range.start + range.start..self.range.start + range.end)
     }
 
     /// Splits the FileSlice at the given offset and return two file slices.
@@ -138,7 +144,7 @@ impl FileSlice {
     ///
     /// Equivalent to `.slice(from_offset, self.len())`
     pub fn slice_from(&self, from_offset: usize) -> FileSlice {
-        self.slice(from_offset, self.len())
+        self.slice(from_offset..self.len())
     }
 
     /// Like `.slice(...)` but enforcing only the `to`
@@ -146,19 +152,19 @@ impl FileSlice {
     ///
     /// Equivalent to `.slice(0, to_offset)`
     pub fn slice_to(&self, to_offset: usize) -> FileSlice {
-        self.slice(0, to_offset)
+        self.slice(0..to_offset)
     }
 }
 
 impl FileHandle for FileSlice {
-    fn read_bytes(&self, from: usize, to: usize) -> io::Result<OwnedBytes> {
-        self.read_bytes_slice(from, to)
+    fn read_bytes(&self, range: Range<usize>) -> io::Result<OwnedBytes> {
+        self.read_bytes_slice(range)
     }
 }
 
 impl HasLen for FileSlice {
     fn len(&self) -> usize {
-        self.stop - self.start
+        self.range.len()
     }
 }
 
@@ -217,30 +223,23 @@ mod tests {
         let slice = FileSlice::new(Box::new(&b"abcdef"[..]));
         assert_eq!(slice.len(), 6);
         assert_eq!(slice.read_bytes()?.as_ref(), b"abcdef");
-        assert_eq!(slice.slice(1, 4).read_bytes()?.as_ref(), b"bcd");
+        assert_eq!(slice.slice(1..4).read_bytes()?.as_ref(), b"bcd");
         Ok(())
     }
 
     #[test]
     fn test_slice_read_slice() -> io::Result<()> {
         let slice_deref = FileSlice::new(Box::new(&b"abcdef"[..]));
-        assert_eq!(slice_deref.read_bytes_slice(1, 4)?.as_ref(), b"bcd");
+        assert_eq!(slice_deref.read_bytes_slice(1..4)?.as_ref(), b"bcd");
         Ok(())
     }
 
     #[test]
-    #[should_panic(expected = "assertion failed: from <= to")]
-    fn test_slice_read_slice_invalid_range() {
-        let slice_deref = FileSlice::new(Box::new(&b"abcdef"[..]));
-        assert_eq!(slice_deref.read_bytes_slice(1, 0).unwrap().as_ref(), b"bcd");
-    }
-
-    #[test]
-    #[should_panic(expected = "`to` exceeds the fileslice length")]
+    #[should_panic(expected = "end of requested range exceeds the fileslice length (10 > 6)")]
     fn test_slice_read_slice_invalid_range_exceeds() {
         let slice_deref = FileSlice::new(Box::new(&b"abcdef"[..]));
         assert_eq!(
-            slice_deref.read_bytes_slice(0, 10).unwrap().as_ref(),
+            slice_deref.read_bytes_slice(0..10).unwrap().as_ref(),
             b"bcd"
         );
     }

src/directory/file_watcher.rs

@@ -3,7 +3,7 @@ use crc32fast::Hasher;
 use std::fs;
 use std::io;
 use std::io::BufRead;
-use std::path::PathBuf;
+use std::path::Path;
 use std::sync::atomic::{AtomicUsize, Ordering};
 use std::sync::Arc;
 use std::thread;
@@ -13,22 +13,26 @@ pub const POLLING_INTERVAL: Duration = Duration::from_millis(if cfg!(test) { 1 }
 
 // Watches a file and executes registered callbacks when the file is modified.
 pub struct FileWatcher {
-    path: Arc<PathBuf>,
+    path: Arc<Path>,
     callbacks: Arc<WatchCallbackList>,
     state: Arc<AtomicUsize>, // 0: new, 1: runnable, 2: terminated
 }
 
 impl FileWatcher {
-    pub fn new(path: &PathBuf) -> FileWatcher {
+    pub fn new(path: &Path) -> FileWatcher {
         FileWatcher {
-            path: Arc::new(path.clone()),
+            path: Arc::from(path),
             callbacks: Default::default(),
             state: Default::default(),
         }
     }
 
     pub fn spawn(&self) {
-        if self.state.compare_and_swap(0, 1, Ordering::SeqCst) > 0 {
+        if self
+            .state
+            .compare_exchange(0, 1, Ordering::SeqCst, Ordering::SeqCst)
+            .is_err()
+        {
             return;
         }
 
@@ -63,7 +67,7 @@ impl FileWatcher {
         handle
     }
 
-    fn compute_checksum(path: &PathBuf) -> Result<u32, io::Error> {
+    fn compute_checksum(path: &Path) -> Result<u32, io::Error> {
         let reader = match fs::File::open(path) {
             Ok(f) => io::BufReader::new(f),
             Err(e) => {

src/directory/footer.rs

@@ -115,6 +115,18 @@ impl Footer {
                 }
                 Ok(())
             }
+            VersionedFooter::V3 {
+                crc32: _crc,
+                store_compression,
+            } => {
+                if &library_version.store_compression != store_compression {
+                    return Err(Incompatibility::CompressionMismatch {
+                        library_compression_format: library_version.store_compression.to_string(),
+                        index_compression_format: store_compression.to_string(),
+                    });
+                }
+                Ok(())
+            }
             VersionedFooter::UnknownVersion => Err(Incompatibility::IndexMismatch {
                 library_version: library_version.clone(),
                 index_version: self.version.clone(),
@@ -136,24 +148,31 @@ pub enum VersionedFooter {
         crc32: CrcHashU32,
         store_compression: String,
     },
+    // Block wand max termfred on 1 byte
+    V3 {
+        crc32: CrcHashU32,
+        store_compression: String,
+    },
 }
 
 impl BinarySerializable for VersionedFooter {
     fn serialize<W: io::Write>(&self, writer: &mut W) -> io::Result<()> {
         let mut buf = Vec::new();
         match self {
-            VersionedFooter::V2 {
+            VersionedFooter::V3 {
                 crc32,
                 store_compression: compression,
             } => {
                 // Serializes a valid `VersionedFooter` or panics if the version is unknown
                 // [   version    |   crc_hash  | compression_mode ]
                 // [    0..4      |     4..8    |     variable     ]
-                BinarySerializable::serialize(&2u32, &mut buf)?;
+                BinarySerializable::serialize(&3u32, &mut buf)?;
                 BinarySerializable::serialize(crc32, &mut buf)?;
                 BinarySerializable::serialize(compression, &mut buf)?;
             }
-            VersionedFooter::V1 { .. } | VersionedFooter::UnknownVersion => {
+            VersionedFooter::V2 { .. }
+            | VersionedFooter::V1 { .. }
+            | VersionedFooter::UnknownVersion => {
                 return Err(io::Error::new(
                     io::ErrorKind::InvalidInput,
                     "Cannot serialize an unknown versioned footer ",
@@ -182,7 +201,7 @@ impl BinarySerializable for VersionedFooter {
         reader.read_exact(&mut buf[..])?;
         let mut cursor = &buf[..];
         let version = u32::deserialize(&mut cursor)?;
-        if version != 1 && version != 2 {
+        if version > 3 {
             return Ok(VersionedFooter::UnknownVersion);
         }
         let crc32 = u32::deserialize(&mut cursor)?;
@@ -192,12 +211,17 @@ impl BinarySerializable for VersionedFooter {
                 crc32,
                 store_compression,
             }
-        } else {
-            assert_eq!(version, 2);
+        } else if version == 2 {
             VersionedFooter::V2 {
                 crc32,
                 store_compression,
             }
+        } else {
+            assert_eq!(version, 3);
+            VersionedFooter::V3 {
+                crc32,
+                store_compression,
+            }
         })
     }
 }
@@ -205,6 +229,7 @@ impl BinarySerializable for VersionedFooter {
 impl VersionedFooter {
     pub fn crc(&self) -> Option<CrcHashU32> {
         match self {
+            VersionedFooter::V3 { crc32, .. } => Some(*crc32),
             VersionedFooter::V2 { crc32, .. } => Some(*crc32),
             VersionedFooter::V1 { crc32, .. } => Some(*crc32),
             VersionedFooter::UnknownVersion { .. } => None,
@@ -243,7 +268,7 @@ impl<W: TerminatingWrite> Write for FooterProxy<W> {
 impl<W: TerminatingWrite> TerminatingWrite for FooterProxy<W> {
     fn terminate_ref(&mut self, _: AntiCallToken) -> io::Result<()> {
         let crc32 = self.hasher.take().unwrap().finalize();
-        let footer = Footer::new(VersionedFooter::V2 {
+        let footer = Footer::new(VersionedFooter::V3 {
             crc32,
             store_compression: crate::store::COMPRESSION.to_string(),
         });
@@ -278,7 +303,7 @@ mod tests {
         let footer = Footer::deserialize(&mut &vec[..]).unwrap();
         assert!(matches!(
            footer.versioned_footer,
-           VersionedFooter::V2 { store_compression, .. }
+           VersionedFooter::V3 { store_compression, .. }
            if store_compression == crate::store::COMPRESSION
         ));
         assert_eq!(&footer.version, crate::version());
@@ -288,7 +313,7 @@ mod tests {
     fn test_serialize_deserialize_footer() {
         let mut buffer = Vec::new();
         let crc32 = 123456u32;
-        let footer: Footer = Footer::new(VersionedFooter::V2 {
+        let footer: Footer = Footer::new(VersionedFooter::V3 {
             crc32,
             store_compression: "lz4".to_string(),
         });
@@ -300,7 +325,7 @@ mod tests {
     #[test]
     fn footer_length() {
         let crc32 = 1111111u32;
-        let versioned_footer = VersionedFooter::V2 {
+        let versioned_footer = VersionedFooter::V3 {
             crc32,
             store_compression: "lz4".to_string(),
         };
@@ -321,7 +346,7 @@ mod tests {
             // versionned footer length
             12 | 128,
             // index format version
-            2,
+            3,
             0,
             0,
             0,
@@ -340,7 +365,7 @@ mod tests {
         let versioned_footer = VersionedFooter::deserialize(&mut cursor).unwrap();
         assert!(cursor.is_empty());
         let expected_crc: u32 = LittleEndian::read_u32(&v_footer_bytes[5..9]) as CrcHashU32;
-        let expected_versioned_footer: VersionedFooter = VersionedFooter::V2 {
+        let expected_versioned_footer: VersionedFooter = VersionedFooter::V3 {
             crc32: expected_crc,
             store_compression: "lz4".to_string(),
         };

src/directory/mmap_directory.rs

@@ -163,8 +163,8 @@ impl MmapDirectoryInner {
         }
     }
 
-    fn watch(&self, callback: WatchCallback) -> crate::Result<WatchHandle> {
-        Ok(self.watcher.watch(callback))
+    fn watch(&self, callback: WatchCallback) -> WatchHandle {
+        self.watcher.watch(callback)
     }
 }
 
@@ -474,7 +474,7 @@ impl Directory for MmapDirectory {
     }
 
     fn watch(&self, watch_callback: WatchCallback) -> crate::Result<WatchHandle> {
-        self.inner.watch(watch_callback)
+        Ok(self.inner.watch(watch_callback))
     }
 }
 

src/directory/owned_bytes.rs

@@ -2,7 +2,7 @@ use crate::directory::FileHandle;
 use stable_deref_trait::StableDeref;
 use std::convert::TryInto;
 use std::mem;
-use std::ops::Deref;
+use std::ops::{Deref, Range};
 use std::sync::Arc;
 use std::{fmt, io};
 
@@ -17,8 +17,8 @@ pub struct OwnedBytes {
 }
 
 impl FileHandle for OwnedBytes {
-    fn read_bytes(&self, from: usize, to: usize) -> io::Result<OwnedBytes> {
-        Ok(self.slice(from, to))
+    fn read_bytes(&self, range: Range<usize>) -> io::Result<OwnedBytes> {
+        Ok(self.slice(range))
     }
 }
 
@@ -42,9 +42,9 @@ impl OwnedBytes {
     }
 
     /// creates a fileslice that is just a view over a slice of the data.
-    pub fn slice(&self, from: usize, to: usize) -> Self {
+    pub fn slice(&self, range: Range<usize>) -> Self {
         OwnedBytes {
-            data: &self.data[from..to],
+            data: &self.data[range],
             box_stable_deref: self.box_stable_deref.clone(),
         }
     }

src/directory/ram_directory.rs

@@ -226,13 +226,9 @@ impl Directory for RAMDirectory {
         )));
         let path_buf = PathBuf::from(path);
 
-        // Reserve the path to prevent calls to .write() to succeed.
-        self.fs.write().unwrap().write(path_buf.clone(), &[]);
+        self.fs.write().unwrap().write(path_buf, data);
 
-        let mut vec_writer = VecWriter::new(path_buf, self.clone());
-        vec_writer.write_all(data)?;
-        vec_writer.flush()?;
-        if path == Path::new(&*META_FILEPATH) {
+        if path == *META_FILEPATH {
             let _ = self.fs.write().unwrap().watch_router.broadcast();
         }
         Ok(())

src/fastfield/bytes/writer.rs

@@ -80,7 +80,7 @@ impl BytesFastFieldWriter {
         doc_index_serializer.close_field()?;
         // writing the values themselves
         serializer
-            .new_bytes_fast_field_with_idx(self.field, 1)?
+            .new_bytes_fast_field_with_idx(self.field, 1)
             .write_all(&self.vals)?;
         Ok(())
     }

src/fastfield/facet_reader.rs

@@ -1,4 +1,5 @@
-use super::MultiValueIntFastFieldReader;
+use super::MultiValuedFastFieldReader;
+use crate::error::DataCorruption;
 use crate::schema::Facet;
 use crate::termdict::TermDictionary;
 use crate::termdict::TermOrdinal;
@@ -19,7 +20,7 @@ use std::str;
 /// list of facets. This ordinal is segment local and
 /// only makes sense for a given segment.
 pub struct FacetReader {
-    term_ords: MultiValueIntFastFieldReader<u64>,
+    term_ords: MultiValuedFastFieldReader<u64>,
     term_dict: TermDictionary,
     buffer: Vec<u8>,
 }
@@ -28,12 +29,12 @@ impl FacetReader {
     /// Creates a new `FacetReader`.
     ///
     /// A facet reader just wraps :
-    /// - a `MultiValueIntFastFieldReader` that makes it possible to
+    /// - a `MultiValuedFastFieldReader` that makes it possible to
     /// access the list of facet ords for a given document.
     /// - a `TermDictionary` that helps associating a facet to
     /// an ordinal and vice versa.
     pub fn new(
-        term_ords: MultiValueIntFastFieldReader<u64>,
+        term_ords: MultiValuedFastFieldReader<u64>,
         term_dict: TermDictionary,
     ) -> FacetReader {
         FacetReader {
@@ -62,12 +63,13 @@ impl FacetReader {
         &mut self,
         facet_ord: TermOrdinal,
         output: &mut Facet,
-    ) -> Result<(), str::Utf8Error> {
+    ) -> crate::Result<()> {
         let found_term = self
             .term_dict
-            .ord_to_term(facet_ord as u64, &mut self.buffer);
+            .ord_to_term(facet_ord as u64, &mut self.buffer)?;
         assert!(found_term, "Term ordinal {} no found.", facet_ord);
-        let facet_str = str::from_utf8(&self.buffer[..])?;
+        let facet_str = str::from_utf8(&self.buffer[..])
+            .map_err(|utf8_err| DataCorruption::comment_only(utf8_err.to_string()))?;
         output.set_facet_str(facet_str);
         Ok(())
     }
@@ -82,14 +84,106 @@ impl FacetReader {
 mod tests {
     use crate::Index;
     use crate::{
-        schema::{Facet, SchemaBuilder},
-        Document,
+        schema::{Facet, FacetOptions, SchemaBuilder, Value, INDEXED, STORED},
+        DocAddress, Document,
     };
 
+    #[test]
+    fn test_facet_only_indexed() -> crate::Result<()> {
+        let mut schema_builder = SchemaBuilder::default();
+        let facet_field = schema_builder.add_facet_field("facet", INDEXED);
+        let schema = schema_builder.build();
+        let index = Index::create_in_ram(schema);
+        let mut index_writer = index.writer_for_tests()?;
+        index_writer.add_document(doc!(facet_field=>Facet::from_text("/a/b")));
+        index_writer.commit()?;
+        let searcher = index.reader()?.searcher();
+        let facet_reader = searcher
+            .segment_reader(0u32)
+            .facet_reader(facet_field)
+            .unwrap();
+        let mut facet_ords = Vec::new();
+        facet_reader.facet_ords(0u32, &mut facet_ords);
+        assert_eq!(&facet_ords, &[2u64]);
+        let doc = searcher.doc(DocAddress(0u32, 0u32))?;
+        let value = doc.get_first(facet_field).and_then(Value::path);
+        assert_eq!(value, None);
+        Ok(())
+    }
+
+    #[test]
+    fn test_facet_only_stored() -> crate::Result<()> {
+        let mut schema_builder = SchemaBuilder::default();
+        let facet_field = schema_builder.add_facet_field("facet", STORED);
+        let schema = schema_builder.build();
+        let index = Index::create_in_ram(schema);
+        let mut index_writer = index.writer_for_tests()?;
+        index_writer.add_document(doc!(facet_field=>Facet::from_text("/a/b")));
+        index_writer.commit()?;
+        let searcher = index.reader()?.searcher();
+        let facet_reader = searcher
+            .segment_reader(0u32)
+            .facet_reader(facet_field)
+            .unwrap();
+        let mut facet_ords = Vec::new();
+        facet_reader.facet_ords(0u32, &mut facet_ords);
+        assert!(facet_ords.is_empty());
+        let doc = searcher.doc(DocAddress(0u32, 0u32))?;
+        let value = doc.get_first(facet_field).and_then(Value::path);
+        assert_eq!(value, Some("/a/b".to_string()));
+        Ok(())
+    }
+
+    #[test]
+    fn test_facet_stored_and_indexed() -> crate::Result<()> {
+        let mut schema_builder = SchemaBuilder::default();
+        let facet_field = schema_builder.add_facet_field("facet", STORED | INDEXED);
+        let schema = schema_builder.build();
+        let index = Index::create_in_ram(schema);
+        let mut index_writer = index.writer_for_tests()?;
+        index_writer.add_document(doc!(facet_field=>Facet::from_text("/a/b")));
+        index_writer.commit()?;
+        let searcher = index.reader()?.searcher();
+        let facet_reader = searcher
+            .segment_reader(0u32)
+            .facet_reader(facet_field)
+            .unwrap();
+        let mut facet_ords = Vec::new();
+        facet_reader.facet_ords(0u32, &mut facet_ords);
+        assert_eq!(&facet_ords, &[2u64]);
+        let doc = searcher.doc(DocAddress(0u32, 0u32))?;
+        let value = doc.get_first(facet_field).and_then(Value::path);
+        assert_eq!(value, Some("/a/b".to_string()));
+        Ok(())
+    }
+
+    #[test]
+    fn test_facet_neither_stored_and_indexed() -> crate::Result<()> {
+        let mut schema_builder = SchemaBuilder::default();
+        let facet_field = schema_builder.add_facet_field("facet", FacetOptions::default());
+        let schema = schema_builder.build();
+        let index = Index::create_in_ram(schema);
+        let mut index_writer = index.writer_for_tests()?;
+        index_writer.add_document(doc!(facet_field=>Facet::from_text("/a/b")));
+        index_writer.commit()?;
+        let searcher = index.reader()?.searcher();
+        let facet_reader = searcher
+            .segment_reader(0u32)
+            .facet_reader(facet_field)
+            .unwrap();
+        let mut facet_ords = Vec::new();
+        facet_reader.facet_ords(0u32, &mut facet_ords);
+        assert!(facet_ords.is_empty());
+        let doc = searcher.doc(DocAddress(0u32, 0u32))?;
+        let value = doc.get_first(facet_field).and_then(Value::path);
+        assert_eq!(value, None);
+        Ok(())
+    }
+
     #[test]
     fn test_facet_not_populated_for_all_docs() -> crate::Result<()> {
         let mut schema_builder = SchemaBuilder::default();
-        let facet_field = schema_builder.add_facet_field("facet");
+        let facet_field = schema_builder.add_facet_field("facet", INDEXED);
         let schema = schema_builder.build();
         let index = Index::create_in_ram(schema);
         let mut index_writer = index.writer_for_tests()?;
@@ -108,10 +202,11 @@ mod tests {
         assert!(facet_ords.is_empty());
         Ok(())
     }
+
     #[test]
     fn test_facet_not_populated_for_any_docs() -> crate::Result<()> {
         let mut schema_builder = SchemaBuilder::default();
-        let facet_field = schema_builder.add_facet_field("facet");
+        let facet_field = schema_builder.add_facet_field("facet", INDEXED);
         let schema = schema_builder.build();
         let index = Index::create_in_ram(schema);
         let mut index_writer = index.writer_for_tests()?;

src/fastfield/mod.rs

@@ -28,7 +28,7 @@ pub use self::delete::write_delete_bitset;
 pub use self::delete::DeleteBitSet;
 pub use self::error::{FastFieldNotAvailableError, Result};
 pub use self::facet_reader::FacetReader;
-pub use self::multivalued::{MultiValueIntFastFieldReader, MultiValueIntFastFieldWriter};
+pub use self::multivalued::{MultiValuedFastFieldReader, MultiValuedFastFieldWriter};
 pub use self::reader::FastFieldReader;
 pub use self::readers::FastFieldReaders;
 pub use self::serializer::FastFieldSerializer;
@@ -53,7 +53,7 @@ mod serializer;
 mod writer;
 
 /// Trait for types that are allowed for fast fields: (u64, i64 and f64).
-pub trait FastValue: Clone + Copy + Send + Sync + PartialOrd {
+pub trait FastValue: Clone + Copy + Send + Sync + PartialOrd + 'static {
     /// Converts a value from u64
     ///
     /// Internally all fast field values are encoded as u64.
@@ -96,7 +96,7 @@ impl FastValue for u64 {
     fn fast_field_cardinality(field_type: &FieldType) -> Option<Cardinality> {
         match *field_type {
             FieldType::U64(ref integer_options) => integer_options.get_fastfield_cardinality(),
-            FieldType::HierarchicalFacet => Some(Cardinality::MultiValues),
+            FieldType::HierarchicalFacet(_) => Some(Cardinality::MultiValues),
             _ => None,
         }
     }

src/fastfield/multivalued/mod.rs

@@ -1,8 +1,8 @@
 mod reader;
 mod writer;
 
-pub use self::reader::MultiValueIntFastFieldReader;
-pub use self::writer::MultiValueIntFastFieldWriter;
+pub use self::reader::MultiValuedFastFieldReader;
+pub use self::writer::MultiValuedFastFieldWriter;
 
 #[cfg(test)]
 mod tests {
@@ -13,6 +13,7 @@ mod tests {
     use crate::schema::Facet;
     use crate::schema::IntOptions;
     use crate::schema::Schema;
+    use crate::schema::INDEXED;
     use crate::Index;
     use chrono::Duration;
 
@@ -212,7 +213,7 @@ mod tests {
     #[ignore]
     fn test_many_facets() {
         let mut schema_builder = Schema::builder();
-        let field = schema_builder.add_facet_field("facetfield");
+        let field = schema_builder.add_facet_field("facetfield", INDEXED);
         let schema = schema_builder.build();
         let index = Index::create_in_ram(schema);
         let mut index_writer = index.writer_for_tests().unwrap();

src/fastfield/multivalued/reader.rs

@@ -1,3 +1,5 @@
+use std::ops::Range;
+
 use crate::fastfield::{FastFieldReader, FastValue};
 use crate::DocId;
 
@@ -10,49 +12,42 @@ use crate::DocId;
 /// The `idx_reader` associated, for each document, the index of its first value.
 ///
 #[derive(Clone)]
-pub struct MultiValueIntFastFieldReader<Item: FastValue> {
+pub struct MultiValuedFastFieldReader<Item: FastValue> {
     idx_reader: FastFieldReader<u64>,
     vals_reader: FastFieldReader<Item>,
 }
 
-impl<Item: FastValue> MultiValueIntFastFieldReader<Item> {
+impl<Item: FastValue> MultiValuedFastFieldReader<Item> {
     pub(crate) fn open(
         idx_reader: FastFieldReader<u64>,
         vals_reader: FastFieldReader<Item>,
-    ) -> MultiValueIntFastFieldReader<Item> {
-        MultiValueIntFastFieldReader {
+    ) -> MultiValuedFastFieldReader<Item> {
+        MultiValuedFastFieldReader {
             idx_reader,
             vals_reader,
         }
     }
 
-    pub(crate) fn into_u64s_reader(self) -> MultiValueIntFastFieldReader<u64> {
-        MultiValueIntFastFieldReader {
-            idx_reader: self.idx_reader,
-            vals_reader: self.vals_reader.into_u64_reader(),
-        }
-    }
-
     /// Returns `(start, stop)`, such that the values associated
     /// to the given document are `start..stop`.
-    fn range(&self, doc: DocId) -> (u64, u64) {
+    fn range(&self, doc: DocId) -> Range<u64> {
         let start = self.idx_reader.get(doc);
         let stop = self.idx_reader.get(doc + 1);
-        (start, stop)
+        start..stop
     }
 
     /// Returns the array of values associated to the given `doc`.
     pub fn get_vals(&self, doc: DocId, vals: &mut Vec<Item>) {
-        let (start, stop) = self.range(doc);
-        let len = (stop - start) as usize;
+        let range = self.range(doc);
+        let len = (range.end - range.start) as usize;
         vals.resize(len, Item::make_zero());
-        self.vals_reader.get_range_u64(start, &mut vals[..]);
+        self.vals_reader.get_range_u64(range.start, &mut vals[..]);
     }
 
     /// Returns the number of values associated with the document `DocId`.
     pub fn num_vals(&self, doc: DocId) -> usize {
-        let (start, stop) = self.range(doc);
-        (stop - start) as usize
+        let range = self.range(doc);
+        (range.end - range.start) as usize
     }
 
     /// Returns the overall number of values in this field  .
@@ -65,12 +60,12 @@ impl<Item: FastValue> MultiValueIntFastFieldReader<Item> {
 mod tests {
 
     use crate::core::Index;
-    use crate::schema::{Facet, Schema};
+    use crate::schema::{Facet, Schema, INDEXED};
 
     #[test]
     fn test_multifastfield_reader() {
         let mut schema_builder = Schema::builder();
-        let facet_field = schema_builder.add_facet_field("facets");
+        let facet_field = schema_builder.add_facet_field("facets", INDEXED);
         let schema = schema_builder.build();
         let index = Index::create_in_ram(schema);
         let mut index_writer = index

src/fastfield/multivalued/writer.rs

@@ -7,6 +7,7 @@ use crate::termdict::TermOrdinal;
 use crate::DocId;
 use fnv::FnvHashMap;
 use std::io;
+use std::iter::once;
 
 /// Writer for multi-valued (as in, more than one value per document)
 /// int fast field.
@@ -18,7 +19,7 @@ use std::io;
 /// in your schema
 /// - add your document simply by calling `.add_document(...)`.
 ///
-/// The `MultiValueIntFastFieldWriter` can be acquired from the
+/// The `MultiValuedFastFieldWriter` can be acquired from the
 /// fastfield writer, by calling [`.get_multivalue_writer(...)`](./struct.FastFieldsWriter.html#method.get_multivalue_writer).
 ///
 /// Once acquired, writing is done by calling calls to
@@ -29,17 +30,17 @@ use std::io;
 /// This makes it possible to push unordered term ids,
 /// during indexing and remap them to their respective
 /// term ids when the segment is getting serialized.
-pub struct MultiValueIntFastFieldWriter {
+pub struct MultiValuedFastFieldWriter {
     field: Field,
     vals: Vec<UnorderedTermId>,
     doc_index: Vec<u64>,
     is_facet: bool,
 }
 
-impl MultiValueIntFastFieldWriter {
+impl MultiValuedFastFieldWriter {
     /// Creates a new `IntFastFieldWriter`
     pub(crate) fn new(field: Field, is_facet: bool) -> Self {
-        MultiValueIntFastFieldWriter {
+        MultiValuedFastFieldWriter {
             field,
             vals: Vec::new(),
             doc_index: Vec::new(),
@@ -47,7 +48,7 @@ impl MultiValueIntFastFieldWriter {
         }
     }
 
-    /// Access the field associated to the `MultiValueIntFastFieldWriter`
+    /// Access the field associated to the `MultiValuedFastFieldWriter`
     pub fn field(&self) -> Field {
         self.field
     }
@@ -125,21 +126,18 @@ impl MultiValueIntFastFieldWriter {
                         1,
                     )?;
 
-                    let last_interval = (
-                        self.doc_index.last().cloned().unwrap(),
-                        self.vals.len() as u64,
-                    );
+                    let last_interval =
+                        self.doc_index.last().cloned().unwrap() as usize..self.vals.len();
 
                     let mut doc_vals: Vec<u64> = Vec::with_capacity(100);
-                    for (start, stop) in self
+                    for range in self
                         .doc_index
                         .windows(2)
-                        .map(|interval| (interval[0], interval[1]))
-                        .chain(Some(last_interval).into_iter())
-                        .map(|(start, stop)| (start as usize, stop as usize))
+                        .map(|interval| interval[0] as usize..interval[1] as usize)
+                        .chain(once(last_interval))
                     {
                         doc_vals.clear();
-                        let remapped_vals = self.vals[start..stop]
+                        let remapped_vals = self.vals[range]
                             .iter()
                             .map(|val| *mapping.get(val).expect("Missing term ordinal"));
                         doc_vals.extend(remapped_vals);

src/fastfield/reader.rs

@@ -42,15 +42,6 @@ impl<Item: FastValue> FastFieldReader<Item> {
         })
     }
 
-    pub(crate) fn into_u64_reader(self) -> FastFieldReader<u64> {
-        FastFieldReader {
-            bit_unpacker: self.bit_unpacker,
-            min_value_u64: self.min_value_u64,
-            max_value_u64: self.max_value_u64,
-            _phantom: PhantomData,
-        }
-    }
-
     /// Return the value associated to the given document.
     ///
     /// This accessor should return as fast as possible.

src/fastfield/readers.rs

@@ -1,28 +1,22 @@
 use crate::common::CompositeFile;
-use crate::fastfield::BytesFastFieldReader;
-use crate::fastfield::MultiValueIntFastFieldReader;
+use crate::directory::FileSlice;
+use crate::fastfield::MultiValuedFastFieldReader;
+use crate::fastfield::{BytesFastFieldReader, FastValue};
 use crate::fastfield::{FastFieldNotAvailableError, FastFieldReader};
 use crate::schema::{Cardinality, Field, FieldType, Schema};
 use crate::space_usage::PerFieldSpaceUsage;
-use std::collections::HashMap;
+use crate::TantivyError;
 
 /// Provides access to all of the FastFieldReader.
 ///
 /// Internally, `FastFieldReaders` have preloaded fast field readers,
 /// and just wraps several `HashMap`.
+#[derive(Clone)]
 pub struct FastFieldReaders {
-    fast_field_i64: HashMap<Field, FastFieldReader<i64>>,
-    fast_field_u64: HashMap<Field, FastFieldReader<u64>>,
-    fast_field_f64: HashMap<Field, FastFieldReader<f64>>,
-    fast_field_date: HashMap<Field, FastFieldReader<crate::DateTime>>,
-    fast_field_i64s: HashMap<Field, MultiValueIntFastFieldReader<i64>>,
-    fast_field_u64s: HashMap<Field, MultiValueIntFastFieldReader<u64>>,
-    fast_field_f64s: HashMap<Field, MultiValueIntFastFieldReader<f64>>,
-    fast_field_dates: HashMap<Field, MultiValueIntFastFieldReader<crate::DateTime>>,
-    fast_bytes: HashMap<Field, BytesFastFieldReader>,
+    schema: Schema,
     fast_fields_composite: CompositeFile,
 }
-
+#[derive(Eq, PartialEq, Debug)]
 enum FastType {
     I64,
     U64,
@@ -44,234 +38,178 @@ fn type_and_cardinality(field_type: &FieldType) -> Option<(FastType, Cardinality
         FieldType::Date(options) => options
             .get_fastfield_cardinality()
             .map(|cardinality| (FastType::Date, cardinality)),
-        FieldType::HierarchicalFacet => Some((FastType::U64, Cardinality::MultiValues)),
+        FieldType::HierarchicalFacet(_) => Some((FastType::U64, Cardinality::MultiValues)),
         _ => None,
     }
 }
 
 impl FastFieldReaders {
-    pub(crate) fn load_all(
-        schema: &Schema,
-        fast_fields_composite: &CompositeFile,
-    ) -> crate::Result<FastFieldReaders> {
-        let mut fast_field_readers = FastFieldReaders {
-            fast_field_i64: Default::default(),
-            fast_field_u64: Default::default(),
-            fast_field_f64: Default::default(),
-            fast_field_date: Default::default(),
-            fast_field_i64s: Default::default(),
-            fast_field_u64s: Default::default(),
-            fast_field_f64s: Default::default(),
-            fast_field_dates: Default::default(),
-            fast_bytes: Default::default(),
-            fast_fields_composite: fast_fields_composite.clone(),
-        };
-        for (field, field_entry) in schema.fields() {
-            let field_type = field_entry.field_type();
-            if let FieldType::Bytes(bytes_option) = field_type {
-                if !bytes_option.is_fast() {
-                    continue;
-                }
-                let fast_field_idx_file = fast_fields_composite
-                    .open_read_with_idx(field, 0)
-                    .ok_or_else(|| FastFieldNotAvailableError::new(field_entry))?;
-                let idx_reader = FastFieldReader::open(fast_field_idx_file)?;
-                let data = fast_fields_composite
-                    .open_read_with_idx(field, 1)
-                    .ok_or_else(|| FastFieldNotAvailableError::new(field_entry))?;
-                let bytes_fast_field_reader = BytesFastFieldReader::open(idx_reader, data)?;
-                fast_field_readers
-                    .fast_bytes
-                    .insert(field, bytes_fast_field_reader);
-            } else if let Some((fast_type, cardinality)) = type_and_cardinality(field_type) {
-                match cardinality {
-                    Cardinality::SingleValue => {
-                        if let Some(fast_field_data) = fast_fields_composite.open_read(field) {
-                            match fast_type {
-                                FastType::U64 => {
-                                    let fast_field_reader = FastFieldReader::open(fast_field_data)?;
-                                    fast_field_readers
-                                        .fast_field_u64
-                                        .insert(field, fast_field_reader);
-                                }
-                                FastType::I64 => {
-                                    let fast_field_reader =
-                                        FastFieldReader::open(fast_field_data.clone())?;
-                                    fast_field_readers
-                                        .fast_field_i64
-                                        .insert(field, fast_field_reader);
-                                }
-                                FastType::F64 => {
-                                    let fast_field_reader =
-                                        FastFieldReader::open(fast_field_data.clone())?;
-                                    fast_field_readers
-                                        .fast_field_f64
-                                        .insert(field, fast_field_reader);
-                                }
-                                FastType::Date => {
-                                    let fast_field_reader =
-                                        FastFieldReader::open(fast_field_data.clone())?;
-                                    fast_field_readers
-                                        .fast_field_date
-                                        .insert(field, fast_field_reader);
-                                }
-                            }
-                        } else {
-                            return Err(From::from(FastFieldNotAvailableError::new(field_entry)));
-                        }
-                    }
-                    Cardinality::MultiValues => {
-                        let idx_opt = fast_fields_composite.open_read_with_idx(field, 0);
-                        let data_opt = fast_fields_composite.open_read_with_idx(field, 1);
-                        if let (Some(fast_field_idx), Some(fast_field_data)) = (idx_opt, data_opt) {
-                            let idx_reader = FastFieldReader::open(fast_field_idx)?;
-                            match fast_type {
-                                FastType::I64 => {
-                                    let vals_reader = FastFieldReader::open(fast_field_data)?;
-                                    let multivalued_int_fast_field =
-                                        MultiValueIntFastFieldReader::open(idx_reader, vals_reader);
-                                    fast_field_readers
-                                        .fast_field_i64s
-                                        .insert(field, multivalued_int_fast_field);
-                                }
-                                FastType::U64 => {
-                                    let vals_reader = FastFieldReader::open(fast_field_data)?;
-                                    let multivalued_int_fast_field =
-                                        MultiValueIntFastFieldReader::open(idx_reader, vals_reader);
-                                    fast_field_readers
-                                        .fast_field_u64s
-                                        .insert(field, multivalued_int_fast_field);
-                                }
-                                FastType::F64 => {
-                                    let vals_reader = FastFieldReader::open(fast_field_data)?;
-                                    let multivalued_int_fast_field =
-                                        MultiValueIntFastFieldReader::open(idx_reader, vals_reader);
-                                    fast_field_readers
-                                        .fast_field_f64s
-                                        .insert(field, multivalued_int_fast_field);
-                                }
-                                FastType::Date => {
-                                    let vals_reader = FastFieldReader::open(fast_field_data)?;
-                                    let multivalued_int_fast_field =
-                                        MultiValueIntFastFieldReader::open(idx_reader, vals_reader);
-                                    fast_field_readers
-                                        .fast_field_dates
-                                        .insert(field, multivalued_int_fast_field);
-                                }
-                            }
-                        } else {
-                            return Err(From::from(FastFieldNotAvailableError::new(field_entry)));
-                        }
-                    }
-                }
-            }
+    pub(crate) fn new(schema: Schema, fast_fields_composite: CompositeFile) -> FastFieldReaders {
+        FastFieldReaders {
+            fast_fields_composite,
+            schema,
         }
-        Ok(fast_field_readers)
     }
 
     pub(crate) fn space_usage(&self) -> PerFieldSpaceUsage {
         self.fast_fields_composite.space_usage()
     }
 
+    fn fast_field_data(&self, field: Field, idx: usize) -> crate::Result<FileSlice> {
+        self.fast_fields_composite
+            .open_read_with_idx(field, idx)
+            .ok_or_else(|| {
+                let field_name = self.schema.get_field_entry(field).name();
+                TantivyError::SchemaError(format!("Field({}) data was not found", field_name))
+            })
+    }
+
+    fn check_type(
+        &self,
+        field: Field,
+        expected_fast_type: FastType,
+        expected_cardinality: Cardinality,
+    ) -> crate::Result<()> {
+        let field_entry = self.schema.get_field_entry(field);
+        let (fast_type, cardinality) =
+            type_and_cardinality(field_entry.field_type()).ok_or_else(|| {
+                crate::TantivyError::SchemaError(format!(
+                    "Field {:?} is not a fast field.",
+                    field_entry.name()
+                ))
+            })?;
+        if fast_type != expected_fast_type {
+            return Err(crate::TantivyError::SchemaError(format!(
+                "Field {:?} is of type {:?}, expected {:?}.",
+                field_entry.name(),
+                fast_type,
+                expected_fast_type
+            )));
+        }
+        if cardinality != expected_cardinality {
+            return Err(crate::TantivyError::SchemaError(format!(
+                "Field {:?} is of cardinality {:?}, expected {:?}.",
+                field_entry.name(),
+                cardinality,
+                expected_cardinality
+            )));
+        }
+        Ok(())
+    }
+
+    pub(crate) fn typed_fast_field_reader<TFastValue: FastValue>(
+        &self,
+        field: Field,
+    ) -> crate::Result<FastFieldReader<TFastValue>> {
+        let fast_field_slice = self.fast_field_data(field, 0)?;
+        FastFieldReader::open(fast_field_slice)
+    }
+
+    pub(crate) fn typed_fast_field_multi_reader<TFastValue: FastValue>(
+        &self,
+        field: Field,
+    ) -> crate::Result<MultiValuedFastFieldReader<TFastValue>> {
+        let fast_field_slice_idx = self.fast_field_data(field, 0)?;
+        let fast_field_slice_vals = self.fast_field_data(field, 1)?;
+        let idx_reader = FastFieldReader::open(fast_field_slice_idx)?;
+        let vals_reader: FastFieldReader<TFastValue> =
+            FastFieldReader::open(fast_field_slice_vals)?;
+        Ok(MultiValuedFastFieldReader::open(idx_reader, vals_reader))
+    }
+
     /// Returns the `u64` fast field reader reader associated to `field`.
     ///
     /// If `field` is not a u64 fast field, this method returns `None`.
-    pub fn u64(&self, field: Field) -> Option<FastFieldReader<u64>> {
-        self.fast_field_u64.get(&field).cloned()
+    pub fn u64(&self, field: Field) -> crate::Result<FastFieldReader<u64>> {
+        self.check_type(field, FastType::U64, Cardinality::SingleValue)?;
+        self.typed_fast_field_reader(field)
     }
 
-    /// If the field is a u64-fast field return the associated reader.
-    /// If the field is a i64-fast field, return the associated u64 reader. Values are
-    /// mapped from i64 to u64 using a (well the, it is unique) monotonic mapping.    ///
+    /// Returns the `u64` fast field reader reader associated to `field`, regardless of whether the given
+    /// field is effectively of type `u64` or not.
     ///
-    /// This method is useful when merging segment reader.
-    pub(crate) fn u64_lenient(&self, field: Field) -> Option<FastFieldReader<u64>> {
-        if let Some(u64_ff_reader) = self.u64(field) {
-            return Some(u64_ff_reader);
-        }
-        if let Some(i64_ff_reader) = self.i64(field) {
-            return Some(i64_ff_reader.into_u64_reader());
-        }
-        if let Some(f64_ff_reader) = self.f64(field) {
-            return Some(f64_ff_reader.into_u64_reader());
-        }
-        if let Some(date_ff_reader) = self.date(field) {
-            return Some(date_ff_reader.into_u64_reader());
-        }
-        None
+    /// If not, the fastfield reader will returns the u64-value associated to the original FastValue.
+    pub fn u64_lenient(&self, field: Field) -> crate::Result<FastFieldReader<u64>> {
+        self.typed_fast_field_reader(field)
     }
 
     /// Returns the `i64` fast field reader reader associated to `field`.
     ///
     /// If `field` is not a i64 fast field, this method returns `None`.
-    pub fn i64(&self, field: Field) -> Option<FastFieldReader<i64>> {
-        self.fast_field_i64.get(&field).cloned()
+    pub fn i64(&self, field: Field) -> crate::Result<FastFieldReader<i64>> {
+        self.check_type(field, FastType::I64, Cardinality::SingleValue)?;
+        self.typed_fast_field_reader(field)
     }
 
     /// Returns the `i64` fast field reader reader associated to `field`.
     ///
     /// If `field` is not a i64 fast field, this method returns `None`.
-    pub fn date(&self, field: Field) -> Option<FastFieldReader<crate::DateTime>> {
-        self.fast_field_date.get(&field).cloned()
+    pub fn date(&self, field: Field) -> crate::Result<FastFieldReader<crate::DateTime>> {
+        self.check_type(field, FastType::Date, Cardinality::SingleValue)?;
+        self.typed_fast_field_reader(field)
     }
 
     /// Returns the `f64` fast field reader reader associated to `field`.
     ///
     /// If `field` is not a f64 fast field, this method returns `None`.
-    pub fn f64(&self, field: Field) -> Option<FastFieldReader<f64>> {
-        self.fast_field_f64.get(&field).cloned()
+    pub fn f64(&self, field: Field) -> crate::Result<FastFieldReader<f64>> {
+        self.check_type(field, FastType::F64, Cardinality::SingleValue)?;
+        self.typed_fast_field_reader(field)
     }
 
     /// Returns a `u64s` multi-valued fast field reader reader associated to `field`.
     ///
     /// If `field` is not a u64 multi-valued fast field, this method returns `None`.
-    pub fn u64s(&self, field: Field) -> Option<MultiValueIntFastFieldReader<u64>> {
-        self.fast_field_u64s.get(&field).cloned()
-    }
-
-    /// If the field is a u64s-fast field return the associated reader.
-    /// If the field is a i64s-fast field, return the associated u64s reader. Values are
-    /// mapped from i64 to u64 using a (well the, it is unique) monotonic mapping.
-    ///
-    /// This method is useful when merging segment reader.
-    pub(crate) fn u64s_lenient(&self, field: Field) -> Option<MultiValueIntFastFieldReader<u64>> {
-        if let Some(u64s_ff_reader) = self.u64s(field) {
-            return Some(u64s_ff_reader);
-        }
-        if let Some(i64s_ff_reader) = self.i64s(field) {
-            return Some(i64s_ff_reader.into_u64s_reader());
-        }
-        if let Some(f64s_ff_reader) = self.f64s(field) {
-            return Some(f64s_ff_reader.into_u64s_reader());
-        }
-        None
+    pub fn u64s(&self, field: Field) -> crate::Result<MultiValuedFastFieldReader<u64>> {
+        self.check_type(field, FastType::U64, Cardinality::MultiValues)?;
+        self.typed_fast_field_multi_reader(field)
     }
 
     /// Returns a `i64s` multi-valued fast field reader reader associated to `field`.
     ///
     /// If `field` is not a i64 multi-valued fast field, this method returns `None`.
-    pub fn i64s(&self, field: Field) -> Option<MultiValueIntFastFieldReader<i64>> {
-        self.fast_field_i64s.get(&field).cloned()
+    pub fn i64s(&self, field: Field) -> crate::Result<MultiValuedFastFieldReader<i64>> {
+        self.check_type(field, FastType::I64, Cardinality::MultiValues)?;
+        self.typed_fast_field_multi_reader(field)
     }
 
     /// Returns a `f64s` multi-valued fast field reader reader associated to `field`.
     ///
     /// If `field` is not a f64 multi-valued fast field, this method returns `None`.
-    pub fn f64s(&self, field: Field) -> Option<MultiValueIntFastFieldReader<f64>> {
-        self.fast_field_f64s.get(&field).cloned()
+    pub fn f64s(&self, field: Field) -> crate::Result<MultiValuedFastFieldReader<f64>> {
+        self.check_type(field, FastType::F64, Cardinality::MultiValues)?;
+        self.typed_fast_field_multi_reader(field)
     }
 
     /// Returns a `crate::DateTime` multi-valued fast field reader reader associated to `field`.
     ///
     /// If `field` is not a `crate::DateTime` multi-valued fast field, this method returns `None`.
-    pub fn dates(&self, field: Field) -> Option<MultiValueIntFastFieldReader<crate::DateTime>> {
-        self.fast_field_dates.get(&field).cloned()
+    pub fn dates(
+        &self,
+        field: Field,
+    ) -> crate::Result<MultiValuedFastFieldReader<crate::DateTime>> {
+        self.check_type(field, FastType::Date, Cardinality::MultiValues)?;
+        self.typed_fast_field_multi_reader(field)
     }
 
     /// Returns the `bytes` fast field reader associated to `field`.
     ///
     /// If `field` is not a bytes fast field, returns `None`.
-    pub fn bytes(&self, field: Field) -> Option<BytesFastFieldReader> {
-        self.fast_bytes.get(&field).cloned()
+    pub fn bytes(&self, field: Field) -> crate::Result<BytesFastFieldReader> {
+        let field_entry = self.schema.get_field_entry(field);
+        if let FieldType::Bytes(bytes_option) = field_entry.field_type() {
+            if !bytes_option.is_fast() {
+                return Err(crate::TantivyError::SchemaError(format!(
+                    "Field {:?} is not a fast field.",
+                    field_entry.name()
+                )));
+            }
+            let fast_field_idx_file = self.fast_field_data(field, 0)?;
+            let idx_reader = FastFieldReader::open(fast_field_idx_file)?;
+            let data = self.fast_field_data(field, 1)?;
+            BytesFastFieldReader::open(idx_reader, data)
+        } else {
+            Err(FastFieldNotAvailableError::new(field_entry).into())
+        }
     }
 }

src/fastfield/serializer.rs

@@ -66,9 +66,9 @@ impl FastFieldSerializer {
         &mut self,
         field: Field,
         idx: usize,
-    ) -> io::Result<FastBytesFieldSerializer<'_, CountingWriter<WritePtr>>> {
+    ) -> FastBytesFieldSerializer<'_, CountingWriter<WritePtr>> {
         let field_write = self.composite_write.for_field_with_idx(field, idx);
-        FastBytesFieldSerializer::open(field_write)
+        FastBytesFieldSerializer { write: field_write }
     }
 
     /// Closes the serializer
@@ -132,10 +132,6 @@ pub struct FastBytesFieldSerializer<'a, W: Write> {
 }
 
 impl<'a, W: Write> FastBytesFieldSerializer<'a, W> {
-    fn open(write: &'a mut W) -> io::Result<FastBytesFieldSerializer<'a, W>> {
-        Ok(FastBytesFieldSerializer { write })
-    }
-
     pub fn write_all(&mut self, vals: &[u8]) -> io::Result<()> {
         self.write.write_all(vals)
     }

src/fastfield/writer.rs

@@ -1,4 +1,4 @@
-use super::multivalued::MultiValueIntFastFieldWriter;
+use super::multivalued::MultiValuedFastFieldWriter;
 use crate::common;
 use crate::common::BinarySerializable;
 use crate::common::VInt;
@@ -13,7 +13,7 @@ use std::io;
 /// The fastfieldswriter regroup all of the fast field writers.
 pub struct FastFieldsWriter {
     single_value_writers: Vec<IntFastFieldWriter>,
-    multi_values_writers: Vec<MultiValueIntFastFieldWriter>,
+    multi_values_writers: Vec<MultiValuedFastFieldWriter>,
     bytes_value_writers: Vec<BytesFastFieldWriter>,
 }
 
@@ -46,14 +46,14 @@ impl FastFieldsWriter {
                             single_value_writers.push(fast_field_writer);
                         }
                         Some(Cardinality::MultiValues) => {
-                            let fast_field_writer = MultiValueIntFastFieldWriter::new(field, false);
+                            let fast_field_writer = MultiValuedFastFieldWriter::new(field, false);
                             multi_values_writers.push(fast_field_writer);
                         }
                         None => {}
                     }
                 }
-                FieldType::HierarchicalFacet => {
-                    let fast_field_writer = MultiValueIntFastFieldWriter::new(field, true);
+                FieldType::HierarchicalFacet(_) => {
+                    let fast_field_writer = MultiValuedFastFieldWriter::new(field, true);
                     multi_values_writers.push(fast_field_writer);
                 }
                 FieldType::Bytes(bytes_option) => {
@@ -87,7 +87,7 @@ impl FastFieldsWriter {
     pub fn get_multivalue_writer(
         &mut self,
         field: Field,
-    ) -> Option<&mut MultiValueIntFastFieldWriter> {
+    ) -> Option<&mut MultiValuedFastFieldWriter> {
         // TODO optimize
         self.multi_values_writers
             .iter_mut()

src/functional_test.rs

@@ -1,45 +1,93 @@
-use rand::thread_rng;
-use std::collections::HashSet;
-
-use crate::schema::*;
 use crate::Index;
 use crate::Searcher;
+use crate::{doc, schema::*};
+use rand::thread_rng;
 use rand::Rng;
+use std::collections::HashSet;
 
-fn check_index_content(searcher: &Searcher, vals: &HashSet<u64>) {
+fn check_index_content(searcher: &Searcher, vals: &[u64]) -> crate::Result<()> {
     assert!(searcher.segment_readers().len() < 20);
     assert_eq!(searcher.num_docs() as usize, vals.len());
+    for segment_reader in searcher.segment_readers() {
+        let store_reader = segment_reader.get_store_reader()?;
+        for doc_id in 0..segment_reader.max_doc() {
+            let _doc = store_reader.get(doc_id)?;
+        }
+    }
+    Ok(())
 }
 
 #[test]
 #[ignore]
-fn test_indexing() {
+fn test_functional_store() -> crate::Result<()> {
+    let mut schema_builder = Schema::builder();
+
+    let id_field = schema_builder.add_u64_field("id", INDEXED | STORED);
+    let schema = schema_builder.build();
+
+    let index = Index::create_in_ram(schema);
+    let reader = index.reader()?;
+
+    let mut rng = thread_rng();
+
+    let mut index_writer = index.writer_with_num_threads(3, 12_000_000)?;
+
+    let mut doc_set: Vec<u64> = Vec::new();
+
+    let mut doc_id = 0u64;
+    for iteration in 0..500 {
+        dbg!(iteration);
+        let num_docs: usize = rng.gen_range(0..4);
+        if doc_set.len() >= 1 {
+            let doc_to_remove_id = rng.gen_range(0..doc_set.len());
+            let removed_doc_id = doc_set.swap_remove(doc_to_remove_id);
+            index_writer.delete_term(Term::from_field_u64(id_field, removed_doc_id));
+        }
+        for _ in 0..num_docs {
+            doc_set.push(doc_id);
+            index_writer.add_document(doc!(id_field=>doc_id));
+            doc_id += 1;
+        }
+        index_writer.commit()?;
+        reader.reload()?;
+        let searcher = reader.searcher();
+        check_index_content(&searcher, &doc_set)?;
+    }
+    Ok(())
+}
+
+#[test]
+#[ignore]
+fn test_functional_indexing() -> crate::Result<()> {
     let mut schema_builder = Schema::builder();
 
     let id_field = schema_builder.add_u64_field("id", INDEXED);
     let multiples_field = schema_builder.add_u64_field("multiples", INDEXED);
     let schema = schema_builder.build();
 
-    let index = Index::create_from_tempdir(schema).unwrap();
-    let reader = index.reader().unwrap();
+    let index = Index::create_from_tempdir(schema)?;
+    let reader = index.reader()?;
 
     let mut rng = thread_rng();
 
-    let mut index_writer = index.writer_with_num_threads(3, 120_000_000).unwrap();
+    let mut index_writer = index.writer_with_num_threads(3, 120_000_000)?;
 
     let mut committed_docs: HashSet<u64> = HashSet::new();
     let mut uncommitted_docs: HashSet<u64> = HashSet::new();
 
     for _ in 0..200 {
-        let random_val = rng.gen_range(0, 20);
+        let random_val = rng.gen_range(0..20);
         if random_val == 0 {
-            index_writer.commit().expect("Commit failed");
+            index_writer.commit()?;
             committed_docs.extend(&uncommitted_docs);
             uncommitted_docs.clear();
-            reader.reload().unwrap();
+            reader.reload()?;
             let searcher = reader.searcher();
             // check that everything is correct.
-            check_index_content(&searcher, &committed_docs);
+            check_index_content(
+                &searcher,
+                &committed_docs.iter().cloned().collect::<Vec<u64>>(),
+            )?;
         } else {
             if committed_docs.remove(&random_val) || uncommitted_docs.remove(&random_val) {
                 let doc_id_term = Term::from_field_u64(id_field, random_val);
@@ -55,4 +103,5 @@ fn test_indexing() {
             }
         }
     }
+    Ok(())
 }

src/indexer/log_merge_policy.rs

@@ -8,7 +8,7 @@ const DEFAULT_MIN_LAYER_SIZE: u32 = 10_000;
 const DEFAULT_MIN_MERGE_SIZE: usize = 8;
 const DEFAULT_MAX_MERGE_SIZE: usize = 10_000_000;
 
-/// `LogMergePolicy` tries tries to merge segments that have a similar number of
+/// `LogMergePolicy` tries to merge segments that have a similar number of
 /// documents.
 #[derive(Debug, Clone)]
 pub struct LogMergePolicy {

src/indexer/merger.rs

@@ -7,7 +7,7 @@ use crate::fastfield::BytesFastFieldReader;
 use crate::fastfield::DeleteBitSet;
 use crate::fastfield::FastFieldReader;
 use crate::fastfield::FastFieldSerializer;
-use crate::fastfield::MultiValueIntFastFieldReader;
+use crate::fastfield::MultiValuedFastFieldReader;
 use crate::fieldnorm::FieldNormsSerializer;
 use crate::fieldnorm::FieldNormsWriter;
 use crate::fieldnorm::{FieldNormReader, FieldNormReaders};
@@ -195,7 +195,7 @@ impl IndexMerger {
         for (field, field_entry) in self.schema.fields() {
             let field_type = field_entry.field_type();
             match field_type {
-                FieldType::HierarchicalFacet => {
+                FieldType::HierarchicalFacet(_) => {
                     let term_ordinal_mapping = term_ord_mappings
                         .remove(&field)
                         .expect("Logic Error in Tantivy (Please report). HierarchicalFact field should have required a\
@@ -246,7 +246,7 @@ impl IndexMerger {
         for reader in &self.readers {
             let u64_reader: FastFieldReader<u64> = reader
                 .fast_fields()
-                .u64_lenient(field)
+                .typed_fast_field_reader(field)
                 .expect("Failed to find a reader for single fast field. This is a tantivy bug and it should never happen.");
             if let Some((seg_min_val, seg_max_val)) =
                 compute_min_max_val(&u64_reader, reader.max_doc(), reader.delete_bitset())
@@ -290,7 +290,7 @@ impl IndexMerger {
         fast_field_serializer: &mut FastFieldSerializer,
     ) -> crate::Result<()> {
         let mut total_num_vals = 0u64;
-        let mut u64s_readers: Vec<MultiValueIntFastFieldReader<u64>> = Vec::new();
+        let mut u64s_readers: Vec<MultiValuedFastFieldReader<u64>> = Vec::new();
 
         // In the first pass, we compute the total number of vals.
         //
@@ -298,9 +298,8 @@ impl IndexMerger {
         // what should be the bit length use for bitpacking.
         for reader in &self.readers {
             let u64s_reader = reader.fast_fields()
-                .u64s_lenient(field)
+                .typed_fast_field_multi_reader(field)
                 .expect("Failed to find index for multivalued field. This is a bug in tantivy, please report.");
-
             if let Some(delete_bitset) = reader.delete_bitset() {
                 for doc in 0u32..reader.max_doc() {
                     if delete_bitset.is_alive(doc) {
@@ -353,7 +352,7 @@ impl IndexMerger {
             for (segment_ord, segment_reader) in self.readers.iter().enumerate() {
                 let term_ordinal_mapping: &[TermOrdinal] =
                     term_ordinal_mappings.get_segment(segment_ord);
-                let ff_reader: MultiValueIntFastFieldReader<u64> = segment_reader
+                let ff_reader: MultiValuedFastFieldReader<u64> = segment_reader
                     .fast_fields()
                     .u64s(field)
                     .expect("Could not find multivalued u64 fast value reader.");
@@ -397,8 +396,10 @@ impl IndexMerger {
         // We go through a complete first pass to compute the minimum and the
         // maximum value and initialize our Serializer.
         for reader in &self.readers {
-            let ff_reader: MultiValueIntFastFieldReader<u64> =
-                reader.fast_fields().u64s_lenient(field).expect(
+            let ff_reader: MultiValuedFastFieldReader<u64> = reader
+                .fast_fields()
+                .typed_fast_field_multi_reader(field)
+                .expect(
                     "Failed to find multivalued fast field reader. This is a bug in \
                      tantivy. Please report.",
                 );
@@ -445,11 +446,7 @@ impl IndexMerger {
         let mut bytes_readers: Vec<BytesFastFieldReader> = Vec::new();
 
         for reader in &self.readers {
-            let bytes_reader = reader.fast_fields().bytes(field).ok_or_else(|| {
-                crate::TantivyError::InvalidArgument(
-                    "Bytes fast field {:?} not found in segment.".to_string(),
-                )
-            })?;
+            let bytes_reader = reader.fast_fields().bytes(field)?;
             if let Some(delete_bitset) = reader.delete_bitset() {
                 for doc in 0u32..reader.max_doc() {
                     if delete_bitset.is_alive(doc) {
@@ -479,7 +476,7 @@ impl IndexMerger {
             serialize_idx.close_field()?;
         }
 
-        let mut serialize_vals = fast_field_serializer.new_bytes_fast_field_with_idx(field, 1)?;
+        let mut serialize_vals = fast_field_serializer.new_bytes_fast_field_with_idx(field, 1);
         for segment_reader in &self.readers {
             let bytes_reader = segment_reader.fast_fields().bytes(field)
                 .expect("Failed to find bytes field in fast field reader. This is a bug in tantivy. Please report.");
@@ -503,7 +500,6 @@ impl IndexMerger {
         let mut positions_buffer: Vec<u32> = Vec::with_capacity(1_000);
         let mut delta_computer = DeltaComputer::new();
 
-        let mut field_term_streams = Vec::new();
         let mut max_term_ords: Vec<TermOrdinal> = Vec::new();
 
         let field_readers: Vec<Arc<InvertedIndexReader>> = self
@@ -512,16 +508,16 @@ impl IndexMerger {
             .map(|reader| reader.inverted_index(indexed_field))
             .collect::<crate::Result<Vec<_>>>()?;
 
+        let mut field_term_streams = Vec::new();
         for field_reader in &field_readers {
             let terms = field_reader.terms();
             field_term_streams.push(terms.stream()?);
             max_term_ords.push(terms.num_terms() as u64);
         }
 
-        let mut term_ord_mapping_opt = if *field_type == FieldType::HierarchicalFacet {
-            Some(TermOrdinalMapping::new(max_term_ords))
-        } else {
-            None
+        let mut term_ord_mapping_opt = match field_type {
+            FieldType::HierarchicalFacet(_) => Some(TermOrdinalMapping::new(max_term_ords)),
+            _ => None,
         };
 
         let mut merged_terms = TermMerger::new(field_term_streams);
@@ -1182,7 +1178,7 @@ mod tests {
     #[test]
     fn test_merge_facets() {
         let mut schema_builder = schema::Schema::builder();
-        let facet_field = schema_builder.add_facet_field("facet");
+        let facet_field = schema_builder.add_facet_field("facet", INDEXED);
         let index = Index::create_in_ram(schema_builder.build());
         let reader = index.reader().unwrap();
         {

src/indexer/segment_writer.rs

@@ -142,7 +142,7 @@ impl SegmentWriter {
             let (term_buffer, multifield_postings) =
                 (&mut self.term_buffer, &mut self.multifield_postings);
             match *field_entry.field_type() {
-                FieldType::HierarchicalFacet => {
+                FieldType::HierarchicalFacet(_) => {
                     term_buffer.set_field(field);
                     let facets =
                         field_values
@@ -213,69 +213,59 @@ impl SegmentWriter {
 
                     self.fieldnorms_writer.record(doc_id, field, num_tokens);
                 }
-                FieldType::U64(ref int_option) => {
-                    if int_option.is_indexed() {
-                        for field_value in field_values {
-                            term_buffer.set_field(field_value.field());
-                            let u64_val = field_value
-                                .value()
-                                .u64_value()
-                                .ok_or_else(make_schema_error)?;
-                            term_buffer.set_u64(u64_val);
-                            multifield_postings.subscribe(doc_id, &term_buffer);
-                        }
+                FieldType::U64(_) => {
+                    for field_value in field_values {
+                        term_buffer.set_field(field_value.field());
+                        let u64_val = field_value
+                            .value()
+                            .u64_value()
+                            .ok_or_else(make_schema_error)?;
+                        term_buffer.set_u64(u64_val);
+                        multifield_postings.subscribe(doc_id, &term_buffer);
                     }
                 }
-                FieldType::Date(ref int_option) => {
-                    if int_option.is_indexed() {
-                        for field_value in field_values {
-                            term_buffer.set_field(field_value.field());
-                            let date_val = field_value
-                                .value()
-                                .date_value()
-                                .ok_or_else(make_schema_error)?;
-                            term_buffer.set_i64(date_val.timestamp());
-                            multifield_postings.subscribe(doc_id, &term_buffer);
-                        }
+                FieldType::Date(_) => {
+                    for field_value in field_values {
+                        term_buffer.set_field(field_value.field());
+                        let date_val = field_value
+                            .value()
+                            .date_value()
+                            .ok_or_else(make_schema_error)?;
+                        term_buffer.set_i64(date_val.timestamp());
+                        multifield_postings.subscribe(doc_id, &term_buffer);
                     }
                 }
-                FieldType::I64(ref int_option) => {
-                    if int_option.is_indexed() {
-                        for field_value in field_values {
-                            term_buffer.set_field(field_value.field());
-                            let i64_val = field_value
-                                .value()
-                                .i64_value()
-                                .ok_or_else(make_schema_error)?;
-                            term_buffer.set_i64(i64_val);
-                            multifield_postings.subscribe(doc_id, &term_buffer);
-                        }
+                FieldType::I64(_) => {
+                    for field_value in field_values {
+                        term_buffer.set_field(field_value.field());
+                        let i64_val = field_value
+                            .value()
+                            .i64_value()
+                            .ok_or_else(make_schema_error)?;
+                        term_buffer.set_i64(i64_val);
+                        multifield_postings.subscribe(doc_id, &term_buffer);
                     }
                 }
-                FieldType::F64(ref int_option) => {
-                    if int_option.is_indexed() {
-                        for field_value in field_values {
-                            term_buffer.set_field(field_value.field());
-                            let f64_val = field_value
-                                .value()
-                                .f64_value()
-                                .ok_or_else(make_schema_error)?;
-                            term_buffer.set_f64(f64_val);
-                            multifield_postings.subscribe(doc_id, &term_buffer);
-                        }
+                FieldType::F64(_) => {
+                    for field_value in field_values {
+                        term_buffer.set_field(field_value.field());
+                        let f64_val = field_value
+                            .value()
+                            .f64_value()
+                            .ok_or_else(make_schema_error)?;
+                        term_buffer.set_f64(f64_val);
+                        multifield_postings.subscribe(doc_id, &term_buffer);
                     }
                 }
-                FieldType::Bytes(ref option) => {
-                    if option.is_indexed() {
-                        for field_value in field_values {
-                            term_buffer.set_field(field_value.field());
-                            let bytes = field_value
-                                .value()
-                                .bytes_value()
-                                .ok_or_else(make_schema_error)?;
-                            term_buffer.set_bytes(bytes);
-                            self.multifield_postings.subscribe(doc_id, &term_buffer);
-                        }
+                FieldType::Bytes(_) => {
+                    for field_value in field_values {
+                        term_buffer.set_field(field_value.field());
+                        let bytes = field_value
+                            .value()
+                            .bytes_value()
+                            .ok_or_else(make_schema_error)?;
+                        term_buffer.set_bytes(bytes);
+                        self.multifield_postings.subscribe(doc_id, &term_buffer);
                     }
                 }
             }

src/lib.rs

@@ -96,7 +96,7 @@
 //! A good place for you to get started is to check out
 //! the example code (
 //! [literate programming](https://tantivy-search.github.io/examples/basic_search.html) /
-//! [source code](https://github.com/tantivy-search/tantivy/blob/master/examples/basic_search.rs))
+//! [source code](https://github.com/tantivy-search/tantivy/blob/main/examples/basic_search.rs))
 
 #[cfg_attr(test, macro_use)]
 extern crate serde_json;
@@ -174,7 +174,7 @@ use once_cell::sync::Lazy;
 use serde::{Deserialize, Serialize};
 
 /// Index format version.
-const INDEX_FORMAT_VERSION: u32 = 2;
+const INDEX_FORMAT_VERSION: u32 = 3;
 
 /// Structure version for the index.
 #[derive(Clone, PartialEq, Eq, Serialize, Deserialize)]
@@ -234,6 +234,8 @@ pub mod merge_policy {
 /// A `u32` identifying a document within a segment.
 /// Documents have their `DocId` assigned incrementally,
 /// as they are added in the segment.
+///
+/// At most, a segment can contain 2^31 documents.
 pub type DocId = u32;
 
 /// A u64 assigned to every operation incrementally
@@ -866,39 +868,39 @@ mod tests {
         let searcher = reader.searcher();
         let segment_reader: &SegmentReader = searcher.segment_reader(0);
         {
-            let fast_field_reader_opt = segment_reader.fast_fields().u64(text_field);
-            assert!(fast_field_reader_opt.is_none());
+            let fast_field_reader_res = segment_reader.fast_fields().u64(text_field);
+            assert!(fast_field_reader_res.is_err());
         }
         {
             let fast_field_reader_opt = segment_reader.fast_fields().u64(stored_int_field);
-            assert!(fast_field_reader_opt.is_none());
+            assert!(fast_field_reader_opt.is_err());
         }
         {
             let fast_field_reader_opt = segment_reader.fast_fields().u64(fast_field_signed);
-            assert!(fast_field_reader_opt.is_none());
+            assert!(fast_field_reader_opt.is_err());
         }
         {
             let fast_field_reader_opt = segment_reader.fast_fields().u64(fast_field_float);
-            assert!(fast_field_reader_opt.is_none());
+            assert!(fast_field_reader_opt.is_err());
         }
         {
             let fast_field_reader_opt = segment_reader.fast_fields().u64(fast_field_unsigned);
-            assert!(fast_field_reader_opt.is_some());
+            assert!(fast_field_reader_opt.is_ok());
             let fast_field_reader = fast_field_reader_opt.unwrap();
             assert_eq!(fast_field_reader.get(0), 4u64)
         }
 
         {
-            let fast_field_reader_opt = segment_reader.fast_fields().i64(fast_field_signed);
-            assert!(fast_field_reader_opt.is_some());
-            let fast_field_reader = fast_field_reader_opt.unwrap();
+            let fast_field_reader_res = segment_reader.fast_fields().i64(fast_field_signed);
+            assert!(fast_field_reader_res.is_ok());
+            let fast_field_reader = fast_field_reader_res.unwrap();
             assert_eq!(fast_field_reader.get(0), 4i64)
         }
 
         {
-            let fast_field_reader_opt = segment_reader.fast_fields().f64(fast_field_float);
-            assert!(fast_field_reader_opt.is_some());
-            let fast_field_reader = fast_field_reader_opt.unwrap();
+            let fast_field_reader_res = segment_reader.fast_fields().f64(fast_field_float);
+            assert!(fast_field_reader_res.is_ok());
+            let fast_field_reader = fast_field_reader_res.unwrap();
             assert_eq!(fast_field_reader.get(0), 4f64)
         }
         Ok(())

src/positions/reader.rs

@@ -132,7 +132,7 @@ impl PositionReader {
             "offset arguments should be increasing."
         );
         let delta_to_block_offset = offset as i64 - self.block_offset as i64;
-        if delta_to_block_offset < 0 || delta_to_block_offset >= 128 {
+        if !(0..128).contains(&delta_to_block_offset) {
             // The first position is not within the first block.
             // We need to decompress the first block.
             let delta_to_anchor_offset = offset - self.anchor_offset;

src/positions/serializer.rs

@@ -8,7 +8,7 @@ use std::io::{self, Write};
 pub struct PositionSerializer<W: io::Write> {
     bit_packer: BitPacker4x,
     write_stream: CountingWriter<W>,
-    write_skiplist: W,
+    write_skip_index: W,
     block: Vec<u32>,
     buffer: Vec<u8>,
     num_ints: u64,
@@ -16,11 +16,11 @@ pub struct PositionSerializer<W: io::Write> {
 }
 
 impl<W: io::Write> PositionSerializer<W> {
-    pub fn new(write_stream: W, write_skiplist: W) -> PositionSerializer<W> {
+    pub fn new(write_stream: W, write_skip_index: W) -> PositionSerializer<W> {
         PositionSerializer {
             bit_packer: BitPacker4x::new(),
             write_stream: CountingWriter::wrap(write_stream),
-            write_skiplist,
+            write_skip_index,
             block: Vec::with_capacity(128),
             buffer: vec![0u8; 128 * 4],
             num_ints: 0u64,
@@ -52,7 +52,7 @@ impl<W: io::Write> PositionSerializer<W> {
 
     fn flush_block(&mut self) -> io::Result<()> {
         let num_bits = self.bit_packer.num_bits(&self.block[..]);
-        self.write_skiplist.write_all(&[num_bits])?;
+        self.write_skip_index.write_all(&[num_bits])?;
         let written_len = self
             .bit_packer
             .compress(&self.block[..], &mut self.buffer, num_bits);
@@ -70,10 +70,10 @@ impl<W: io::Write> PositionSerializer<W> {
             self.flush_block()?;
         }
         for &long_skip in &self.long_skips {
-            long_skip.serialize(&mut self.write_skiplist)?;
+            long_skip.serialize(&mut self.write_skip_index)?;
         }
-        (self.long_skips.len() as u32).serialize(&mut self.write_skiplist)?;
-        self.write_skiplist.flush()?;
+        (self.long_skips.len() as u32).serialize(&mut self.write_skip_index)?;
+        self.write_skip_index.flush()?;
         self.write_stream.flush()?;
         Ok(())
     }

src/postings/block_search.rs

@@ -1,3 +1,5 @@
+use std::ops::Range;
+
 use crate::postings::compression::AlignedBuffer;
 
 /// This modules define the logic used to search for a doc in a given
@@ -72,7 +74,7 @@ fn linear_search(arr: &[u32], target: u32) -> usize {
     arr.iter().map(|&el| if el < target { 1 } else { 0 }).sum()
 }
 
-fn exponential_search(arr: &[u32], target: u32) -> (usize, usize) {
+fn exponential_search(arr: &[u32], target: u32) -> Range<usize> {
     let end = arr.len();
     let mut begin = 0;
     for &pivot in &[1, 3, 7, 15, 31, 63] {
@@ -80,17 +82,17 @@ fn exponential_search(arr: &[u32], target: u32) -> (usize, usize) {
             break;
         }
         if arr[pivot] > target {
-            return (begin, pivot);
+            return begin..pivot;
         }
         begin = pivot;
     }
-    (begin, end)
+    begin..end
 }
 
 #[inline(never)]
 fn galloping(block_docs: &[u32], target: u32) -> usize {
-    let (start, end) = exponential_search(&block_docs, target);
-    start + linear_search(&block_docs[start..end], target)
+    let range = exponential_search(&block_docs, target);
+    range.start + linear_search(&block_docs[range], target)
 }
 
 /// Tantivy may rely on SIMD instructions to search for a specific document within
@@ -182,11 +184,11 @@ mod tests {
 
     #[test]
     fn test_exponentiel_search() {
-        assert_eq!(exponential_search(&[1, 2], 0), (0, 1));
-        assert_eq!(exponential_search(&[1, 2], 1), (0, 1));
+        assert_eq!(exponential_search(&[1, 2], 0), 0..1);
+        assert_eq!(exponential_search(&[1, 2], 1), 0..1);
         assert_eq!(
             exponential_search(&[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11], 7),
-            (3, 7)
+            3..7
         );
     }
 

src/postings/mod.rs

@@ -54,7 +54,7 @@ pub mod tests {
     use crate::DocId;
     use crate::HasLen;
     use crate::Score;
-    use std::iter;
+    use std::{iter, mem};
 
     #[test]
     pub fn test_position_write() -> crate::Result<()> {
@@ -71,6 +71,7 @@ pub mod tests {
             field_serializer.write_doc(doc_id, 4, &delta_positions)?;
         }
         field_serializer.close_term()?;
+        mem::drop(field_serializer);
         posting_serializer.close()?;
         let read = segment.open_read(SegmentComponent::POSITIONS)?;
         assert!(read.len() <= 140);
@@ -179,7 +180,7 @@ pub mod tests {
             let inverted_index = segment_reader.inverted_index(text_field)?;
             assert_eq!(inverted_index.terms().num_terms(), 1);
             let mut bytes = vec![];
-            assert!(inverted_index.terms().ord_to_term(0, &mut bytes));
+            assert!(inverted_index.terms().ord_to_term(0, &mut bytes)?);
             assert_eq!(&bytes, b"hello");
         }
         {
@@ -191,7 +192,7 @@ pub mod tests {
             let inverted_index = segment_reader.inverted_index(text_field)?;
             assert_eq!(inverted_index.terms().num_terms(), 1);
             let mut bytes = vec![];
-            assert!(inverted_index.terms().ord_to_term(0, &mut bytes));
+            assert!(inverted_index.terms().ord_to_term(0, &mut bytes)?);
             assert_eq!(&bytes[..], ok_token_text.as_bytes());
         }
         Ok(())

src/postings/postings_writer.rs

@@ -16,7 +16,7 @@ use fnv::FnvHashMap;
 use std::collections::HashMap;
 use std::io;
 use std::marker::PhantomData;
-use std::ops::DerefMut;
+use std::ops::{DerefMut, Range};
 
 fn posting_from_field_entry(field_entry: &FieldEntry) -> Box<dyn PostingsWriter> {
     match *field_entry.field_type() {
@@ -39,7 +39,9 @@ fn posting_from_field_entry(field_entry: &FieldEntry) -> Box<dyn PostingsWriter>
         | FieldType::F64(_)
         | FieldType::Date(_)
         | FieldType::Bytes(_)
-        | FieldType::HierarchicalFacet => SpecializedPostingsWriter::<NothingRecorder>::new_boxed(),
+        | FieldType::HierarchicalFacet(_) => {
+            SpecializedPostingsWriter::<NothingRecorder>::new_boxed()
+        }
     }
 }
 
@@ -52,7 +54,7 @@ pub struct MultiFieldPostingsWriter {
 
 fn make_field_partition(
     term_offsets: &[(&[u8], Addr, UnorderedTermId)],
-) -> Vec<(Field, usize, usize)> {
+) -> Vec<(Field, Range<usize>)> {
     let term_offsets_it = term_offsets
         .iter()
         .map(|(key, _, _)| Term::wrap(key).field())
@@ -70,7 +72,7 @@ fn make_field_partition(
     offsets.push(term_offsets.len());
     let mut field_offsets = vec![];
     for i in 0..fields.len() {
-        field_offsets.push((fields[i], offsets[i], offsets[i + 1]));
+        field_offsets.push((fields[i], offsets[i]..offsets[i + 1]));
     }
     field_offsets
 }
@@ -138,14 +140,14 @@ impl MultiFieldPostingsWriter {
 
         let field_offsets = make_field_partition(&term_offsets);
 
-        for (field, start, stop) in field_offsets {
+        for (field, byte_offsets) in field_offsets {
             let field_entry = self.schema.get_field_entry(field);
 
             match *field_entry.field_type() {
-                FieldType::Str(_) | FieldType::HierarchicalFacet => {
+                FieldType::Str(_) | FieldType::HierarchicalFacet(_) => {
                     // populating the (unordered term ord) -> (ordered term ord) mapping
                     // for the field.
-                    let unordered_term_ids = term_offsets[start..stop]
+                    let unordered_term_ids = term_offsets[byte_offsets.clone()]
                         .iter()
                         .map(|&(_, _, bucket)| bucket);
                     let mapping: FnvHashMap<UnorderedTermId, TermOrdinal> = unordered_term_ids
@@ -169,7 +171,7 @@ impl MultiFieldPostingsWriter {
                 fieldnorm_reader,
             )?;
             postings_writer.serialize(
-                &term_offsets[start..stop],
+                &term_offsets[byte_offsets],
                 &mut field_serializer,
                 &self.term_index.heap,
                 &self.heap,

src/postings/segment_postings.rs

@@ -1,14 +1,11 @@
 use crate::common::HasLen;
-use crate::directory::FileSlice;
 use crate::docset::DocSet;
 use crate::fastfield::DeleteBitSet;
 use crate::positions::PositionReader;
 use crate::postings::compression::COMPRESSION_BLOCK_SIZE;
-use crate::postings::serializer::PostingsSerializer;
 use crate::postings::BlockSearcher;
 use crate::postings::BlockSegmentPostings;
 use crate::postings::Postings;
-use crate::schema::IndexRecordOption;
 use crate::{DocId, TERMINATED};
 
 /// `SegmentPostings` represents the inverted list or postings associated to
@@ -68,7 +65,11 @@ impl SegmentPostings {
     /// It serializes the doc ids using tantivy's codec
     /// and returns a `SegmentPostings` object that embeds a
     /// buffer with the serialized data.
+    #[cfg(test)]
     pub fn create_from_docs(docs: &[u32]) -> SegmentPostings {
+        use crate::directory::FileSlice;
+        use crate::postings::serializer::PostingsSerializer;
+        use crate::schema::IndexRecordOption;
         let mut buffer = Vec::new();
         {
             let mut postings_serializer =
@@ -97,7 +98,10 @@ impl SegmentPostings {
         doc_and_tfs: &[(u32, u32)],
         fieldnorms: Option<&[u32]>,
     ) -> SegmentPostings {
+        use crate::directory::FileSlice;
         use crate::fieldnorm::FieldNormReader;
+        use crate::postings::serializer::PostingsSerializer;
+        use crate::schema::IndexRecordOption;
         use crate::Score;
         let mut buffer: Vec<u8> = Vec::new();
         let fieldnorm_reader = fieldnorms.map(FieldNormReader::for_test);

src/postings/serializer.rs

@@ -55,33 +55,17 @@ pub struct InvertedIndexSerializer {
 }
 
 impl InvertedIndexSerializer {
-    /// Open a new `InvertedIndexSerializer` for the given segment
-    fn create(
-        terms_write: CompositeWrite<WritePtr>,
-        postings_write: CompositeWrite<WritePtr>,
-        positions_write: CompositeWrite<WritePtr>,
-        positionsidx_write: CompositeWrite<WritePtr>,
-        schema: Schema,
-    ) -> crate::Result<InvertedIndexSerializer> {
-        Ok(InvertedIndexSerializer {
-            terms_write,
-            postings_write,
-            positions_write,
-            positionsidx_write,
-            schema,
-        })
-    }
-
     /// Open a new `PostingsSerializer` for the given segment
     pub fn open(segment: &mut Segment) -> crate::Result<InvertedIndexSerializer> {
         use crate::SegmentComponent::{POSITIONS, POSITIONSSKIP, POSTINGS, TERMS};
-        InvertedIndexSerializer::create(
-            CompositeWrite::wrap(segment.open_write(TERMS)?),
-            CompositeWrite::wrap(segment.open_write(POSTINGS)?),
-            CompositeWrite::wrap(segment.open_write(POSITIONS)?),
-            CompositeWrite::wrap(segment.open_write(POSITIONSSKIP)?),
-            segment.schema(),
-        )
+        let inv_index_serializer = InvertedIndexSerializer {
+            terms_write: CompositeWrite::wrap(segment.open_write(TERMS)?),
+            postings_write: CompositeWrite::wrap(segment.open_write(POSTINGS)?),
+            positions_write: CompositeWrite::wrap(segment.open_write(POSITIONS)?),
+            positionsidx_write: CompositeWrite::wrap(segment.open_write(POSITIONSSKIP)?),
+            schema: segment.schema(),
+        };
+        Ok(inv_index_serializer)
     }
 
     /// Must be called before starting pushing terms of
@@ -183,10 +167,10 @@ impl<'a> FieldSerializer<'a> {
             } else {
                 0u64
             };
+        let addr = self.postings_serializer.addr() as usize;
         TermInfo {
             doc_freq: 0,
-            postings_start_offset: self.postings_serializer.addr(),
-            postings_stop_offset: 0u64,
+            postings_range: addr..addr,
             positions_idx,
         }
     }
@@ -242,7 +226,7 @@ impl<'a> FieldSerializer<'a> {
         if self.term_open {
             self.postings_serializer
                 .close_term(self.current_term_info.doc_freq)?;
-            self.current_term_info.postings_stop_offset = self.postings_serializer.addr();
+            self.current_term_info.postings_range.end = self.postings_serializer.addr() as usize;
             self.term_dictionary_builder
                 .insert_value(&self.current_term_info)?;
             self.term_open = false;

src/postings/skip.rs

@@ -1,32 +1,46 @@
-use crate::common::{read_u32_vint_no_advance, serialize_vint_u32, BinarySerializable};
+use std::convert::TryInto;
+
 use crate::directory::OwnedBytes;
 use crate::postings::compression::{compressed_block_size, COMPRESSION_BLOCK_SIZE};
 use crate::query::BM25Weight;
 use crate::schema::IndexRecordOption;
 use crate::{DocId, Score, TERMINATED};
 
+#[inline(always)]
+fn encode_block_wand_max_tf(max_tf: u32) -> u8 {
+    max_tf.min(u8::MAX as u32) as u8
+}
+
+#[inline(always)]
+fn decode_block_wand_max_tf(max_tf_code: u8) -> u32 {
+    if max_tf_code == u8::MAX {
+        u32::MAX
+    } else {
+        max_tf_code as u32
+    }
+}
+
+#[inline(always)]
+fn read_u32(data: &[u8]) -> u32 {
+    u32::from_le_bytes(data[..4].try_into().unwrap())
+}
+
+#[inline(always)]
+fn write_u32(val: u32, buf: &mut Vec<u8>) {
+    buf.extend_from_slice(&val.to_le_bytes());
+}
+
 pub struct SkipSerializer {
     buffer: Vec<u8>,
-    prev_doc: DocId,
 }
 
 impl SkipSerializer {
     pub fn new() -> SkipSerializer {
-        SkipSerializer {
-            buffer: Vec::new(),
-            prev_doc: 0u32,
-        }
+        SkipSerializer { buffer: Vec::new() }
     }
 
     pub fn write_doc(&mut self, last_doc: DocId, doc_num_bits: u8) {
-        assert!(
-            last_doc > self.prev_doc,
-            "write_doc(...) called with non-increasing doc ids. \
-             Did you forget to call clear maybe?"
-        );
-        let delta_doc = last_doc - self.prev_doc;
-        self.prev_doc = last_doc;
-        delta_doc.serialize(&mut self.buffer).unwrap();
+        write_u32(last_doc, &mut self.buffer);
         self.buffer.push(doc_num_bits);
     }
 
@@ -35,16 +49,13 @@ impl SkipSerializer {
     }
 
     pub fn write_total_term_freq(&mut self, tf_sum: u32) {
-        tf_sum
-            .serialize(&mut self.buffer)
-            .expect("Should never fail");
+        write_u32(tf_sum, &mut self.buffer);
     }
 
     pub fn write_blockwand_max(&mut self, fieldnorm_id: u8, term_freq: u32) {
-        self.buffer.push(fieldnorm_id);
-        let mut buf = [0u8; 8];
-        let bytes = serialize_vint_u32(term_freq, &mut buf);
-        self.buffer.extend_from_slice(bytes);
+        let block_wand_tf = encode_block_wand_max_tf(term_freq);
+        self.buffer
+            .extend_from_slice(&[fieldnorm_id, block_wand_tf]);
     }
 
     pub fn data(&self) -> &[u8] {
@@ -52,7 +63,6 @@ impl SkipSerializer {
     }
 
     pub fn clear(&mut self) {
-        self.prev_doc = 0u32;
         self.buffer.clear();
     }
 }
@@ -159,18 +169,13 @@ impl SkipReader {
     }
 
     fn read_block_info(&mut self) {
-        let doc_delta = {
-            let bytes = self.owned_read.as_slice();
-            let mut buf = [0; 4];
-            buf.copy_from_slice(&bytes[..4]);
-            u32::from_le_bytes(buf)
-        };
-        self.last_doc_in_block += doc_delta as DocId;
-        let doc_num_bits = self.owned_read.as_slice()[4];
-
+        let bytes = self.owned_read.as_slice();
+        let advance_len: usize;
+        self.last_doc_in_block = read_u32(bytes);
+        let doc_num_bits = bytes[4];
         match self.skip_info {
             IndexRecordOption::Basic => {
-                self.owned_read.advance(5);
+                advance_len = 5;
                 self.block_info = BlockInfo::BitPacked {
                     doc_num_bits,
                     tf_num_bits: 0,
@@ -180,11 +185,10 @@ impl SkipReader {
                 };
             }
             IndexRecordOption::WithFreqs => {
-                let bytes = self.owned_read.as_slice();
                 let tf_num_bits = bytes[5];
                 let block_wand_fieldnorm_id = bytes[6];
-                let (block_wand_term_freq, num_bytes) = read_u32_vint_no_advance(&bytes[7..]);
-                self.owned_read.advance(7 + num_bytes);
+                let block_wand_term_freq = decode_block_wand_max_tf(bytes[7]);
+                advance_len = 8;
                 self.block_info = BlockInfo::BitPacked {
                     doc_num_bits,
                     tf_num_bits,
@@ -194,16 +198,11 @@ impl SkipReader {
                 };
             }
             IndexRecordOption::WithFreqsAndPositions => {
-                let bytes = self.owned_read.as_slice();
                 let tf_num_bits = bytes[5];
-                let tf_sum = {
-                    let mut buf = [0; 4];
-                    buf.copy_from_slice(&bytes[6..10]);
-                    u32::from_le_bytes(buf)
-                };
+                let tf_sum = read_u32(&bytes[6..10]);
                 let block_wand_fieldnorm_id = bytes[10];
-                let (block_wand_term_freq, num_bytes) = read_u32_vint_no_advance(&bytes[11..]);
-                self.owned_read.advance(11 + num_bytes);
+                let block_wand_term_freq = decode_block_wand_max_tf(bytes[11]);
+                advance_len = 12;
                 self.block_info = BlockInfo::BitPacked {
                     doc_num_bits,
                     tf_num_bits,
@@ -213,6 +212,7 @@ impl SkipReader {
                 };
             }
         }
+        self.owned_read.advance(advance_len);
     }
 
     pub fn block_info(&self) -> BlockInfo {
@@ -274,6 +274,24 @@ mod tests {
     use crate::directory::OwnedBytes;
     use crate::postings::compression::COMPRESSION_BLOCK_SIZE;
 
+    #[test]
+    fn test_encode_block_wand_max_tf() {
+        for tf in 0..255 {
+            assert_eq!(super::encode_block_wand_max_tf(tf), tf as u8);
+        }
+        for &tf in &[255, 256, 1_000_000, u32::MAX] {
+            assert_eq!(super::encode_block_wand_max_tf(tf), 255);
+        }
+    }
+
+    #[test]
+    fn test_decode_block_wand_max_tf() {
+        for tf in 0..255 {
+            assert_eq!(super::decode_block_wand_max_tf(tf), tf as u32);
+        }
+        assert_eq!(super::decode_block_wand_max_tf(255), u32::MAX);
+    }
+
     #[test]
     fn test_skip_with_freq() {
         let buf = {

src/postings/stacker/term_hashmap.rs

@@ -17,10 +17,6 @@ pub fn compute_table_size(num_bits: usize) -> usize {
 /// `KeyValue` is the item stored in the hash table.
 /// The key is actually a `BytesRef` object stored in an external heap.
 /// The `value_addr` also points to an address in the heap.
-///
-/// The key and the value are actually stored contiguously.
-/// For this reason, the (start, stop) information is actually redundant
-/// and can be simplified in the future
 #[derive(Copy, Clone)]
 struct KeyValue {
     key_value_addr: Addr,

src/postings/term_info.rs

@@ -1,25 +1,24 @@
 use crate::common::{BinarySerializable, FixedSize};
 use std::io;
+use std::iter::ExactSizeIterator;
+use std::ops::Range;
 
 /// `TermInfo` wraps the metadata associated to a Term.
 /// It is segment-local.
-#[derive(Debug, Default, Ord, PartialOrd, Eq, PartialEq, Clone)]
+#[derive(Debug, Default, Eq, PartialEq, Clone)]
 pub struct TermInfo {
     /// Number of documents in the segment containing the term
     pub doc_freq: u32,
-    /// Start offset of the posting list within the postings (`.idx`) file.
-    pub postings_start_offset: u64,
-    /// Stop offset of the posting list within the postings (`.idx`) file.
-    /// The byte range is `[start_offset..stop_offset)`.
-    pub postings_stop_offset: u64,
+    /// Byte range of the posting list within the postings (`.idx`) file.
+    pub postings_range: Range<usize>,
     /// Start offset of the first block within the position (`.pos`) file.
     pub positions_idx: u64,
 }
 
 impl TermInfo {
     pub(crate) fn posting_num_bytes(&self) -> u32 {
-        let num_bytes = self.postings_stop_offset - self.postings_start_offset;
-        assert!(num_bytes <= std::u32::MAX as u64);
+        let num_bytes = self.postings_range.len();
+        assert!(num_bytes <= std::u32::MAX as usize);
         num_bytes as u32
     }
 }
@@ -35,7 +34,7 @@ impl FixedSize for TermInfo {
 impl BinarySerializable for TermInfo {
     fn serialize<W: io::Write>(&self, writer: &mut W) -> io::Result<()> {
         self.doc_freq.serialize(writer)?;
-        self.postings_start_offset.serialize(writer)?;
+        (self.postings_range.start as u64).serialize(writer)?;
         self.posting_num_bytes().serialize(writer)?;
         self.positions_idx.serialize(writer)?;
         Ok(())
@@ -43,14 +42,13 @@ impl BinarySerializable for TermInfo {
 
     fn deserialize<R: io::Read>(reader: &mut R) -> io::Result<Self> {
         let doc_freq = u32::deserialize(reader)?;
-        let postings_start_offset = u64::deserialize(reader)?;
+        let postings_start_offset = u64::deserialize(reader)? as usize;
         let postings_num_bytes = u32::deserialize(reader)?;
-        let postings_stop_offset = postings_start_offset + u64::from(postings_num_bytes);
+        let postings_end_offset = postings_start_offset + u64::from(postings_num_bytes) as usize;
         let positions_idx = u64::deserialize(reader)?;
         Ok(TermInfo {
             doc_freq,
-            postings_start_offset,
-            postings_stop_offset,
+            postings_range: postings_start_offset..postings_end_offset,
             positions_idx,
         })
     }

src/query/automaton_weight.rs

@@ -20,6 +20,7 @@ pub struct AutomatonWeight<A> {
 impl<A> AutomatonWeight<A>
 where
     A: Automaton + Send + Sync + 'static,
+    A::State: Clone,
 {
     /// Create a new AutomationWeight
     pub fn new<IntoArcA: Into<Arc<A>>>(field: Field, automaton: IntoArcA) -> AutomatonWeight<A> {
@@ -42,6 +43,7 @@ where
 impl<A> Weight for AutomatonWeight<A>
 where
     A: Automaton + Send + Sync + 'static,
+    A::State: Clone,
 {
     fn scorer(&self, reader: &SegmentReader, boost: Score) -> crate::Result<Box<dyn Scorer>> {
         let max_doc = reader.max_doc();
@@ -102,6 +104,7 @@ mod tests {
         index
     }
 
+    #[derive(Clone, Copy)]
     enum State {
         Start,
         NotMatching,

src/query/query_parser/query_parser.rs

@@ -357,7 +357,7 @@ impl QueryParser {
                     ))
                 }
             }
-            FieldType::HierarchicalFacet => {
+            FieldType::HierarchicalFacet(_) => {
                 let facet = Facet::from_text(phrase);
                 Ok(vec![(0, Term::from_field_text(field, facet.encoded_str()))])
             }
@@ -605,7 +605,8 @@ mod test {
         schema_builder.add_text_field("with_stop_words", text_options);
         schema_builder.add_date_field("date", INDEXED);
         schema_builder.add_f64_field("float", INDEXED);
-        schema_builder.add_facet_field("facet");
+        schema_builder.add_facet_field("facet", INDEXED);
+        schema_builder.add_facet_field("facet_not_indexed", STORED);
         schema_builder.add_bytes_field("bytes", INDEXED);
         schema_builder.add_bytes_field("bytes_not_indexed", STORED);
         schema_builder.build()
@@ -658,6 +659,13 @@ mod test {
         );
     }
 
+    #[test]
+    fn test_parse_query_facet_not_indexed() {
+        let error =
+            parse_query_to_logical_ast("facet_not_indexed:/root/branch/leaf", false).unwrap_err();
+        assert!(matches!(error, QueryParserError::FieldNotIndexed(_)));
+    }
+
     #[test]
     pub fn test_parse_query_with_boost() {
         let mut query_parser = make_query_parser();
@@ -799,7 +807,7 @@ mod test {
     fn test_parse_bytes() {
         test_parse_query_to_logical_ast_helper(
             "bytes:YnVidQ==",
-            "Term(field=12,bytes=[98, 117, 98, 117])",
+            "Term(field=13,bytes=[98, 117, 98, 117])",
             false,
         );
     }
@@ -814,7 +822,7 @@ mod test {
     fn test_parse_bytes_phrase() {
         test_parse_query_to_logical_ast_helper(
             "bytes:\"YnVidQ==\"",
-            "Term(field=12,bytes=[98, 117, 98, 117])",
+            "Term(field=13,bytes=[98, 117, 98, 117])",
             false,
         );
     }

src/query/range_query.rs

@@ -10,9 +10,8 @@ use crate::schema::Type;
 use crate::schema::{Field, IndexRecordOption, Term};
 use crate::termdict::{TermDictionary, TermStreamer};
 use crate::{DocId, Score};
-use std::collections::Bound;
 use std::io;
-use std::ops::Range;
+use std::ops::{Bound, Range};
 
 fn map_bound<TFrom, TTo, Transform: Fn(&TFrom) -> TTo>(
     bound: &Bound<TFrom>,
@@ -276,7 +275,7 @@ pub struct RangeWeight {
 
 impl RangeWeight {
     fn term_range<'a>(&self, term_dict: &'a TermDictionary) -> io::Result<TermStreamer<'a>> {
-        use std::collections::Bound::*;
+        use std::ops::Bound::*;
         let mut term_stream_builder = term_dict.range();
         term_stream_builder = match self.left_bound {
             Included(ref term_val) => term_stream_builder.ge(term_val),
@@ -336,7 +335,7 @@ mod tests {
     use crate::query::QueryParser;
     use crate::schema::{Document, Field, Schema, INDEXED, TEXT};
     use crate::Index;
-    use std::collections::Bound;
+    use std::ops::Bound;
 
     #[test]
     fn test_range_query_simple() {

src/query/term_query/term_scorer.rs

@@ -302,7 +302,7 @@ mod tests {
         let mut rng = rand::thread_rng();
         writer.set_merge_policy(Box::new(NoMergePolicy));
         for _ in 0..3_000 {
-            let term_freq = rng.gen_range(1, 10000);
+            let term_freq = rng.gen_range(1..10000);
             let words: Vec<&str> = std::iter::repeat("bbbb").take(term_freq).collect();
             let text = words.join(" ");
             writer.add_document(doc!(text_field=>text));

src/reader/pool.rs

@@ -100,20 +100,32 @@ impl<T> Pool<T> {
 
     /// At the exit of this method,
     /// - freshest_generation has a value greater or equal than generation
-    /// - freshest_generation has a value that has been advertised
-    /// - freshest_generation has)
+    /// - freshest_generation has the last value that has been advertised
     fn advertise_generation(&self, generation: usize) {
         // not optimal at all but the easiest to read proof.
+        let mut former_generation = self.freshest_generation.load(Ordering::Acquire);
         loop {
-            let former_generation = self.freshest_generation.load(Ordering::Acquire);
-            if former_generation >= generation {
-                break;
-            }
-            self.freshest_generation.compare_and_swap(
+            match self.freshest_generation.compare_exchange(
                 former_generation,
                 generation,
                 Ordering::SeqCst,
-            );
+                Ordering::SeqCst,
+            ) {
+                Ok(_) => {
+                    // We successfuly updated the value.
+                    return;
+                }
+                Err(current_generation) => {
+                    // The value was updated after we did our load apparently.
+                    // In theory, it is always a value greater than ours, but just to
+                    // simplify the logic, we keep looping until we reach a
+                    // value >= to our target value.
+                    if current_generation >= generation {
+                        return;
+                    }
+                    former_generation = current_generation;
+                }
+            }
         }
     }
 

src/schema/facet.rs

@@ -233,6 +233,7 @@ mod tests {
         assert_eq!(Facet::root(), Facet::from("/"));
         assert_eq!(format!("{}", Facet::root()), "/");
         assert!(Facet::root().is_root());
+        assert_eq!(Facet::root().encoded_str(), "");
     }
 
     #[test]

src/schema/facet_options.rs

@@ -0,0 +1,96 @@
+use crate::schema::flags::{IndexedFlag, SchemaFlagList, StoredFlag};
+use serde::{Deserialize, Serialize};
+use std::ops::BitOr;
+
+/// Define how a facet field should be handled by tantivy.
+#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
+pub struct FacetOptions {
+    indexed: bool,
+    stored: bool,
+}
+
+impl FacetOptions {
+    /// Returns true iff the value is stored.
+    pub fn is_stored(&self) -> bool {
+        self.stored
+    }
+
+    /// Returns true iff the value is indexed.
+    pub fn is_indexed(&self) -> bool {
+        self.indexed
+    }
+
+    /// Set the field as stored.
+    ///
+    /// Only the fields that are set as *stored* are
+    /// persisted into the Tantivy's store.
+    pub fn set_stored(mut self) -> FacetOptions {
+        self.stored = true;
+        self
+    }
+
+    /// Set the field as indexed.
+    ///
+    /// Setting a facet as indexed will generate
+    /// a walkable path.
+    pub fn set_indexed(mut self) -> FacetOptions {
+        self.indexed = true;
+        self
+    }
+}
+
+impl Default for FacetOptions {
+    fn default() -> FacetOptions {
+        FacetOptions {
+            indexed: false,
+            stored: false,
+        }
+    }
+}
+
+impl From<()> for FacetOptions {
+    fn from(_: ()) -> FacetOptions {
+        FacetOptions::default()
+    }
+}
+
+impl From<StoredFlag> for FacetOptions {
+    fn from(_: StoredFlag) -> Self {
+        FacetOptions {
+            indexed: false,
+            stored: true,
+        }
+    }
+}
+
+impl From<IndexedFlag> for FacetOptions {
+    fn from(_: IndexedFlag) -> Self {
+        FacetOptions {
+            indexed: true,
+            stored: false,
+        }
+    }
+}
+
+impl<T: Into<FacetOptions>> BitOr<T> for FacetOptions {
+    type Output = FacetOptions;
+
+    fn bitor(self, other: T) -> FacetOptions {
+        let other = other.into();
+        FacetOptions {
+            indexed: self.indexed | other.indexed,
+            stored: self.stored | other.stored,
+        }
+    }
+}
+
+impl<Head, Tail> From<SchemaFlagList<Head, Tail>> for FacetOptions
+where
+    Head: Clone,
+    Tail: Clone,
+    Self: BitOr<Output = Self> + From<Head> + From<Tail>,
+{
+    fn from(head_tail: SchemaFlagList<Head, Tail>) -> Self {
+        Self::from(head_tail.head) | Self::from(head_tail.tail)
+    }
+}

src/schema/field_entry.rs

@@ -1,3 +1,4 @@
+use crate::schema::FacetOptions;
 use crate::schema::TextOptions;
 use crate::schema::{is_valid_field_name, IntOptions};
 
@@ -73,11 +74,11 @@ impl FieldEntry {
     }
 
     /// Creates a field entry for a facet.
-    pub fn new_facet(field_name: String) -> FieldEntry {
+    pub fn new_facet(field_name: String, field_type: FacetOptions) -> FieldEntry {
         assert!(is_valid_field_name(&field_name));
         FieldEntry {
             name: field_name,
-            field_type: FieldType::HierarchicalFacet,
+            field_type: FieldType::HierarchicalFacet(field_type),
         }
     }
 
@@ -107,7 +108,7 @@ impl FieldEntry {
             | FieldType::I64(ref options)
             | FieldType::F64(ref options)
             | FieldType::Date(ref options) => options.is_indexed(),
-            FieldType::HierarchicalFacet => true,
+            FieldType::HierarchicalFacet(ref options) => options.is_indexed(),
             FieldType::Bytes(ref options) => options.is_indexed(),
         }
     }
@@ -131,8 +132,7 @@ impl FieldEntry {
             | FieldType::F64(ref options)
             | FieldType::Date(ref options) => options.is_stored(),
             FieldType::Str(ref options) => options.is_stored(),
-            // TODO make stored hierarchical facet optional
-            FieldType::HierarchicalFacet => true,
+            FieldType::HierarchicalFacet(ref options) => options.is_stored(),
             FieldType::Bytes(ref options) => options.is_stored(),
         }
     }
@@ -167,8 +167,9 @@ impl Serialize for FieldEntry {
                 s.serialize_field("type", "date")?;
                 s.serialize_field("options", options)?;
             }
-            FieldType::HierarchicalFacet => {
+            FieldType::HierarchicalFacet(ref options) => {
                 s.serialize_field("type", "hierarchical_facet")?;
+                s.serialize_field("options", options)?;
             }
             FieldType::Bytes(ref options) => {
                 s.serialize_field("type", "bytes")?;
@@ -225,10 +226,8 @@ impl<'de> Deserialize<'de> for FieldEntry {
                             }
                             let type_string = map.next_value::<String>()?;
                             match type_string.as_str() {
-                                "hierarchical_facet" => {
-                                    field_type = Some(FieldType::HierarchicalFacet);
-                                }
-                                "text" | "u64" | "i64" | "f64" | "date" | "bytes" => {
+                                "text" | "u64" | "i64" | "f64" | "date" | "bytes"
+                                | "hierarchical_facet" => {
                                     // These types require additional options to create a field_type
                                 }
                                 _ => panic!("unhandled type"),
@@ -248,6 +247,10 @@ impl<'de> Deserialize<'de> for FieldEntry {
                                 "f64" => field_type = Some(FieldType::F64(map.next_value()?)),
                                 "date" => field_type = Some(FieldType::Date(map.next_value()?)),
                                 "bytes" => field_type = Some(FieldType::Bytes(map.next_value()?)),
+                                "hierarchical_facet" => {
+                                    field_type =
+                                        Some(FieldType::HierarchicalFacet(map.next_value()?))
+                                }
                                 _ => {
                                     let msg = format!("Unrecognised type {}", ty);
                                     return Err(de::Error::custom(msg));

src/schema/field_type.rs

@@ -1,4 +1,5 @@
 use crate::schema::bytes_options::BytesOptions;
+use crate::schema::facet_options::FacetOptions;
 use crate::schema::Facet;
 use crate::schema::IndexRecordOption;
 use crate::schema::TextFieldIndexing;
@@ -60,7 +61,7 @@ pub enum FieldType {
     /// Signed 64-bits Date 64 field type configuration,
     Date(IntOptions),
     /// Hierachical Facet
-    HierarchicalFacet,
+    HierarchicalFacet(FacetOptions),
     /// Bytes (one per document)
     Bytes(BytesOptions),
 }
@@ -74,7 +75,7 @@ impl FieldType {
             FieldType::I64(_) => Type::I64,
             FieldType::F64(_) => Type::F64,
             FieldType::Date(_) => Type::Date,
-            FieldType::HierarchicalFacet => Type::HierarchicalFacet,
+            FieldType::HierarchicalFacet(_) => Type::HierarchicalFacet,
             FieldType::Bytes(_) => Type::Bytes,
         }
     }
@@ -87,7 +88,7 @@ impl FieldType {
             | FieldType::I64(ref int_options)
             | FieldType::F64(ref int_options) => int_options.is_indexed(),
             FieldType::Date(ref date_options) => date_options.is_indexed(),
-            FieldType::HierarchicalFacet => true,
+            FieldType::HierarchicalFacet(ref facet_options) => facet_options.is_indexed(),
             FieldType::Bytes(ref bytes_options) => bytes_options.is_indexed(),
         }
     }
@@ -111,7 +112,13 @@ impl FieldType {
                     None
                 }
             }
-            FieldType::HierarchicalFacet => Some(IndexRecordOption::Basic),
+            FieldType::HierarchicalFacet(ref facet_options) => {
+                if facet_options.is_indexed() {
+                    Some(IndexRecordOption::Basic)
+                } else {
+                    None
+                }
+            }
             FieldType::Bytes(ref bytes_options) => {
                 if bytes_options.is_indexed() {
                     Some(IndexRecordOption::Basic)
@@ -144,7 +151,7 @@ impl FieldType {
                 FieldType::U64(_) | FieldType::I64(_) | FieldType::F64(_) => Err(
                     ValueParsingError::TypeError(format!("Expected an integer, got {:?}", json)),
                 ),
-                FieldType::HierarchicalFacet => Ok(Value::Facet(Facet::from(field_text))),
+                FieldType::HierarchicalFacet(_) => Ok(Value::Facet(Facet::from(field_text))),
                 FieldType::Bytes(_) => base64::decode(field_text).map(Value::Bytes).map_err(|_| {
                     ValueParsingError::InvalidBase64(format!(
                         "Expected base64 string, got {:?}",
@@ -177,7 +184,7 @@ impl FieldType {
                         Err(ValueParsingError::OverflowError(msg))
                     }
                 }
-                FieldType::Str(_) | FieldType::HierarchicalFacet | FieldType::Bytes(_) => {
+                FieldType::Str(_) | FieldType::HierarchicalFacet(_) | FieldType::Bytes(_) => {
                     let msg = format!("Expected a string, got {:?}", json);
                     Err(ValueParsingError::TypeError(msg))
                 }

src/schema/mod.rs

@@ -104,6 +104,7 @@ let schema = schema_builder.build();
 
 mod document;
 mod facet;
+mod facet_options;
 mod schema;
 mod term;
 
@@ -128,6 +129,7 @@ pub use self::value::Value;
 
 pub use self::facet::Facet;
 pub(crate) use self::facet::FACET_SEP_BYTE;
+pub use self::facet_options::FacetOptions;
 
 pub use self::document::Document;
 pub use self::field::Field;

src/schema/named_field_document.rs

@@ -1,5 +1,5 @@
 use crate::schema::Value;
-use serde::Serialize;
+use serde::{Deserialize, Serialize};
 use std::collections::BTreeMap;
 
 /// Internal representation of a document used for JSON
@@ -8,5 +8,5 @@ use std::collections::BTreeMap;
 /// A `NamedFieldDocument` is a simple representation of a document
 /// as a `BTreeMap<String, Vec<Value>>`.
 ///
-#[derive(Serialize)]
+#[derive(Debug, Deserialize, Serialize)]
 pub struct NamedFieldDocument(pub BTreeMap<String, Vec<Value>>);

src/schema/schema.rs

@@ -146,8 +146,12 @@ impl SchemaBuilder {
     }
 
     /// Adds a facet field to the schema.
-    pub fn add_facet_field(&mut self, field_name: &str) -> Field {
-        let field_entry = FieldEntry::new_facet(field_name.to_string());
+    pub fn add_facet_field<T: Into<FacetOptions>>(
+        &mut self,
+        field_name: &str,
+        facet_options: T,
+    ) -> Field {
+        let field_entry = FieldEntry::new_facet(field_name.to_string(), facet_options.into());
         self.add_field(field_entry)
     }
 
@@ -665,7 +669,10 @@ mod tests {
             );
             assert_matches!(
                 json_err,
-                Err(DocParsingError::ValueError(_, ValueParsingError::TypeError(_)))
+                Err(DocParsingError::ValueError(
+                    _,
+                    ValueParsingError::TypeError(_)
+                ))
             );
         }
         {
@@ -680,7 +687,10 @@ mod tests {
             );
             assert_matches!(
                 json_err,
-                Err(DocParsingError::ValueError(_, ValueParsingError::OverflowError(_)))
+                Err(DocParsingError::ValueError(
+                    _,
+                    ValueParsingError::OverflowError(_)
+                ))
             );
         }
         {
@@ -695,7 +705,10 @@ mod tests {
             );
             assert!(!matches!(
                 json_err,
-                Err(DocParsingError::ValueError(_, ValueParsingError::OverflowError(_)))
+                Err(DocParsingError::ValueError(
+                    _,
+                    ValueParsingError::OverflowError(_)
+                ))
             ));
         }
         {
@@ -710,7 +723,10 @@ mod tests {
             );
             assert_matches!(
                 json_err,
-                Err(DocParsingError::ValueError(_, ValueParsingError::OverflowError(_)))
+                Err(DocParsingError::ValueError(
+                    _,
+                    ValueParsingError::OverflowError(_)
+                ))
             );
         }
         {

src/schema/value.rs

@@ -137,6 +137,16 @@ impl Value {
         }
     }
 
+    /// Returns the path value, provided the value is of the `Facet` type.
+    /// (Returns None if the value is not of the `Facet` type).
+    pub fn path(&self) -> Option<String> {
+        if let Value::Facet(facet) = self {
+            Some(facet.to_path_string())
+        } else {
+            None
+        }
+    }
+
     /// Returns the tokenized text, provided the value is of the `PreTokStr` type.
     ///
     /// Returns None if the value is not of the `PreTokStr` type.

src/snippet/mod.rs

@@ -8,33 +8,17 @@ use htmlescape::encode_minimal;
 use std::cmp::Ordering;
 use std::collections::BTreeMap;
 use std::collections::BTreeSet;
+use std::ops::Range;
 
 const DEFAULT_MAX_NUM_CHARS: usize = 150;
 
-#[derive(Debug)]
-pub struct HighlightSection {
-    start: usize,
-    stop: usize,
-}
-
-impl HighlightSection {
-    fn new(start: usize, stop: usize) -> HighlightSection {
-        HighlightSection { start, stop }
-    }
-
-    /// Returns the bounds of the `HighlightSection`.
-    pub fn bounds(&self) -> (usize, usize) {
-        (self.start, self.stop)
-    }
-}
-
 #[derive(Debug)]
 pub struct FragmentCandidate {
     score: Score,
     start_offset: usize,
     stop_offset: usize,
     num_chars: usize,
-    highlighted: Vec<HighlightSection>,
+    highlighted: Vec<Range<usize>>,
 }
 
 impl FragmentCandidate {
@@ -63,8 +47,7 @@ impl FragmentCandidate {
 
         if let Some(&score) = terms.get(&token.text.to_lowercase()) {
             self.score += score;
-            self.highlighted
-                .push(HighlightSection::new(token.offset_from, token.offset_to));
+            self.highlighted.push(token.offset_from..token.offset_to);
         }
     }
 }
@@ -74,7 +57,7 @@ impl FragmentCandidate {
 #[derive(Debug)]
 pub struct Snippet {
     fragments: String,
-    highlighted: Vec<HighlightSection>,
+    highlighted: Vec<Range<usize>>,
 }
 
 const HIGHLIGHTEN_PREFIX: &str = "<b>";
@@ -97,9 +80,9 @@ impl Snippet {
         for item in self.highlighted.iter() {
             html.push_str(&encode_minimal(&self.fragments[start_from..item.start]));
             html.push_str(HIGHLIGHTEN_PREFIX);
-            html.push_str(&encode_minimal(&self.fragments[item.start..item.stop]));
+            html.push_str(&encode_minimal(&self.fragments[item.clone()]));
             html.push_str(HIGHLIGHTEN_POSTFIX);
-            start_from = item.stop;
+            start_from = item.end;
         }
         html.push_str(&encode_minimal(
             &self.fragments[start_from..self.fragments.len()],
@@ -113,7 +96,7 @@ impl Snippet {
     }
 
     /// Returns a list of higlighted positions from the `Snippet`.
-    pub fn highlighted(&self) -> &[HighlightSection] {
+    pub fn highlighted(&self) -> &[Range<usize>] {
         &self.highlighted
     }
 }
@@ -185,12 +168,7 @@ fn select_best_fragment_combination(fragments: &[FragmentCandidate], text: &str)
         let highlighted = fragment
             .highlighted
             .iter()
-            .map(|item| {
-                HighlightSection::new(
-                    item.start - fragment.start_offset,
-                    item.stop - fragment.start_offset,
-                )
-            })
+            .map(|item| item.start - fragment.start_offset..item.end - fragment.start_offset)
             .collect();
         Snippet {
             fragments: fragment_text.to_string(),

src/store/compression_lz4.rs

@@ -3,7 +3,7 @@ use std::io::{self, Read, Write};
 /// Name of the compression scheme used in the doc store.
 ///
 /// This name is appended to the version string of tantivy.
-pub const COMPRESSION: &'static str = "lz4";
+pub const COMPRESSION: &str = "lz4";
 
 pub fn compress(uncompressed: &[u8], compressed: &mut Vec<u8>) -> io::Result<()> {
     compressed.clear();

src/store/index/block.rs

@@ -2,6 +2,7 @@ use crate::common::VInt;
 use crate::store::index::{Checkpoint, CHECKPOINT_PERIOD};
 use crate::DocId;
 use std::io;
+use std::ops::Range;
 
 /// Represents a block of checkpoints.
 ///
@@ -24,25 +25,28 @@ impl Default for CheckpointBlock {
 impl CheckpointBlock {
     /// If non-empty returns [start_doc, end_doc)
     /// for the overall block.
-    pub fn doc_interval(&self) -> Option<(DocId, DocId)> {
+    pub fn doc_interval(&self) -> Option<Range<DocId>> {
         let start_doc_opt = self
             .checkpoints
             .first()
             .cloned()
-            .map(|checkpoint| checkpoint.start_doc);
+            .map(|checkpoint| checkpoint.doc_range.start);
         let end_doc_opt = self
             .checkpoints
             .last()
             .cloned()
-            .map(|checkpoint| checkpoint.end_doc);
+            .map(|checkpoint| checkpoint.doc_range.end);
         match (start_doc_opt, end_doc_opt) {
-            (Some(start_doc), Some(end_doc)) => Some((start_doc, end_doc)),
+            (Some(start_doc), Some(end_doc)) => Some(start_doc..end_doc),
             _ => None,
         }
     }
 
     /// Adding another checkpoint in the block.
     pub fn push(&mut self, checkpoint: Checkpoint) {
+        if let Some(prev_checkpoint) = self.checkpoints.last() {
+            assert!(checkpoint.follows(prev_checkpoint));
+        }
         self.checkpoints.push(checkpoint);
     }
 
@@ -52,7 +56,7 @@ impl CheckpointBlock {
     }
 
     pub fn get(&self, idx: usize) -> Checkpoint {
-        self.checkpoints[idx]
+        self.checkpoints[idx].clone()
     }
 
     pub fn clear(&mut self) {
@@ -64,12 +68,13 @@ impl CheckpointBlock {
         if self.checkpoints.is_empty() {
             return;
         }
-        VInt(self.checkpoints[0].start_doc as u64).serialize_into_vec(buffer);
-        VInt(self.checkpoints[0].start_offset as u64).serialize_into_vec(buffer);
+        VInt(self.checkpoints[0].doc_range.start as u64).serialize_into_vec(buffer);
+        VInt(self.checkpoints[0].byte_range.start as u64).serialize_into_vec(buffer);
         for checkpoint in &self.checkpoints {
-            let delta_doc = checkpoint.end_doc - checkpoint.start_doc;
+            let delta_doc = checkpoint.doc_range.end - checkpoint.doc_range.start;
             VInt(delta_doc as u64).serialize_into_vec(buffer);
-            VInt(checkpoint.end_offset - checkpoint.start_offset).serialize_into_vec(buffer);
+            VInt((checkpoint.byte_range.end - checkpoint.byte_range.start) as u64)
+                .serialize_into_vec(buffer);
         }
     }
 
@@ -83,15 +88,13 @@ impl CheckpointBlock {
             return Ok(());
         }
         let mut doc = VInt::deserialize_u64(data)? as DocId;
-        let mut start_offset = VInt::deserialize_u64(data)?;
+        let mut start_offset = VInt::deserialize_u64(data)? as usize;
         for _ in 0..len {
             let num_docs = VInt::deserialize_u64(data)? as DocId;
-            let block_num_bytes = VInt::deserialize_u64(data)?;
+            let block_num_bytes = VInt::deserialize_u64(data)? as usize;
             self.checkpoints.push(Checkpoint {
-                start_doc: doc,
-                end_doc: doc + num_docs,
-                start_offset,
-                end_offset: start_offset + block_num_bytes,
+                doc_range: doc..doc + num_docs,
+                byte_range: start_offset..start_offset + block_num_bytes,
             });
             doc += num_docs;
             start_offset += block_num_bytes;
@@ -109,17 +112,15 @@ mod tests {
 
     fn test_aux_ser_deser(checkpoints: &[Checkpoint]) -> io::Result<()> {
         let mut block = CheckpointBlock::default();
-        for &checkpoint in checkpoints {
-            block.push(checkpoint);
+        for checkpoint in checkpoints {
+            block.push(checkpoint.clone());
         }
         let mut buffer = Vec::new();
         block.serialize(&mut buffer);
         let mut block_deser = CheckpointBlock::default();
         let checkpoint = Checkpoint {
-            start_doc: 0,
-            end_doc: 1,
-            start_offset: 2,
-            end_offset: 3,
+            doc_range: 0..1,
+            byte_range: 2..3,
         };
         block_deser.push(checkpoint); // < check that value is erased before deser
         let mut data = &buffer[..];
@@ -137,26 +138,22 @@ mod tests {
     #[test]
     fn test_block_serialize_simple() -> io::Result<()> {
         let checkpoints = vec![Checkpoint {
-            start_doc: 10,
-            end_doc: 12,
-            start_offset: 100,
-            end_offset: 120,
+            doc_range: 10..12,
+            byte_range: 100..120,
         }];
         test_aux_ser_deser(&checkpoints)
     }
 
     #[test]
     fn test_block_serialize() -> io::Result<()> {
-        let offsets: Vec<u64> = (0..11).map(|i| i * i * i).collect();
+        let offsets: Vec<usize> = (0..11).map(|i| i * i * i).collect();
         let mut checkpoints = vec![];
         let mut start_doc = 0;
         for i in 0..10 {
             let end_doc = (i * i) as DocId;
             checkpoints.push(Checkpoint {
-                start_doc,
-                end_doc,
-                start_offset: offsets[i],
-                end_offset: offsets[i + 1],
+                doc_range: start_doc..end_doc,
+                byte_range: offsets[i]..offsets[i + 1],
             });
             start_doc = end_doc;
         }

src/store/index/mod.rs

@@ -1,6 +1,7 @@
 const CHECKPOINT_PERIOD: usize = 8;
 
 use std::fmt;
+use std::ops::Range;
 mod block;
 mod skip_index;
 mod skip_index_builder;
@@ -15,37 +16,40 @@ pub use self::skip_index_builder::SkipIndexBuilder;
 /// of checkpoints.
 ///
 /// All of the intervals here defined are semi-open.
-/// The checkpoint describes that the block within the bytes
-/// `[start_offset..end_offset)` spans over the docs
-/// `[start_doc..end_doc)`.
-#[derive(Clone, Copy, Eq, PartialEq)]
+/// The checkpoint describes that the block within the `byte_range`
+/// and spans over the `doc_range`.
+#[derive(Clone, Eq, PartialEq)]
 pub struct Checkpoint {
-    pub start_doc: DocId,
-    pub end_doc: DocId,
-    pub start_offset: u64,
-    pub end_offset: u64,
+    pub doc_range: Range<DocId>,
+    pub byte_range: Range<usize>,
+}
+
+impl Checkpoint {
+    pub(crate) fn follows(&self, other: &Checkpoint) -> bool {
+        (self.doc_range.start == other.doc_range.end)
+            && (self.byte_range.start == other.byte_range.end)
+    }
 }
 
 impl fmt::Debug for Checkpoint {
     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
-        write!(
-            f,
-            "(doc=[{}..{}), bytes=[{}..{}))",
-            self.start_doc, self.end_doc, self.start_offset, self.end_offset
-        )
+        write!(f, "(doc={:?}, bytes={:?})", self.doc_range, self.byte_range)
     }
 }
 
 #[cfg(test)]
 mod tests {
 
-    use std::io;
+    use std::{io, iter};
 
+    use futures::executor::block_on;
     use proptest::strategy::{BoxedStrategy, Strategy};
 
     use crate::directory::OwnedBytes;
+    use crate::indexer::NoMergePolicy;
+    use crate::schema::{SchemaBuilder, STORED, STRING};
     use crate::store::index::Checkpoint;
-    use crate::DocId;
+    use crate::{DocAddress, DocId, Index, Term};
 
     use super::{SkipIndex, SkipIndexBuilder};
 
@@ -54,7 +58,7 @@ mod tests {
         let mut output: Vec<u8> = Vec::new();
         let skip_index_builder: SkipIndexBuilder = SkipIndexBuilder::new();
         skip_index_builder.write(&mut output)?;
-        let skip_index: SkipIndex = SkipIndex::from(OwnedBytes::new(output));
+        let skip_index: SkipIndex = SkipIndex::open(OwnedBytes::new(output));
         let mut skip_cursor = skip_index.checkpoints();
         assert!(skip_cursor.next().is_none());
         Ok(())
@@ -65,14 +69,12 @@ mod tests {
         let mut output: Vec<u8> = Vec::new();
         let mut skip_index_builder: SkipIndexBuilder = SkipIndexBuilder::new();
         let checkpoint = Checkpoint {
-            start_doc: 0,
-            end_doc: 2,
-            start_offset: 0,
-            end_offset: 3,
+            doc_range: 0..2,
+            byte_range: 0..3,
         };
-        skip_index_builder.insert(checkpoint);
+        skip_index_builder.insert(checkpoint.clone());
         skip_index_builder.write(&mut output)?;
-        let skip_index: SkipIndex = SkipIndex::from(OwnedBytes::new(output));
+        let skip_index: SkipIndex = SkipIndex::open(OwnedBytes::new(output));
         let mut skip_cursor = skip_index.checkpoints();
         assert_eq!(skip_cursor.next(), Some(checkpoint));
         assert_eq!(skip_cursor.next(), None);
@@ -84,44 +86,34 @@ mod tests {
         let mut output: Vec<u8> = Vec::new();
         let checkpoints = vec![
             Checkpoint {
-                start_doc: 0,
-                end_doc: 3,
-                start_offset: 4,
-                end_offset: 9,
+                doc_range: 0..3,
+                byte_range: 0..9,
             },
             Checkpoint {
-                start_doc: 3,
-                end_doc: 4,
-                start_offset: 9,
-                end_offset: 25,
+                doc_range: 3..4,
+                byte_range: 9..25,
             },
             Checkpoint {
-                start_doc: 4,
-                end_doc: 6,
-                start_offset: 25,
-                end_offset: 49,
+                doc_range: 4..6,
+                byte_range: 25..49,
             },
             Checkpoint {
-                start_doc: 6,
-                end_doc: 8,
-                start_offset: 49,
-                end_offset: 81,
+                doc_range: 6..8,
+                byte_range: 49..81,
             },
             Checkpoint {
-                start_doc: 8,
-                end_doc: 10,
-                start_offset: 81,
-                end_offset: 100,
+                doc_range: 8..10,
+                byte_range: 81..100,
             },
         ];
 
         let mut skip_index_builder: SkipIndexBuilder = SkipIndexBuilder::new();
-        for &checkpoint in &checkpoints {
-            skip_index_builder.insert(checkpoint);
+        for checkpoint in &checkpoints {
+            skip_index_builder.insert(checkpoint.clone());
         }
         skip_index_builder.write(&mut output)?;
 
-        let skip_index: SkipIndex = SkipIndex::from(OwnedBytes::new(output));
+        let skip_index: SkipIndex = SkipIndex::open(OwnedBytes::new(output));
         assert_eq!(
             &skip_index.checkpoints().collect::<Vec<_>>()[..],
             &checkpoints[..]
@@ -129,8 +121,42 @@ mod tests {
         Ok(())
     }
 
-    fn offset_test(doc: DocId) -> u64 {
-        (doc as u64) * (doc as u64)
+    fn offset_test(doc: DocId) -> usize {
+        (doc as usize) * (doc as usize)
+    }
+
+    #[test]
+    fn test_merge_store_with_stacking_reproducing_issue969() -> crate::Result<()> {
+        let mut schema_builder = SchemaBuilder::default();
+        let text = schema_builder.add_text_field("text", STORED | STRING);
+        let body = schema_builder.add_text_field("body", STORED);
+        let schema = schema_builder.build();
+        let index = Index::create_in_ram(schema);
+        let mut index_writer = index.writer_for_tests()?;
+        index_writer.set_merge_policy(Box::new(NoMergePolicy));
+        let long_text: String = iter::repeat("abcdefghijklmnopqrstuvwxyz")
+            .take(1_000)
+            .collect();
+        for _ in 0..20 {
+            index_writer.add_document(doc!(body=>long_text.clone()));
+        }
+        index_writer.commit()?;
+        index_writer.add_document(doc!(text=>"testb"));
+        for _ in 0..10 {
+            index_writer.add_document(doc!(text=>"testd", body=>long_text.clone()));
+        }
+        index_writer.commit()?;
+        index_writer.delete_term(Term::from_field_text(text, "testb"));
+        index_writer.commit()?;
+        let segment_ids = index.searchable_segment_ids()?;
+        block_on(index_writer.merge(&segment_ids))?;
+        let reader = index.reader()?;
+        let searcher = reader.searcher();
+        assert_eq!(searcher.num_docs(), 30);
+        for i in 0..searcher.num_docs() as u32 {
+            let _doc = searcher.doc(DocAddress(0u32, i))?;
+        }
+        Ok(())
     }
 
     #[test]
@@ -138,50 +164,48 @@ mod tests {
         let mut output: Vec<u8> = Vec::new();
         let checkpoints: Vec<Checkpoint> = (0..1000)
             .map(|i| Checkpoint {
-                start_doc: i,
-                end_doc: i + 1,
-                start_offset: offset_test(i),
-                end_offset: offset_test(i + 1),
+                doc_range: i..(i + 1),
+                byte_range: offset_test(i)..offset_test(i + 1),
             })
             .collect();
         let mut skip_index_builder = SkipIndexBuilder::new();
         for checkpoint in &checkpoints {
-            skip_index_builder.insert(*checkpoint);
+            skip_index_builder.insert(checkpoint.clone());
         }
         skip_index_builder.write(&mut output)?;
         assert_eq!(output.len(), 4035);
-        let resulting_checkpoints: Vec<Checkpoint> = SkipIndex::from(OwnedBytes::new(output))
+        let resulting_checkpoints: Vec<Checkpoint> = SkipIndex::open(OwnedBytes::new(output))
             .checkpoints()
             .collect();
         assert_eq!(&resulting_checkpoints, &checkpoints);
         Ok(())
     }
 
-    fn integrate_delta(mut vals: Vec<u64>) -> Vec<u64> {
-        let mut prev = 0u64;
-        for val in vals.iter_mut() {
-            let new_val = *val + prev;
+    fn integrate_delta(vals: Vec<usize>) -> Vec<usize> {
+        let mut output = Vec::with_capacity(vals.len() + 1);
+        output.push(0);
+        let mut prev = 0;
+        for val in vals {
+            let new_val = val + prev;
             prev = new_val;
-            *val = new_val;
+            output.push(new_val);
         }
-        vals
+        output
     }
 
     // Generates a sequence of n valid checkpoints, with n < max_len.
     fn monotonic_checkpoints(max_len: usize) -> BoxedStrategy<Vec<Checkpoint>> {
-        (1..max_len)
+        (0..max_len)
             .prop_flat_map(move |len: usize| {
                 (
-                    proptest::collection::vec(1u64..20u64, len as usize).prop_map(integrate_delta),
-                    proptest::collection::vec(1u64..26u64, len as usize).prop_map(integrate_delta),
+                    proptest::collection::vec(1usize..20, len as usize).prop_map(integrate_delta),
+                    proptest::collection::vec(1usize..26, len as usize).prop_map(integrate_delta),
                 )
                     .prop_map(|(docs, offsets)| {
                         (0..docs.len() - 1)
                             .map(move |i| Checkpoint {
-                                start_doc: docs[i] as DocId,
-                                end_doc: docs[i + 1] as DocId,
-                                start_offset: offsets[i],
-                                end_offset: offsets[i + 1],
+                                doc_range: docs[i] as DocId..docs[i + 1] as DocId,
+                                byte_range: offsets[i]..offsets[i + 1],
                             })
                             .collect::<Vec<Checkpoint>>()
                     })
@@ -195,17 +219,17 @@ mod tests {
     ) -> Option<Checkpoint> {
         checkpoints
             .into_iter()
-            .filter(|checkpoint| checkpoint.end_doc > target)
+            .filter(|checkpoint| checkpoint.doc_range.end > target)
             .next()
     }
 
     fn test_skip_index_aux(skip_index: SkipIndex, checkpoints: &[Checkpoint]) {
         if let Some(last_checkpoint) = checkpoints.last() {
-            for doc in 0u32..last_checkpoint.end_doc {
+            for doc in 0u32..last_checkpoint.doc_range.end {
                 let expected = seek_manual(skip_index.checkpoints(), doc);
                 assert_eq!(expected, skip_index.seek(doc), "Doc {}", doc);
             }
-            assert!(skip_index.seek(last_checkpoint.end_doc).is_none());
+            assert!(skip_index.seek(last_checkpoint.doc_range.end).is_none());
         }
     }
 
@@ -221,7 +245,7 @@ mod tests {
              }
              let mut buffer = Vec::new();
              skip_index_builder.write(&mut buffer).unwrap();
-             let skip_index = SkipIndex::from(OwnedBytes::new(buffer));
+             let skip_index = SkipIndex::open(OwnedBytes::new(buffer));
              let iter_checkpoints: Vec<Checkpoint> = skip_index.checkpoints().collect();
              assert_eq!(&checkpoints[..], &iter_checkpoints[..]);
              test_skip_index_aux(skip_index, &checkpoints[..]);

src/store/index/skip_index.rs

@@ -35,22 +35,22 @@ struct Layer {
 }
 
 impl Layer {
-    fn cursor<'a>(&'a self) -> impl Iterator<Item = Checkpoint> + 'a {
-        self.cursor_at_offset(0u64)
+    fn cursor(&self) -> impl Iterator<Item = Checkpoint> + '_ {
+        self.cursor_at_offset(0)
     }
 
-    fn cursor_at_offset<'a>(&'a self, start_offset: u64) -> impl Iterator<Item = Checkpoint> + 'a {
+    fn cursor_at_offset(&self, start_offset: usize) -> impl Iterator<Item = Checkpoint> + '_ {
         let data = &self.data.as_slice();
         LayerCursor {
-            remaining: &data[start_offset as usize..],
+            remaining: &data[start_offset..],
             block: CheckpointBlock::default(),
             cursor: 0,
         }
     }
 
-    fn seek_start_at_offset(&self, target: DocId, offset: u64) -> Option<Checkpoint> {
+    fn seek_start_at_offset(&self, target: DocId, offset: usize) -> Option<Checkpoint> {
         self.cursor_at_offset(offset)
-            .find(|checkpoint| checkpoint.end_doc > target)
+            .find(|checkpoint| checkpoint.doc_range.end > target)
     }
 }
 
@@ -59,7 +59,25 @@ pub struct SkipIndex {
 }
 
 impl SkipIndex {
-    pub(crate) fn checkpoints<'a>(&'a self) -> impl Iterator<Item = Checkpoint> + 'a {
+    pub fn open(mut data: OwnedBytes) -> SkipIndex {
+        let offsets: Vec<u64> = Vec::<VInt>::deserialize(&mut data)
+            .unwrap()
+            .into_iter()
+            .map(|el| el.0)
+            .collect();
+        let mut start_offset = 0;
+        let mut layers = Vec::new();
+        for end_offset in offsets {
+            let layer = Layer {
+                data: data.slice(start_offset as usize..end_offset as usize),
+            };
+            layers.push(layer);
+            start_offset = end_offset;
+        }
+        SkipIndex { layers }
+    }
+
+    pub(crate) fn checkpoints(&self) -> impl Iterator<Item = Checkpoint> + '_ {
         self.layers
             .last()
             .into_iter()
@@ -70,17 +88,15 @@ impl SkipIndex {
         let first_layer_len = self
             .layers
             .first()
-            .map(|layer| layer.data.len() as u64)
-            .unwrap_or(0u64);
+            .map(|layer| layer.data.len())
+            .unwrap_or(0);
         let mut cur_checkpoint = Checkpoint {
-            start_doc: 0u32,
-            end_doc: 1u32,
-            start_offset: 0u64,
-            end_offset: first_layer_len,
+            doc_range: 0u32..1u32,
+            byte_range: 0..first_layer_len,
         };
         for layer in &self.layers {
             if let Some(checkpoint) =
-                layer.seek_start_at_offset(target, cur_checkpoint.start_offset)
+                layer.seek_start_at_offset(target, cur_checkpoint.byte_range.start)
             {
                 cur_checkpoint = checkpoint;
             } else {
@@ -90,22 +106,3 @@ impl SkipIndex {
         Some(cur_checkpoint)
     }
 }
-
-impl From<OwnedBytes> for SkipIndex {
-    fn from(mut data: OwnedBytes) -> SkipIndex {
-        let offsets: Vec<u64> = Vec::<VInt>::deserialize(&mut data)
-            .unwrap()
-            .into_iter()
-            .map(|el| el.0)
-            .collect();
-        let mut start_offset = 0;
-        let mut layers = Vec::new();
-        for end_offset in offsets {
-            layers.push(Layer {
-                data: data.slice(start_offset as usize, end_offset as usize),
-            });
-            start_offset = end_offset;
-        }
-        SkipIndex { layers }
-    }
-}

src/store/index/skip_index_builder.rs

@@ -28,18 +28,18 @@ impl LayerBuilder {
     ///
     /// If the block was empty to begin with, simply return None.
     fn flush_block(&mut self) -> Option<Checkpoint> {
-        self.block.doc_interval().map(|(start_doc, end_doc)| {
-            let start_offset = self.buffer.len() as u64;
+        if let Some(doc_range) = self.block.doc_interval() {
+            let start_offset = self.buffer.len();
             self.block.serialize(&mut self.buffer);
-            let end_offset = self.buffer.len() as u64;
+            let end_offset = self.buffer.len();
             self.block.clear();
-            Checkpoint {
-                start_doc,
-                end_doc,
-                start_offset,
-                end_offset,
-            }
-        })
+            Some(Checkpoint {
+                doc_range,
+                byte_range: start_offset..end_offset,
+            })
+        } else {
+            None
+        }
     }
 
     fn push(&mut self, checkpoint: Checkpoint) {
@@ -48,7 +48,7 @@ impl LayerBuilder {
 
     fn insert(&mut self, checkpoint: Checkpoint) -> Option<Checkpoint> {
         self.push(checkpoint);
-        let emit_skip_info = (self.block.len() % CHECKPOINT_PERIOD) == 0;
+        let emit_skip_info = self.block.len() >= CHECKPOINT_PERIOD;
         if emit_skip_info {
             self.flush_block()
         } else {

src/store/reader.rs

@@ -17,7 +17,7 @@ const LRU_CACHE_CAPACITY: usize = 100;
 
 type Block = Arc<Vec<u8>>;
 
-type BlockCache = Arc<Mutex<LruCache<u64, Block>>>;
+type BlockCache = Arc<Mutex<LruCache<usize, Block>>>;
 
 /// Reads document off tantivy's [`Store`](./index.html)
 pub struct StoreReader {
@@ -35,7 +35,7 @@ impl StoreReader {
         let (data_file, offset_index_file) = split_file(store_file)?;
         let index_data = offset_index_file.read_bytes()?;
         let space_usage = StoreSpaceUsage::new(data_file.len(), offset_index_file.len());
-        let skip_index = SkipIndex::from(index_data);
+        let skip_index = SkipIndex::open(index_data);
         Ok(StoreReader {
             data: data_file,
             cache: Arc::new(Mutex::new(LruCache::new(LRU_CACHE_CAPACITY))),
@@ -46,7 +46,7 @@ impl StoreReader {
         })
     }
 
-    pub(crate) fn block_checkpoints<'a>(&'a self) -> impl Iterator<Item = Checkpoint> + 'a {
+    pub(crate) fn block_checkpoints(&self) -> impl Iterator<Item = Checkpoint> + '_ {
         self.skip_index.checkpoints()
     }
 
@@ -59,16 +59,11 @@ impl StoreReader {
     }
 
     fn compressed_block(&self, checkpoint: &Checkpoint) -> io::Result<OwnedBytes> {
-        self.data
-            .slice(
-                checkpoint.start_offset as usize,
-                checkpoint.end_offset as usize,
-            )
-            .read_bytes()
+        self.data.slice(checkpoint.byte_range.clone()).read_bytes()
     }
 
     fn read_block(&self, checkpoint: &Checkpoint) -> io::Result<Block> {
-        if let Some(block) = self.cache.lock().unwrap().get(&checkpoint.start_offset) {
+        if let Some(block) = self.cache.lock().unwrap().get(&checkpoint.byte_range.start) {
             self.cache_hits.fetch_add(1, Ordering::SeqCst);
             return Ok(block.clone());
         }
@@ -83,7 +78,7 @@ impl StoreReader {
         self.cache
             .lock()
             .unwrap()
-            .put(checkpoint.start_offset, block.clone());
+            .put(checkpoint.byte_range.start, block.clone());
 
         Ok(block)
     }
@@ -100,7 +95,7 @@ impl StoreReader {
             crate::TantivyError::InvalidArgument(format!("Failed to lookup Doc #{}.", doc_id))
         })?;
         let mut cursor = &self.read_block(&checkpoint)?[..];
-        for _ in checkpoint.start_doc..doc_id {
+        for _ in checkpoint.doc_range.start..doc_id {
             let doc_length = VInt::deserialize(&mut cursor)?.val() as usize;
             cursor = &cursor[doc_length..];
         }

src/store/writer.rs

@@ -72,8 +72,9 @@ impl StoreWriter {
         if !self.current_block.is_empty() {
             self.write_and_compress_block()?;
         }
+        assert_eq!(self.first_doc_in_block, self.doc);
         let doc_shift = self.doc;
-        let start_shift = self.writer.written_bytes() as u64;
+        let start_shift = self.writer.written_bytes() as usize;
 
         // just bulk write all of the block of the given reader.
         self.writer
@@ -82,32 +83,34 @@ impl StoreWriter {
         // concatenate the index of the `store_reader`, after translating
         // its start doc id and its start file offset.
         for mut checkpoint in store_reader.block_checkpoints() {
-            checkpoint.start_doc += doc_shift;
-            checkpoint.end_doc += doc_shift;
-            checkpoint.start_offset += start_shift;
-            checkpoint.end_offset += start_shift;
-            self.offset_index_writer.insert(checkpoint);
-            self.doc = checkpoint.end_doc;
+            checkpoint.doc_range.start += doc_shift;
+            checkpoint.doc_range.end += doc_shift;
+            checkpoint.byte_range.start += start_shift;
+            checkpoint.byte_range.end += start_shift;
+            self.register_checkpoint(checkpoint);
         }
         Ok(())
     }
 
+    fn register_checkpoint(&mut self, checkpoint: Checkpoint) {
+        self.offset_index_writer.insert(checkpoint.clone());
+        self.first_doc_in_block = checkpoint.doc_range.end;
+        self.doc = checkpoint.doc_range.end;
+    }
+
     fn write_and_compress_block(&mut self) -> io::Result<()> {
         assert!(self.doc > 0);
         self.intermediary_buffer.clear();
         compress(&self.current_block[..], &mut self.intermediary_buffer)?;
-        let start_offset = self.writer.written_bytes();
+        let start_offset = self.writer.written_bytes() as usize;
         self.writer.write_all(&self.intermediary_buffer)?;
-        let end_offset = self.writer.written_bytes();
+        let end_offset = self.writer.written_bytes() as usize;
         let end_doc = self.doc;
-        self.offset_index_writer.insert(Checkpoint {
-            start_doc: self.first_doc_in_block,
-            end_doc,
-            start_offset,
-            end_offset,
+        self.register_checkpoint(Checkpoint {
+            doc_range: self.first_doc_in_block..end_doc,
+            byte_range: start_offset..end_offset,
         });
         self.current_block.clear();
-        self.first_doc_in_block = self.doc;
         Ok(())
     }
 

src/termdict/fst_termdict/term_info_store.rs

@@ -68,18 +68,17 @@ impl TermInfoBlockMeta {
         let doc_freq_addr = posting_start_addr + self.postings_offset_nbits as usize;
         let positions_idx_addr = doc_freq_addr + self.doc_freq_nbits as usize;
 
-        let postings_start_offset = self.ref_term_info.postings_start_offset
-            + extract_bits(data, posting_start_addr, self.postings_offset_nbits);
-        let postings_stop_offset = self.ref_term_info.postings_start_offset
-            + extract_bits(data, posting_stop_addr, self.postings_offset_nbits);
+        let postings_start_offset = self.ref_term_info.postings_range.start
+            + extract_bits(data, posting_start_addr, self.postings_offset_nbits) as usize;
+        let postings_end_offset = self.ref_term_info.postings_range.start
+            + extract_bits(data, posting_stop_addr, self.postings_offset_nbits) as usize;
         let doc_freq = extract_bits(data, doc_freq_addr, self.doc_freq_nbits) as u32;
         let positions_idx = self.ref_term_info.positions_idx
             + extract_bits(data, positions_idx_addr, self.positions_idx_nbits);
 
         TermInfo {
             doc_freq,
-            postings_start_offset,
-            postings_stop_offset,
+            postings_range: postings_start_offset..postings_end_offset,
             positions_idx,
         }
     }
@@ -163,7 +162,7 @@ fn bitpack_serialize<W: Write>(
     term_info: &TermInfo,
 ) -> io::Result<()> {
     bit_packer.write(
-        term_info.postings_start_offset,
+        term_info.postings_range.start as u64,
         term_info_block_meta.postings_offset_nbits,
         write,
     )?;
@@ -200,15 +199,15 @@ impl TermInfoStoreWriter {
         } else {
             return Ok(());
         };
-        let postings_stop_offset =
-            last_term_info.postings_stop_offset - ref_term_info.postings_start_offset;
+        let postings_end_offset =
+            last_term_info.postings_range.end - ref_term_info.postings_range.start;
         for term_info in &mut self.term_infos[1..] {
-            term_info.postings_start_offset -= ref_term_info.postings_start_offset;
+            term_info.postings_range.start -= ref_term_info.postings_range.start;
             term_info.positions_idx -= ref_term_info.positions_idx;
         }
 
         let mut max_doc_freq: u32 = 0u32;
-        let max_postings_offset: u64 = postings_stop_offset;
+        let max_postings_offset: usize = postings_end_offset;
         let max_positions_idx: u64 = last_term_info.positions_idx;
 
         for term_info in &self.term_infos[1..] {
@@ -216,7 +215,7 @@ impl TermInfoStoreWriter {
         }
 
         let max_doc_freq_nbits: u8 = compute_num_bits(u64::from(max_doc_freq));
-        let max_postings_offset_nbits = compute_num_bits(max_postings_offset);
+        let max_postings_offset_nbits = compute_num_bits(max_postings_offset as u64);
         let max_positions_idx_nbits = compute_num_bits(max_positions_idx);
 
         let term_info_block_meta = TermInfoBlockMeta {
@@ -238,7 +237,7 @@ impl TermInfoStoreWriter {
         }
 
         bit_packer.write(
-            postings_stop_offset,
+            postings_end_offset as u64,
             term_info_block_meta.postings_offset_nbits,
             &mut self.buffer_term_infos,
         )?;
@@ -251,7 +250,6 @@ impl TermInfoStoreWriter {
     }
 
     pub fn write_term_info(&mut self, term_info: &TermInfo) -> io::Result<()> {
-        assert!(term_info.postings_stop_offset >= term_info.postings_start_offset);
         self.num_terms += 1u64;
         self.term_infos.push(term_info.clone());
         if self.term_infos.len() >= BLOCK_LEN {
@@ -314,8 +312,7 @@ mod tests {
             offset: 2009u64,
             ref_term_info: TermInfo {
                 doc_freq: 512,
-                postings_start_offset: 51,
-                postings_stop_offset: 57u64,
+                postings_range: 51..57,
                 positions_idx: 3584,
             },
             doc_freq_nbits: 10,
@@ -333,12 +330,11 @@ mod tests {
     fn test_pack() -> crate::Result<()> {
         let mut store_writer = TermInfoStoreWriter::new();
         let mut term_infos = vec![];
-        let offset = |i| (i * 13 + i * i) as u64;
-        for i in 0..1000 {
+        let offset = |i| (i * 13 + i * i);
+        for i in 0usize..1000usize {
             let term_info = TermInfo {
                 doc_freq: i as u32,
-                postings_start_offset: offset(i),
-                postings_stop_offset: offset(i + 1),
+                postings_range: offset(i)..offset(i + 1),
                 positions_idx: (i * 7) as u64,
             };
             store_writer.write_term_info(&term_info)?;

src/termdict/fst_termdict/termdict.rs

@@ -80,7 +80,6 @@ where
                 .serialize(&mut counting_writer)?;
             let footer_size = counting_writer.written_bytes();
             (footer_size as u64).serialize(&mut counting_writer)?;
-            counting_writer.flush()?;
         }
         Ok(file)
     }
@@ -152,7 +151,7 @@ impl TermDictionary {
     ///
     /// Regardless of whether the term is found or not,
     /// the buffer may be modified.
-    pub fn ord_to_term(&self, mut ord: TermOrdinal, bytes: &mut Vec<u8>) -> bool {
+    pub fn ord_to_term(&self, mut ord: TermOrdinal, bytes: &mut Vec<u8>) -> io::Result<bool> {
         bytes.clear();
         let fst = self.fst_index.as_fst();
         let mut node = fst.root();
@@ -167,10 +166,10 @@ impl TermDictionary {
                 let new_node_addr = transition.addr;
                 node = fst.node(new_node_addr);
             } else {
-                return false;
+                return Ok(false);
             }
         }
-        true
+        Ok(true)
     }
 
     /// Returns the number of terms in the dictionary.

src/termdict/tests.rs

@@ -9,12 +9,11 @@ use std::str;
 const BLOCK_SIZE: usize = 1_500;
 
 fn make_term_info(term_ord: u64) -> TermInfo {
-    let offset = |term_ord: u64| term_ord * 100 + term_ord * term_ord;
+    let offset = |term_ord: u64| (term_ord * 100 + term_ord * term_ord) as usize;
     TermInfo {
         doc_freq: term_ord as u32,
-        postings_start_offset: offset(term_ord),
-        postings_stop_offset: offset(term_ord + 1),
-        positions_idx: offset(term_ord) * 2u64,
+        postings_range: offset(term_ord)..offset(term_ord + 1),
+        positions_idx: offset(term_ord) as u64 * 2u64,
     }
 }
 
@@ -50,7 +49,7 @@ fn test_term_ordinals() -> crate::Result<()> {
     for (term_ord, term) in COUNTRIES.iter().enumerate() {
         assert_eq!(term_dict.term_ord(term)?, Some(term_ord as u64));
         let mut bytes = vec![];
-        assert!(term_dict.ord_to_term(term_ord as u64, &mut bytes));
+        assert!(term_dict.ord_to_term(term_ord as u64, &mut bytes)?);
         assert_eq!(bytes, term.as_bytes());
     }
     Ok(())
@@ -249,8 +248,7 @@ fn test_empty_string() -> crate::Result<()> {
     Ok(())
 }
 
-#[test]
-fn test_stream_range_boundaries() -> crate::Result<()> {
+fn stream_range_test_dict() -> crate::Result<TermDictionary> {
     let buffer: Vec<u8> = {
         let mut term_dictionary_builder = TermDictionaryBuilder::create(Vec::new())?;
         for i in 0u8..10u8 {
@@ -260,84 +258,96 @@ fn test_stream_range_boundaries() -> crate::Result<()> {
         term_dictionary_builder.finish()?
     };
     let file = FileSlice::from(buffer);
-    let term_dictionary: TermDictionary = TermDictionary::open(file)?;
+    TermDictionary::open(file)
+}
 
-    let value_list = |mut streamer: TermStreamer<'_>, backwards: bool| {
+#[test]
+fn test_stream_range_boundaries_forward() -> crate::Result<()> {
+    let term_dictionary = stream_range_test_dict()?;
+    let value_list = |mut streamer: TermStreamer<'_>| {
         let mut res: Vec<u32> = vec![];
         while let Some((_, ref v)) = streamer.next() {
             res.push(v.doc_freq);
         }
-        if backwards {
-            res.reverse();
-        }
         res
     };
-    {
-        let range = term_dictionary.range().backward().into_stream()?;
-        assert_eq!(
-            value_list(range, true),
-            vec![0u32, 1u32, 2u32, 3u32, 4u32, 5u32, 6u32, 7u32, 8u32, 9u32]
-        );
-    }
     {
         let range = term_dictionary.range().ge([2u8]).into_stream()?;
         assert_eq!(
-            value_list(range, false),
-            vec![2u32, 3u32, 4u32, 5u32, 6u32, 7u32, 8u32, 9u32]
-        );
-    }
-    {
-        let range = term_dictionary.range().ge([2u8]).backward().into_stream()?;
-        assert_eq!(
-            value_list(range, true),
+            value_list(range),
             vec![2u32, 3u32, 4u32, 5u32, 6u32, 7u32, 8u32, 9u32]
         );
     }
     {
         let range = term_dictionary.range().gt([2u8]).into_stream()?;
         assert_eq!(
-            value_list(range, false),
-            vec![3u32, 4u32, 5u32, 6u32, 7u32, 8u32, 9u32]
-        );
-    }
-    {
-        let range = term_dictionary.range().gt([2u8]).backward().into_stream()?;
-        assert_eq!(
-            value_list(range, true),
+            value_list(range),
             vec![3u32, 4u32, 5u32, 6u32, 7u32, 8u32, 9u32]
         );
     }
     {
         let range = term_dictionary.range().lt([6u8]).into_stream()?;
-        assert_eq!(
-            value_list(range, false),
-            vec![0u32, 1u32, 2u32, 3u32, 4u32, 5u32]
-        );
-    }
-    {
-        let range = term_dictionary.range().lt([6u8]).backward().into_stream()?;
-        assert_eq!(
-            value_list(range, true),
-            vec![0u32, 1u32, 2u32, 3u32, 4u32, 5u32]
-        );
+        assert_eq!(value_list(range), vec![0u32, 1u32, 2u32, 3u32, 4u32, 5u32]);
     }
     {
         let range = term_dictionary.range().le([6u8]).into_stream()?;
         assert_eq!(
-            value_list(range, false),
-            vec![0u32, 1u32, 2u32, 3u32, 4u32, 5u32, 6u32]
-        );
-    }
-    {
-        let range = term_dictionary.range().le([6u8]).backward().into_stream()?;
-        assert_eq!(
-            value_list(range, true),
+            value_list(range),
             vec![0u32, 1u32, 2u32, 3u32, 4u32, 5u32, 6u32]
         );
     }
     {
         let range = term_dictionary.range().ge([0u8]).lt([5u8]).into_stream()?;
-        assert_eq!(value_list(range, false), vec![0u32, 1u32, 2u32, 3u32, 4u32]);
+        assert_eq!(value_list(range), vec![0u32, 1u32, 2u32, 3u32, 4u32]);
+    }
+    Ok(())
+}
+
+#[test]
+fn test_stream_range_boundaries_backward() -> crate::Result<()> {
+    let term_dictionary = stream_range_test_dict()?;
+    let value_list_backward = |mut streamer: TermStreamer<'_>| {
+        let mut res: Vec<u32> = vec![];
+        while let Some((_, ref v)) = streamer.next() {
+            res.push(v.doc_freq);
+        }
+        res.reverse();
+        res
+    };
+    {
+        let range = term_dictionary.range().backward().into_stream()?;
+        assert_eq!(
+            value_list_backward(range),
+            vec![0u32, 1u32, 2u32, 3u32, 4u32, 5u32, 6u32, 7u32, 8u32, 9u32]
+        );
+    }
+    {
+        let range = term_dictionary.range().ge([2u8]).backward().into_stream()?;
+        assert_eq!(
+            value_list_backward(range),
+            vec![2u32, 3u32, 4u32, 5u32, 6u32, 7u32, 8u32, 9u32]
+        );
+    }
+    {
+        let range = term_dictionary.range().gt([2u8]).backward().into_stream()?;
+        assert_eq!(
+            value_list_backward(range),
+            vec![3u32, 4u32, 5u32, 6u32, 7u32, 8u32, 9u32]
+        );
+    }
+    {
+        let range = term_dictionary.range().lt([6u8]).backward().into_stream()?;
+        assert_eq!(
+            value_list_backward(range),
+            vec![0u32, 1u32, 2u32, 3u32, 4u32, 5u32]
+        );
+    }
+    {
+        let range = term_dictionary.range().le([6u8]).backward().into_stream()?;
+        assert_eq!(
+            value_list_backward(range),
+            vec![0u32, 1u32, 2u32, 3u32, 4u32, 5u32, 6u32]
+        );
     }
     {
         let range = term_dictionary
@@ -346,11 +356,38 @@ fn test_stream_range_boundaries() -> crate::Result<()> {
             .lt([5u8])
             .backward()
             .into_stream()?;
-        assert_eq!(value_list(range, true), vec![0u32, 1u32, 2u32, 3u32, 4u32]);
+        assert_eq!(
+            value_list_backward(range),
+            vec![0u32, 1u32, 2u32, 3u32, 4u32]
+        );
     }
     Ok(())
 }
 
+#[test]
+fn test_ord_to_term() -> crate::Result<()> {
+    let termdict = stream_range_test_dict()?;
+    let mut bytes = vec![];
+    for b in 0u8..10u8 {
+        termdict.ord_to_term(b as u64, &mut bytes)?;
+        assert_eq!(&bytes, &[b]);
+    }
+    Ok(())
+}
+
+#[test]
+fn test_stream_term_ord() -> crate::Result<()> {
+    let termdict = stream_range_test_dict()?;
+    let mut stream = termdict.stream()?;
+    for b in 0u8..10u8 {
+        assert!(stream.advance(), true);
+        assert_eq!(stream.term_ord(), b as u64);
+        assert_eq!(stream.key(), &[b]);
+    }
+    assert!(!stream.advance());
+    Ok(())
+}
+
 #[test]
 fn test_automaton_search() -> crate::Result<()> {
     use crate::query::DFAWrapper;