Update CHANGELOG with date range queries

Closing #933

.github/ISSUE_TEMPLATE/actions.md

@@ -0,0 +1,13 @@
+---
+name: Actions
+about: Actions not directly related to producing code.
+
+---
+
+# Actions title
+
+Action description. 
+e.g. 
+- benchmark
+- investigate and report
+- etc.

.gitignore

@@ -1,4 +1,5 @@
 tantivy.iml
+proptest-regressions
 *.swp
 target
 target/debug
@@ -11,3 +12,4 @@ cpp/simdcomp/bitpackingbenchmark
 *.bk
 .idea
 trace.dat
+cargo-timing*

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,16 +1,82 @@
+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)
+- DocAddress is now a struct (@scampi) #987
+- Bugfix consistent tie break handling in facet's topk (@hardikpnsp) #357
+- Date field support for range queries (@rihardsk) #516
+
+Tantivy 0.14.0
+=========================
+- 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.
+- 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
+doc with this facet returns `None`. (#896)
+
+Tantivy 0.13.1
+===================
+Made `Query` and `Collector` `Send + Sync`.
+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).
+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
+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).
+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
+```rust
+let mut doc = docset.doc();
+while doc != TERMINATED {
+   // ...
+   doc = docset.advance();
+}
+```
+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
+to the PISA team for answering all my questions!)
+
 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
@@ -46,7 +112,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.
@@ -70,26 +136,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
@@ -103,7 +169,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.
@@ -112,16 +178,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)
@@ -135,26 +201,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()?`.
-  
+
     ```
 
 
@@ -169,7 +235,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.
 
 
@@ -177,7 +243,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
@@ -205,7 +271,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
 ==========================
@@ -213,10 +279,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.
@@ -224,7 +290,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.12.0"
+version = "0.14.0"
 authors = ["Paul Masurel <paul.masurel@gmail.com>"]
 license = "MIT"
 categories = ["database-implementations", "data-structures"]
@@ -13,54 +13,55 @@ keywords = ["search", "information", "retrieval"]
 edition = "2018"
 
 [dependencies]
-base64 = "0.12.0"
-byteorder = "1.0"
-crc32fast = "1.2.0"
-once_cell = "1.0"
-regex ={version = "1.3.0", default-features = false, features = ["std"]}
-tantivy-fst = "0.2.1"
+base64 = "0.13"
+byteorder = "1"
+crc32fast = "1"
+once_cell = "1"
+regex ={version = "1", default-features = false, features = ["std"]}
+tantivy-fst = "0.3"
 memmap = {version = "0.7", optional=true}
-lz4 = {version="1.20", optional=true}
+lz4 = {version="1", optional=true}
+brotli = {version="3.3.0", optional=true}
 snap = "1"
-atomicwrites = {version="0.2.2", optional=true}
-tempfile = "3.0"
+tempfile = {version="3", optional=true}
 log = "0.4"
-serde = {version="1.0", features=["derive"]}
-serde_json = "1.0"
-num_cpus = "1.2"
+serde = {version="1", features=["derive"]}
+serde_json = "1"
+num_cpus = "1"
 fs2={version="0.4", optional=true}
-levenshtein_automata = "0.1"
-notify = {version="4", optional=true}
+levenshtein_automata = "0.2"
 uuid = { version = "0.8", features = ["v4", "serde"] }
-crossbeam = "0.7"
+crossbeam = "0.8"
 futures = {version = "0.3",  features=["thread-pool"] }
-owning_ref = "0.4"
-stable_deref_trait = "1.0.0"
-rust-stemmers = "1.2"
-downcast-rs = { version="1.0" }
-tantivy-query-grammar = { version="0.12", path="./query-grammar" }
+tantivy-query-grammar = { version="0.14.0", path="./query-grammar" }
+stable_deref_trait = "1"
+rust-stemmers = "1"
+downcast-rs = "1"
 bitpacking = {version="0.8", default-features = false, features=["bitpacker4x"]}
-census =  {path="../census"}
-fnv = "1.0.6"
-owned-read = "0.4"
-failure = "0.1"
-htmlescape = "0.3.1"
-fail = "0.3"
+census = "0.4"
+fnv = "1"
+thiserror = "1.0"
+htmlescape = "0.3"
+fail = "0.4"
 murmurhash32 = "0.2"
 chrono = "0.4"
-smallvec = "1.0"
+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 = "1.0"
+criterion = "0.3"
 
 [dev-dependencies.fail]
-version = "0.3"
+version = "0.4"
 features = ["failpoints"]
 
 [profile.release]
@@ -74,7 +75,8 @@ overflow-checks = true
 
 [features]
 default = ["mmap"]
-mmap = ["atomicwrites", "fs2", "memmap", "notify"]
+mmap = ["fs2", "tempfile", "memmap"]
+brotli-compression = ["brotli"]
 lz4-compression = ["lz4"]
 failpoints = ["fail/failpoints"]
 unstable = [] # useful for benches.
@@ -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,11 +1,10 @@
 
-[![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)
-[![Say Thanks!](https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg)](https://saythanks.io/to/fulmicoton)
 
 ![Tantivy](https://tantivy-search.github.io/logo/tantivy-logo.png)
 
@@ -31,12 +30,11 @@ Tantivy is, in fact, strongly inspired by Lucene's design.
 
 # Benchmark
 
-Tantivy is typically faster than Lucene, but the results depend on 
-the nature of the queries in your workload.
-
 The following [benchmark](https://tantivy-search.github.io/bench/) break downs 
 performance for different type of queries / collection.
 
+Your mileage WILL vary depending on the nature of queries and their load.
+
 # Features
 
 - Full-text search
@@ -86,7 +84,7 @@ There are many ways to support this project.
 - Help with documentation by asking questions or submitting PRs
 - Contribute code (you can join [our Gitter](https://gitter.im/tantivy-search/tantivy))
 - Talk about Tantivy around you
-- Drop a word on on [![Say Thanks!](https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg)](https://saythanks.io/to/fulmicoton) or even [![Become a patron](https://c5.patreon.com/external/logo/become_a_patron_button.png)](https://www.patreon.com/fulmicoton)
+- [![Become a patron](https://c5.patreon.com/external/logo/become_a_patron_button.png)](https://www.patreon.com/fulmicoton)
 
 # Contributing code
 

TODO.md

@@ -1,9 +0,0 @@
-- segment writer serializes if already flush
-- flush if exceed max doc. 
-- unit tests
-- reader from `IndexWriter`
-- configurable limit to flush 
-- bundle directory
-- add index worker when exceeds some doc limit
-- flush before prepare commit.
-- segment_writer should not receive a segment 

appveyor.yml

@@ -18,5 +18,5 @@ install:
 build: false
 
 test_script:
-  - REM SET RUST_LOG=tantivy,test & cargo test --verbose --no-default-features --features mmap
+  - REM SET RUST_LOG=tantivy,test & cargo test --all --verbose --no-default-features --features mmap
   - REM SET RUST_BACKTRACE=1 & cargo build --examples

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/basic_search.rs

@@ -112,18 +112,6 @@ fn main() -> tantivy::Result<()> {
             limbs and branches that arch over the pool"
     ));
 
-    index_writer.add_document(doc!(
-    title => "Of Mice and Men",
-    body => "A few miles south of Soledad, the Salinas River drops in close to the hillside \
-            bank and runs deep and green. The water is warm too, for it has slipped twinkling \
-            over the yellow sands in the sunlight before reaching the narrow pool. On one \
-            side of the river the golden foothill slopes curve up to the strong and rocky \
-            Gabilan Mountains, but on the valley side the water is lined with trees—willows \
-            fresh and green with every spring, carrying in their lower leaf junctures the \
-            debris of the winter’s flooding; and sycamores with mottled, white, recumbent \
-            limbs and branches that arch over the pool"
-    ));
-
     // Multivalued field just need to be repeated.
     index_writer.add_document(doc!(
     title => "Frankenstein",

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, 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(),
@@ -114,7 +105,7 @@ struct StatsSegmentCollector {
 impl SegmentCollector for StatsSegmentCollector {
     type Fruit = Option<Stats>;
 
-    fn collect(&mut self, doc: u32, _score: f32) {
+    fn collect(&mut self, doc: u32, _score: Score) {
         let value = self.fast_field_reader.get(doc) as f64;
         self.stats.count += 1;
         self.stats.sum += value;

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

@@ -0,0 +1,98 @@
+use std::collections::HashSet;
+use tantivy::collector::TopDocs;
+use tantivy::doc;
+use tantivy::query::BooleanQuery;
+use tantivy::schema::*;
+use tantivy::{DocId, Index, Score, SegmentReader};
+
+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", INDEXED);
+
+    let schema = schema_builder.build();
+    let index = Index::create_in_ram(schema.clone());
+
+    let mut index_writer = index.writer(30_000_000)?;
+
+    index_writer.add_document(doc!(
+        title => "Fried egg",
+        ingredient => Facet::from("/ingredient/egg"),
+        ingredient => Facet::from("/ingredient/oil"),
+    ));
+    index_writer.add_document(doc!(
+        title => "Scrambled egg",
+        ingredient => Facet::from("/ingredient/egg"),
+        ingredient => Facet::from("/ingredient/butter"),
+        ingredient => Facet::from("/ingredient/milk"),
+        ingredient => Facet::from("/ingredient/salt"),
+    ));
+    index_writer.add_document(doc!(
+        title => "Egg rolls",
+        ingredient => Facet::from("/ingredient/egg"),
+        ingredient => Facet::from("/ingredient/garlic"),
+        ingredient => Facet::from("/ingredient/salt"),
+        ingredient => Facet::from("/ingredient/oil"),
+        ingredient => Facet::from("/ingredient/tortilla-wrap"),
+        ingredient => Facet::from("/ingredient/mushroom"),
+    ));
+    index_writer.commit()?;
+
+    let reader = index.reader()?;
+    let searcher = reader.searcher();
+    {
+        let facets = vec![
+            Facet::from("/ingredient/egg"),
+            Facet::from("/ingredient/oil"),
+            Facet::from("/ingredient/garlic"),
+            Facet::from("/ingredient/mushroom"),
+        ];
+        let query = BooleanQuery::new_multiterms_query(
+            facets
+                .iter()
+                .map(|key| Term::from_facet(ingredient, &key))
+                .collect(),
+        );
+        let top_docs_by_custom_score =
+            TopDocs::with_limit(2).tweak_score(move |segment_reader: &SegmentReader| {
+                let ingredient_reader = segment_reader.facet_reader(ingredient).unwrap();
+                let facet_dict = ingredient_reader.facet_dict();
+
+                let query_ords: HashSet<u64> = facets
+                    .iter()
+                    .filter_map(|key| facet_dict.term_ord(key.encoded_str()).unwrap())
+                    .collect();
+
+                let mut facet_ords_buffer: Vec<u64> = Vec::with_capacity(20);
+
+                move |doc: DocId, original_score: Score| {
+                    ingredient_reader.facet_ords(doc, &mut facet_ords_buffer);
+                    let missing_ingredients = facet_ords_buffer
+                        .iter()
+                        .filter(|ord| !query_ords.contains(ord))
+                        .count();
+                    let tweak = 1.0 / 4_f32.powi(missing_ingredients as i32);
+
+                    original_score * tweak
+                }
+            });
+        let top_docs = searcher.search(&query, &top_docs_by_custom_score)?;
+
+        let titles: Vec<String> = top_docs
+            .iter()
+            .map(|(_, doc_id)| {
+                searcher
+                    .doc(*doc_id)
+                    .unwrap()
+                    .get_first(title)
+                    .unwrap()
+                    .text()
+                    .unwrap()
+                    .to_owned()
+            })
+            .collect();
+        assert_eq!(titles, vec!["Fried egg", "Egg rolls"]);
+    }
+    Ok(())
+}

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.
@@ -10,7 +10,7 @@
 // ---
 // Importing tantivy...
 use tantivy::schema::*;
-use tantivy::{doc, DocId, DocSet, Index, Postings};
+use tantivy::{doc, DocSet, Index, Postings, TERMINATED};
 
 fn main() -> tantivy::Result<()> {
     // We first create a schema for the sake of the
@@ -45,7 +45,7 @@ fn main() -> tantivy::Result<()> {
         // Inverted index stands for the combination of
         // - the term dictionary
         // - the inverted lists associated to each terms and their positions
-        let inverted_index = segment_reader.inverted_index(title);
+        let inverted_index = segment_reader.inverted_index(title)?;
 
         // A `Term` is a text token associated with a field.
         // Let's go through all docs containing the term `title:the` and access their position
@@ -58,16 +58,15 @@ fn main() -> tantivy::Result<()> {
         // If you don't need all this information, you may get better performance by decompressing less
         // information.
         if let Some(mut segment_postings) =
-            inverted_index.read_postings(&term_the, IndexRecordOption::WithFreqsAndPositions)
+            inverted_index.read_postings(&term_the, IndexRecordOption::WithFreqsAndPositions)?
         {
             // this buffer will be used to request for positions
             let mut positions: Vec<u32> = Vec::with_capacity(100);
-            while segment_postings.advance() {
-                // the number of time the term appears in the document.
-                let doc_id: DocId = segment_postings.doc(); //< do not try to access this before calling advance once.
-
+            let mut doc_id = segment_postings.doc();
+            while doc_id != TERMINATED {
                 // This MAY contains deleted documents as well.
                 if segment_reader.is_deleted(doc_id) {
+                    doc_id = segment_postings.advance();
                     continue;
                 }
 
@@ -86,6 +85,7 @@ fn main() -> tantivy::Result<()> {
                 // Doc 2: TermFreq 1: [0]
                 // ```
                 println!("Doc {}: TermFreq {}: {:?}", doc_id, term_freq, positions);
+                doc_id = segment_postings.advance();
             }
         }
     }
@@ -106,7 +106,7 @@ fn main() -> tantivy::Result<()> {
         // Inverted index stands for the combination of
         // - the term dictionary
         // - the inverted lists associated to each terms and their positions
-        let inverted_index = segment_reader.inverted_index(title);
+        let inverted_index = segment_reader.inverted_index(title)?;
 
         // This segment posting object is like a cursor over the documents matching the term.
         // The `IndexRecordOption` arguments tells tantivy we will be interested in both term frequencies
@@ -115,13 +115,18 @@ fn main() -> tantivy::Result<()> {
         // If you don't need all this information, you may get better performance by decompressing less
         // information.
         if let Some(mut block_segment_postings) =
-            inverted_index.read_block_postings(&term_the, IndexRecordOption::Basic)
+            inverted_index.read_block_postings(&term_the, IndexRecordOption::Basic)?
         {
-            while block_segment_postings.advance() {
+            loop {
+                let docs = block_segment_postings.docs();
+                if docs.is_empty() {
+                    break;
+                }
                 // Once again these docs MAY contains deleted documents as well.
                 let docs = block_segment_postings.docs();
                 // Prints `Docs [0, 2].`
                 println!("Docs {:?}", docs);
+                block_segment_postings.advance();
             }
         }
     }

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.12.0"
+version = "0.14.0"
 authors = ["Paul Masurel <paul.masurel@gmail.com>"]
 license = "MIT"
 categories = ["database-implementations", "data-structures"]

query-grammar/src/occur.rs

@@ -31,22 +31,12 @@ impl Occur {
 
     /// Compose two occur values.
     pub fn compose(left: Occur, right: Occur) -> Occur {
-        match left {
-            Occur::Should => right,
-            Occur::Must => {
-                if right == Occur::MustNot {
-                    Occur::MustNot
-                } else {
-                    Occur::Must
-                }
-            }
-            Occur::MustNot => {
-                if right == Occur::MustNot {
-                    Occur::Must
-                } else {
-                    Occur::MustNot
-                }
-            }
+        match (left, right) {
+            (Occur::Should, _) => right,
+            (Occur::Must, Occur::MustNot) => Occur::MustNot,
+            (Occur::Must, _) => Occur::Must,
+            (Occur::MustNot, Occur::MustNot) => Occur::Must,
+            (Occur::MustNot, _) => Occur::MustNot,
         }
     }
 }
@@ -56,3 +46,27 @@ impl fmt::Display for Occur {
         f.write_char(self.to_char())
     }
 }
+
+#[cfg(test)]
+mod test {
+    use crate::Occur;
+
+    #[test]
+    fn test_occur_compose() {
+        assert_eq!(Occur::compose(Occur::Should, Occur::Should), Occur::Should);
+        assert_eq!(Occur::compose(Occur::Should, Occur::Must), Occur::Must);
+        assert_eq!(
+            Occur::compose(Occur::Should, Occur::MustNot),
+            Occur::MustNot
+        );
+        assert_eq!(Occur::compose(Occur::Must, Occur::Should), Occur::Must);
+        assert_eq!(Occur::compose(Occur::Must, Occur::Must), Occur::Must);
+        assert_eq!(Occur::compose(Occur::Must, Occur::MustNot), Occur::MustNot);
+        assert_eq!(
+            Occur::compose(Occur::MustNot, Occur::Should),
+            Occur::MustNot
+        );
+        assert_eq!(Occur::compose(Occur::MustNot, Occur::Must), Occur::MustNot);
+        assert_eq!(Occur::compose(Occur::MustNot, Occur::MustNot), Occur::Must);
+    }
+}

query-grammar/src/query_grammar.rs

@@ -1,16 +1,18 @@
 use super::user_input_ast::{UserInputAST, UserInputBound, UserInputLeaf, UserInputLiteral};
 use crate::Occur;
-use combine::error::StringStreamError;
 use combine::parser::char::{char, digit, letter, space, spaces, string};
 use combine::parser::Parser;
 use combine::{
     attempt, choice, eof, many, many1, one_of, optional, parser, satisfy, skip_many1, value,
 };
+use combine::{error::StringStreamError, parser::combinator::recognize};
 
 fn field<'a>() -> impl Parser<&'a str, Output = String> {
     (
-        letter(),
-        many(satisfy(|c: char| c.is_alphanumeric() || c == '_')),
+        (letter().or(char('_'))),
+        many(satisfy(|c: char| {
+            c.is_alphanumeric() || c == '_' || c == '-'
+        })),
     )
         .skip(char(':'))
         .map(|(s1, s2): (char, String)| format!("{}{}", s1, s2))
@@ -33,6 +35,62 @@ fn word<'a>() -> impl Parser<&'a str, Output = String> {
         })
 }
 
+/// Parses a date time according to rfc3339
+/// 2015-08-02T18:54:42+02
+/// 2021-04-13T19:46:26.266051969+00:00
+///
+/// NOTE: also accepts 999999-99-99T99:99:99.266051969+99:99
+/// We delegate rejecting such invalid dates to the logical AST compuation code
+/// which invokes chrono::DateTime::parse_from_rfc3339 on the value to actually parse
+/// it (instead of merely extracting the datetime value as string as done here).
+fn date_time<'a>() -> impl Parser<&'a str, Output = String> {
+    let two_digits = || recognize::<String, _, _>((digit(), digit()));
+
+    // Parses a time zone
+    // -06:30
+    // Z
+    let time_zone = {
+        let utc = recognize::<String, _, _>(char('Z'));
+        let offset = recognize((
+            choice([char('-'), char('+')]),
+            two_digits(),
+            char(':'),
+            two_digits(),
+        ));
+
+        utc.or(offset)
+    };
+
+    // Parses a date
+    // 2010-01-30
+    let date = {
+        recognize::<String, _, _>((
+            many1::<String, _, _>(digit()),
+            char('-'),
+            two_digits(),
+            char('-'),
+            two_digits(),
+        ))
+    };
+
+    // Parses a time
+    // 12:30:02
+    // 19:46:26.266051969
+    let time = {
+        recognize::<String, _, _>((
+            two_digits(),
+            char(':'),
+            two_digits(),
+            char(':'),
+            two_digits(),
+            optional((char('.'), many1::<String, _, _>(digit()))),
+            time_zone,
+        ))
+    };
+
+    recognize((date, char('T'), time))
+}
+
 fn term_val<'a>() -> impl Parser<&'a str, Output = String> {
     let phrase = char('"').with(many1(satisfy(|c| c != '"'))).skip(char('"'));
     phrase.or(word())
@@ -81,7 +139,8 @@ fn spaces1<'a>() -> impl Parser<&'a str, Output = ()> {
 /// [a TO *], [a TO c], [abc TO bcd}
 fn range<'a>() -> impl Parser<&'a str, Output = UserInputLeaf> {
     let range_term_val = || {
-        word()
+        attempt(date_time())
+            .or(word())
             .or(negative_number())
             .or(char('*').with(value("*".to_string())))
     };
@@ -154,17 +213,11 @@ fn negate(expr: UserInputAST) -> UserInputAST {
     expr.unary(Occur::MustNot)
 }
 
-fn must(expr: UserInputAST) -> UserInputAST {
-    expr.unary(Occur::Must)
-}
-
 fn leaf<'a>() -> impl Parser<&'a str, Output = UserInputAST> {
     parser(|input| {
-        char('-')
-            .with(leaf())
-            .map(negate)
-            .or(char('+').with(leaf()).map(must))
-            .or(char('(').with(ast()).skip(char(')')))
+        char('(')
+            .with(ast())
+            .skip(char(')'))
             .or(char('*').map(|_| UserInputAST::from(UserInputLeaf::All)))
             .or(attempt(
                 string("NOT").skip(spaces1()).with(leaf()).map(negate),
@@ -176,7 +229,17 @@ fn leaf<'a>() -> impl Parser<&'a str, Output = UserInputAST> {
     })
 }
 
-fn positive_float_number<'a>() -> impl Parser<&'a str, Output = f32> {
+fn occur_symbol<'a>() -> impl Parser<&'a str, Output = Occur> {
+    char('-')
+        .map(|_| Occur::MustNot)
+        .or(char('+').map(|_| Occur::Must))
+}
+
+fn occur_leaf<'a>() -> impl Parser<&'a str, Output = (Option<Occur>, UserInputAST)> {
+    (optional(occur_symbol()), boosted_leaf())
+}
+
+fn positive_float_number<'a>() -> impl Parser<&'a str, Output = f64> {
     (many1(digit()), optional((char('.'), many1(digit())))).map(
         |(int_part, decimal_part_opt): (String, Option<(char, String)>)| {
             let mut float_str = int_part;
@@ -184,18 +247,18 @@ fn positive_float_number<'a>() -> impl Parser<&'a str, Output = f32> {
                 float_str.push(chr);
                 float_str.push_str(&decimal_str);
             }
-            float_str.parse::<f32>().unwrap()
+            float_str.parse::<f64>().unwrap()
         },
     )
 }
 
-fn boost<'a>() -> impl Parser<&'a str, Output = f32> {
+fn boost<'a>() -> impl Parser<&'a str, Output = f64> {
     (char('^'), positive_float_number()).map(|(_, boost)| boost)
 }
 
 fn boosted_leaf<'a>() -> impl Parser<&'a str, Output = UserInputAST> {
     (leaf(), optional(boost())).map(|(leaf, boost_opt)| match boost_opt {
-        Some(boost) if (boost - 1.0).abs() > std::f32::EPSILON => {
+        Some(boost) if (boost - 1.0).abs() > std::f64::EPSILON => {
             UserInputAST::Boost(Box::new(leaf), boost)
         }
         _ => leaf,
@@ -239,21 +302,29 @@ fn aggregate_binary_expressions(
     }
 }
 
-pub fn ast<'a>() -> impl Parser<&'a str, Output = UserInputAST> {
-    let operand_leaf = (
+fn operand_leaf<'a>() -> impl Parser<&'a str, Output = (BinaryOperand, UserInputAST)> {
+    (
         binary_operand().skip(spaces()),
         boosted_leaf().skip(spaces()),
-    );
-    let boolean_expr = (boosted_leaf().skip(spaces().silent()), many1(operand_leaf))
+    )
+}
+
+pub fn ast<'a>() -> impl Parser<&'a str, Output = UserInputAST> {
+    let boolean_expr = (boosted_leaf().skip(spaces()), many1(operand_leaf()))
         .map(|(left, right)| aggregate_binary_expressions(left, right));
-    let whitespace_separated_leaves =
-        many1(boosted_leaf().skip(spaces().silent())).map(|subqueries: Vec<UserInputAST>| {
+    let whitespace_separated_leaves = many1(occur_leaf().skip(spaces().silent())).map(
+        |subqueries: Vec<(Option<Occur>, UserInputAST)>| {
             if subqueries.len() == 1 {
-                subqueries.into_iter().next().unwrap()
+                let (occur_opt, ast) = subqueries.into_iter().next().unwrap();
+                match occur_opt.unwrap_or(Occur::Should) {
+                    Occur::Must | Occur::Should => ast,
+                    Occur::MustNot => UserInputAST::Clause(vec![(Some(Occur::MustNot), ast)]),
+                }
             } else {
                 UserInputAST::Clause(subqueries.into_iter().collect())
             }
-        });
+        },
+    );
     let expr = attempt(boolean_expr).or(whitespace_separated_leaves);
     spaces().with(expr).skip(spaces())
 }
@@ -267,14 +338,16 @@ pub fn parse_to_ast<'a>() -> impl Parser<&'a str, Output = UserInputAST> {
 #[cfg(test)]
 mod test {
 
+    type TestParseResult = Result<(), StringStreamError>;
+
     use super::*;
     use combine::parser::Parser;
 
-    pub fn nearly_equals(a: f32, b: f32) -> bool {
+    pub fn nearly_equals(a: f64, b: f64) -> bool {
         (a - b).abs() < 0.0005 * (a + b).abs()
     }
 
-    fn assert_nearly_equals(expected: f32, val: f32) {
+    fn assert_nearly_equals(expected: f64, val: f64) {
         assert!(
             nearly_equals(val, expected),
             "Got {}, expected {}.",
@@ -283,9 +356,16 @@ mod test {
         );
     }
 
+    #[test]
+    fn test_occur_symbol() -> TestParseResult {
+        assert_eq!(super::occur_symbol().parse("-")?, (Occur::MustNot, ""));
+        assert_eq!(super::occur_symbol().parse("+")?, (Occur::Must, ""));
+        Ok(())
+    }
+
     #[test]
     fn test_positive_float_number() {
-        fn valid_parse(float_str: &str, expected_val: f32, expected_remaining: &str) {
+        fn valid_parse(float_str: &str, expected_val: f64, expected_remaining: &str) {
             let (val, remaining) = positive_float_number().parse(float_str).unwrap();
             assert_eq!(remaining, expected_remaining);
             assert_nearly_equals(val, expected_val);
@@ -293,14 +373,30 @@ mod test {
         fn error_parse(float_str: &str) {
             assert!(positive_float_number().parse(float_str).is_err());
         }
-        valid_parse("1.0", 1.0f32, "");
-        valid_parse("1", 1.0f32, "");
-        valid_parse("0.234234 aaa", 0.234234f32, " aaa");
+        valid_parse("1.0", 1.0, "");
+        valid_parse("1", 1.0, "");
+        valid_parse("0.234234 aaa", 0.234234f64, " aaa");
         error_parse(".3332");
         error_parse("1.");
         error_parse("-1.");
     }
 
+    #[test]
+    fn test_date_time() {
+        let (val, remaining) = date_time()
+            .parse("2015-08-02T18:54:42+02:30")
+            .expect("cannot parse date");
+        assert_eq!(val, "2015-08-02T18:54:42+02:30");
+        assert_eq!(remaining, "");
+        assert!(date_time().parse("2015-08-02T18:54:42+02").is_err());
+
+        let (val, remaining) = date_time()
+            .parse("2021-04-13T19:46:26.266051969+00:00")
+            .expect("cannot parse fractional date");
+        assert_eq!(val, "2021-04-13T19:46:26.266051969+00:00");
+        assert_eq!(remaining, "");
+    }
+
     fn test_parse_query_to_ast_helper(query: &str, expected: &str) {
         let query = parse_to_ast().parse(query).unwrap().0;
         let query_str = format!("{:?}", query);
@@ -330,7 +426,7 @@ mod test {
             "Err(UnexpectedParse)"
         );
         test_parse_query_to_ast_helper("NOTa", "\"NOTa\"");
-        test_parse_query_to_ast_helper("NOT a", "-(\"a\")");
+        test_parse_query_to_ast_helper("NOT a", "(-\"a\")");
     }
 
     #[test]
@@ -338,16 +434,16 @@ mod test {
         assert!(parse_to_ast().parse("a^2^3").is_err());
         assert!(parse_to_ast().parse("a^2^").is_err());
         test_parse_query_to_ast_helper("a^3", "(\"a\")^3");
-        test_parse_query_to_ast_helper("a^3 b^2", "((\"a\")^3 (\"b\")^2)");
+        test_parse_query_to_ast_helper("a^3 b^2", "(*(\"a\")^3 *(\"b\")^2)");
         test_parse_query_to_ast_helper("a^1", "\"a\"");
     }
 
     #[test]
     fn test_parse_query_to_ast_binary_op() {
-        test_parse_query_to_ast_helper("a AND b", "(+(\"a\") +(\"b\"))");
-        test_parse_query_to_ast_helper("a OR b", "(?(\"a\") ?(\"b\"))");
-        test_parse_query_to_ast_helper("a OR b AND c", "(?(\"a\") ?((+(\"b\") +(\"c\"))))");
-        test_parse_query_to_ast_helper("a AND b         AND c", "(+(\"a\") +(\"b\") +(\"c\"))");
+        test_parse_query_to_ast_helper("a AND b", "(+\"a\" +\"b\")");
+        test_parse_query_to_ast_helper("a OR b", "(?\"a\" ?\"b\")");
+        test_parse_query_to_ast_helper("a OR b AND c", "(?\"a\" ?(+\"b\" +\"c\"))");
+        test_parse_query_to_ast_helper("a AND b         AND c", "(+\"a\" +\"b\" +\"c\")");
         assert_eq!(
             format!("{:?}", parse_to_ast().parse("a OR b aaa")),
             "Err(UnexpectedParse)"
@@ -385,60 +481,156 @@ mod test {
         test_parse_query_to_ast_helper("weight: <= 70.5", "weight:{\"*\" TO \"70.5\"]");
     }
 
+    #[test]
+    fn test_occur_leaf() {
+        let ((occur, ast), _) = super::occur_leaf().parse("+abc").unwrap();
+        assert_eq!(occur, Some(Occur::Must));
+        assert_eq!(format!("{:?}", ast), "\"abc\"");
+    }
+
+    #[test]
+    fn test_field_name() -> TestParseResult {
+        assert_eq!(
+            super::field().parse("my-field-name:a")?,
+            ("my-field-name".to_string(), "a")
+        );
+        assert_eq!(
+            super::field().parse("my_field_name:a")?,
+            ("my_field_name".to_string(), "a")
+        );
+        assert!(super::field().parse(":a").is_err());
+        assert!(super::field().parse("-my_field:a").is_err());
+        assert_eq!(
+            super::field().parse("_my_field:a")?,
+            ("_my_field".to_string(), "a")
+        );
+        Ok(())
+    }
+
     #[test]
     fn test_range_parser() {
         // testing the range() parser separately
-        let res = range().parse("title: <hello").unwrap().0;
+        let res = range()
+            .parse("title: <hello")
+            .expect("Cannot parse felxible bound word")
+            .0;
         let expected = UserInputLeaf::Range {
             field: Some("title".to_string()),
             lower: UserInputBound::Unbounded,
             upper: UserInputBound::Exclusive("hello".to_string()),
         };
-        let res2 = range().parse("title:{* TO hello}").unwrap().0;
+        let res2 = range()
+            .parse("title:{* TO hello}")
+            .expect("Cannot parse ununbounded to word")
+            .0;
         assert_eq!(res, expected);
         assert_eq!(res2, expected);
+
         let expected_weight = UserInputLeaf::Range {
             field: Some("weight".to_string()),
             lower: UserInputBound::Inclusive("71.2".to_string()),
             upper: UserInputBound::Unbounded,
         };
-
-        let res3 = range().parse("weight: >=71.2").unwrap().0;
-        let res4 = range().parse("weight:[71.2 TO *}").unwrap().0;
+        let res3 = range()
+            .parse("weight: >=71.2")
+            .expect("Cannot parse flexible bound float")
+            .0;
+        let res4 = range()
+            .parse("weight:[71.2 TO *}")
+            .expect("Cannot parse float to unbounded")
+            .0;
         assert_eq!(res3, expected_weight);
         assert_eq!(res4, expected_weight);
+
+        let expected_dates = UserInputLeaf::Range {
+            field: Some("date_field".to_string()),
+            lower: UserInputBound::Exclusive("2015-08-02T18:54:42Z".to_string()),
+            upper: UserInputBound::Inclusive("2021-08-02T18:54:42+02:30".to_string()),
+        };
+        let res5 = range()
+            .parse("date_field:{2015-08-02T18:54:42Z TO 2021-08-02T18:54:42+02:30]")
+            .expect("Cannot parse date range")
+            .0;
+        assert_eq!(res5, expected_dates);
+
+        let expected_flexible_dates = UserInputLeaf::Range {
+            field: Some("date_field".to_string()),
+            lower: UserInputBound::Unbounded,
+            upper: UserInputBound::Inclusive("2021-08-02T18:54:42.12345+02:30".to_string()),
+        };
+
+        let res6 = range()
+            .parse("date_field: <=2021-08-02T18:54:42.12345+02:30")
+            .expect("Cannot parse date range")
+            .0;
+        assert_eq!(res6, expected_flexible_dates);
     }
 
     #[test]
     fn test_parse_query_to_triming_spaces() {
         test_parse_query_to_ast_helper("   abc", "\"abc\"");
         test_parse_query_to_ast_helper("abc ", "\"abc\"");
-        test_parse_query_to_ast_helper("(  a OR abc)", "(?(\"a\") ?(\"abc\"))");
-        test_parse_query_to_ast_helper("(a  OR abc)", "(?(\"a\") ?(\"abc\"))");
-        test_parse_query_to_ast_helper("(a OR  abc)", "(?(\"a\") ?(\"abc\"))");
-        test_parse_query_to_ast_helper("a OR abc ", "(?(\"a\") ?(\"abc\"))");
-        test_parse_query_to_ast_helper("(a OR abc )", "(?(\"a\") ?(\"abc\"))");
-        test_parse_query_to_ast_helper("(a OR  abc) ", "(?(\"a\") ?(\"abc\"))");
+        test_parse_query_to_ast_helper("(  a OR abc)", "(?\"a\" ?\"abc\")");
+        test_parse_query_to_ast_helper("(a  OR abc)", "(?\"a\" ?\"abc\")");
+        test_parse_query_to_ast_helper("(a OR  abc)", "(?\"a\" ?\"abc\")");
+        test_parse_query_to_ast_helper("a OR abc ", "(?\"a\" ?\"abc\")");
+        test_parse_query_to_ast_helper("(a OR abc )", "(?\"a\" ?\"abc\")");
+        test_parse_query_to_ast_helper("(a OR  abc) ", "(?\"a\" ?\"abc\")");
     }
 
     #[test]
-    fn test_parse_query_to_ast() {
+    fn test_parse_query_single_term() {
         test_parse_query_to_ast_helper("abc", "\"abc\"");
-        test_parse_query_to_ast_helper("a b", "(\"a\" \"b\")");
-        test_parse_query_to_ast_helper("+(a b)", "+((\"a\" \"b\"))");
-        test_parse_query_to_ast_helper("+d", "+(\"d\")");
-        test_parse_query_to_ast_helper("+(a b) +d", "(+((\"a\" \"b\")) +(\"d\"))");
-        test_parse_query_to_ast_helper("(+a +b) d", "((+(\"a\") +(\"b\")) \"d\")");
-        test_parse_query_to_ast_helper("(+a)", "+(\"a\")");
-        test_parse_query_to_ast_helper("(+a +b)", "(+(\"a\") +(\"b\"))");
+    }
+
+    #[test]
+    fn test_parse_query_default_clause() {
+        test_parse_query_to_ast_helper("a b", "(*\"a\" *\"b\")");
+    }
+
+    #[test]
+    fn test_parse_query_must_default_clause() {
+        test_parse_query_to_ast_helper("+(a b)", "(*\"a\" *\"b\")");
+    }
+
+    #[test]
+    fn test_parse_query_must_single_term() {
+        test_parse_query_to_ast_helper("+d", "\"d\"");
+    }
+
+    #[test]
+    fn test_single_term_with_field() {
         test_parse_query_to_ast_helper("abc:toto", "abc:\"toto\"");
+    }
+
+    #[test]
+    fn test_single_term_with_float() {
         test_parse_query_to_ast_helper("abc:1.1", "abc:\"1.1\"");
-        test_parse_query_to_ast_helper("+abc:toto", "+(abc:\"toto\")");
-        test_parse_query_to_ast_helper("(+abc:toto -titi)", "(+(abc:\"toto\") -(\"titi\"))");
-        test_parse_query_to_ast_helper("-abc:toto", "-(abc:\"toto\")");
-        test_parse_query_to_ast_helper("abc:a b", "(abc:\"a\" \"b\")");
+    }
+
+    #[test]
+    fn test_must_clause() {
+        test_parse_query_to_ast_helper("(+a +b)", "(+\"a\" +\"b\")");
+    }
+
+    #[test]
+    fn test_parse_test_query_plus_a_b_plus_d() {
+        test_parse_query_to_ast_helper("+(a b) +d", "(+(*\"a\" *\"b\") +\"d\")");
+    }
+
+    #[test]
+    fn test_parse_test_query_other() {
+        test_parse_query_to_ast_helper("(+a +b) d", "(*(+\"a\" +\"b\") *\"d\")");
+        test_parse_query_to_ast_helper("+abc:toto", "abc:\"toto\"");
+        test_parse_query_to_ast_helper("(+abc:toto -titi)", "(+abc:\"toto\" -\"titi\")");
+        test_parse_query_to_ast_helper("-abc:toto", "(-abc:\"toto\")");
+        test_parse_query_to_ast_helper("abc:a b", "(*abc:\"a\" *\"b\")");
         test_parse_query_to_ast_helper("abc:\"a b\"", "abc:\"a b\"");
         test_parse_query_to_ast_helper("foo:[1 TO 5]", "foo:[\"1\" TO \"5\"]");
+    }
+
+    #[test]
+    fn test_parse_query_with_range() {
         test_parse_query_to_ast_helper("[1 TO 5]", "[\"1\" TO \"5\"]");
         test_parse_query_to_ast_helper("foo:{a TO z}", "foo:{\"a\" TO \"z\"}");
         test_parse_query_to_ast_helper("foo:[1 TO toto}", "foo:[\"1\" TO \"toto\"}");

query-grammar/src/user_input_ast.rs

@@ -85,15 +85,14 @@ impl UserInputBound {
 }
 
 pub enum UserInputAST {
-    Clause(Vec<UserInputAST>),
-    Unary(Occur, Box<UserInputAST>),
+    Clause(Vec<(Option<Occur>, UserInputAST)>),
     Leaf(Box<UserInputLeaf>),
-    Boost(Box<UserInputAST>, f32),
+    Boost(Box<UserInputAST>, f64),
 }
 
 impl UserInputAST {
     pub fn unary(self, occur: Occur) -> UserInputAST {
-        UserInputAST::Unary(occur, Box::new(self))
+        UserInputAST::Clause(vec![(Some(occur), self)])
     }
 
     fn compose(occur: Occur, asts: Vec<UserInputAST>) -> UserInputAST {
@@ -104,7 +103,7 @@ impl UserInputAST {
         } else {
             UserInputAST::Clause(
                 asts.into_iter()
-                    .map(|ast: UserInputAST| ast.unary(occur))
+                    .map(|ast: UserInputAST| (Some(occur), ast))
                     .collect::<Vec<_>>(),
             )
         }
@@ -135,25 +134,36 @@ impl From<UserInputLeaf> for UserInputAST {
     }
 }
 
+fn print_occur_ast(
+    occur_opt: Option<Occur>,
+    ast: &UserInputAST,
+    formatter: &mut fmt::Formatter,
+) -> fmt::Result {
+    if let Some(occur) = occur_opt {
+        write!(formatter, "{}{:?}", occur, ast)?;
+    } else {
+        write!(formatter, "*{:?}", ast)?;
+    }
+    Ok(())
+}
+
 impl fmt::Debug for UserInputAST {
-    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> Result<(), fmt::Error> {
+    fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
         match *self {
             UserInputAST::Clause(ref subqueries) => {
                 if subqueries.is_empty() {
                     write!(formatter, "<emptyclause>")?;
                 } else {
                     write!(formatter, "(")?;
-                    write!(formatter, "{:?}", &subqueries[0])?;
+                    print_occur_ast(subqueries[0].0, &subqueries[0].1, formatter)?;
                     for subquery in &subqueries[1..] {
-                        write!(formatter, " {:?}", subquery)?;
+                        write!(formatter, " ")?;
+                        print_occur_ast(subquery.0, &subquery.1, formatter)?;
                     }
                     write!(formatter, ")")?;
                 }
                 Ok(())
             }
-            UserInputAST::Unary(ref occur, ref subquery) => {
-                write!(formatter, "{}({:?})", occur, subquery)
-            }
             UserInputAST::Leaf(ref subquery) => write!(formatter, "{:?}", subquery),
             UserInputAST::Boost(ref leaf, boost) => write!(formatter, "({:?})^{}", leaf, boost),
         }

src/collector/count_collector.rs

@@ -2,7 +2,7 @@ use super::Collector;
 use crate::collector::SegmentCollector;
 use crate::DocId;
 use crate::Score;
-use crate::SegmentLocalId;
+use crate::SegmentOrdinal;
 use crate::SegmentReader;
 
 /// `CountCollector` collector only counts how many
@@ -45,7 +45,7 @@ impl Collector for Count {
 
     fn for_segment(
         &self,
-        _: SegmentLocalId,
+        _: SegmentOrdinal,
         _: &SegmentReader,
     ) -> crate::Result<SegmentCountCollector> {
         Ok(SegmentCountCollector::default())
@@ -96,18 +96,18 @@ mod tests {
         }
         {
             let mut count_collector = SegmentCountCollector::default();
-            count_collector.collect(0u32, 1f32);
+            count_collector.collect(0u32, 1.0);
             assert_eq!(count_collector.harvest(), 1);
         }
         {
             let mut count_collector = SegmentCountCollector::default();
-            count_collector.collect(0u32, 1f32);
+            count_collector.collect(0u32, 1.0);
             assert_eq!(count_collector.harvest(), 1);
         }
         {
             let mut count_collector = SegmentCountCollector::default();
-            count_collector.collect(0u32, 1f32);
-            count_collector.collect(1u32, 1f32);
+            count_collector.collect(0u32, 1.0);
+            count_collector.collect(1u32, 1.0);
             assert_eq!(count_collector.harvest(), 2);
         }
     }

src/collector/custom_score_top_collector.rs

@@ -11,13 +11,13 @@ impl<TCustomScorer, TScore> CustomScoreTopCollector<TCustomScorer, TScore>
 where
     TScore: Clone + PartialOrd,
 {
-    pub fn new(
+    pub(crate) fn new(
         custom_scorer: TCustomScorer,
-        limit: usize,
+        collector: TopCollector<TScore>,
     ) -> CustomScoreTopCollector<TCustomScorer, TScore> {
         CustomScoreTopCollector {
             custom_scorer,
-            collector: TopCollector::with_limit(limit),
+            collector,
         }
     }
 }
@@ -28,7 +28,7 @@ where
 /// It is the segment local version of the [`CustomScorer`](./trait.CustomScorer.html).
 pub trait CustomSegmentScorer<TScore>: 'static {
     /// Computes the score of a specific `doc`.
-    fn score(&self, doc: DocId) -> TScore;
+    fn score(&mut self, doc: DocId) -> TScore;
 }
 
 /// `CustomScorer` makes it possible to define any kind of score.
@@ -46,7 +46,7 @@ pub trait CustomScorer<TScore>: Sync {
 
 impl<TCustomScorer, TScore> Collector for CustomScoreTopCollector<TCustomScorer, TScore>
 where
-    TCustomScorer: CustomScorer<TScore>,
+    TCustomScorer: CustomScorer<TScore> + Send + Sync,
     TScore: 'static + PartialOrd + Clone + Send + Sync,
 {
     type Fruit = Vec<(TScore, DocAddress)>;
@@ -58,10 +58,8 @@ 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_scorer = self.custom_scorer.segment_scorer(segment_reader)?;
-        let segment_collector = self
-            .collector
-            .for_segment(segment_local_id, segment_reader)?;
         Ok(CustomScoreTopSegmentCollector {
             segment_collector,
             segment_scorer,
@@ -117,9 +115,9 @@ where
 
 impl<F, TScore> CustomSegmentScorer<TScore> for F
 where
-    F: 'static + Sync + Send + Fn(DocId) -> TScore,
+    F: 'static + FnMut(DocId) -> TScore,
 {
-    fn score(&self, doc: DocId) -> TScore {
+    fn score(&mut self, doc: DocId) -> TScore {
         (self)(doc)
     }
 }

src/collector/docset_collector.rs

@@ -0,0 +1,61 @@
+use std::collections::HashSet;
+
+use crate::{DocAddress, DocId, Score};
+
+use super::{Collector, SegmentCollector};
+
+/// Collectors that returns the set of DocAddress that matches the query.
+///
+/// This collector is mostly useful for tests.
+pub struct DocSetCollector;
+
+impl Collector for DocSetCollector {
+    type Fruit = HashSet<DocAddress>;
+    type Child = DocSetChildCollector;
+
+    fn for_segment(
+        &self,
+        segment_local_id: crate::SegmentOrdinal,
+        _segment: &crate::SegmentReader,
+    ) -> crate::Result<Self::Child> {
+        Ok(DocSetChildCollector {
+            segment_local_id,
+            docs: HashSet::new(),
+        })
+    }
+
+    fn requires_scoring(&self) -> bool {
+        false
+    }
+
+    fn merge_fruits(
+        &self,
+        segment_fruits: Vec<(u32, HashSet<DocId>)>,
+    ) -> crate::Result<Self::Fruit> {
+        let len: usize = segment_fruits.iter().map(|(_, docset)| docset.len()).sum();
+        let mut result = HashSet::with_capacity(len);
+        for (segment_local_id, docs) in segment_fruits {
+            for doc in docs {
+                result.insert(DocAddress::new(segment_local_id, doc));
+            }
+        }
+        Ok(result)
+    }
+}
+
+pub struct DocSetChildCollector {
+    segment_local_id: u32,
+    docs: HashSet<DocId>,
+}
+
+impl SegmentCollector for DocSetChildCollector {
+    type Fruit = (u32, HashSet<DocId>);
+
+    fn collect(&mut self, doc: crate::DocId, _score: Score) {
+        self.docs.insert(doc);
+    }
+
+    fn harvest(self) -> (u32, HashSet<DocId>) {
+        (self.segment_local_id, self.docs)
+    }
+}

src/collector/facet_collector.rs

@@ -1,21 +1,19 @@
 use crate::collector::Collector;
 use crate::collector::SegmentCollector;
-use crate::docset::SkipResult;
 use crate::fastfield::FacetReader;
 use crate::schema::Facet;
 use crate::schema::Field;
 use crate::DocId;
 use crate::Score;
-use crate::SegmentLocalId;
+use crate::SegmentOrdinal;
 use crate::SegmentReader;
-use crate::TantivyError;
 use std::cmp::Ordering;
 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> {
@@ -39,7 +37,10 @@ impl<'a> PartialOrd<Hit<'a>> for Hit<'a> {
 
 impl<'a> Ord for Hit<'a> {
     fn cmp(&self, other: &Self) -> Ordering {
-        other.count.cmp(&self.count)
+        other
+            .count
+            .cmp(&self.count)
+            .then(self.facet.cmp(other.facet))
     }
 }
 
@@ -82,7 +83,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<()> {
@@ -91,7 +92,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);
@@ -188,6 +189,11 @@ pub struct FacetSegmentCollector {
     collapse_facet_ords: Vec<u64>,
 }
 
+enum SkipResult {
+    Found,
+    NotFound,
+}
+
 fn skip<'a, I: Iterator<Item = &'a Facet>>(
     target: &[u8],
     collapse_it: &mut Peekable<I>,
@@ -197,14 +203,14 @@ fn skip<'a, I: Iterator<Item = &'a Facet>>(
             Some(facet_bytes) => match facet_bytes.encoded_str().as_bytes().cmp(target) {
                 Ordering::Less => {}
                 Ordering::Greater => {
-                    return SkipResult::OverStep;
+                    return SkipResult::NotFound;
                 }
                 Ordering::Equal => {
-                    return SkipResult::Reached;
+                    return SkipResult::Found;
                 }
             },
             None => {
-                return SkipResult::End;
+                return SkipResult::NotFound;
             }
         }
         collapse_it.next();
@@ -259,13 +265,10 @@ impl Collector for FacetCollector {
 
     fn for_segment(
         &self,
-        _: SegmentLocalId,
+        _: SegmentOrdinal,
         reader: &SegmentReader,
     ) -> crate::Result<FacetSegmentCollector> {
-        let field_name = reader.schema().get_field_name(self.field);
-        let facet_reader = reader.facet_reader(self.field).ok_or_else(|| {
-            TantivyError::SchemaError(format!("Field {:?} is not a facet field.", field_name))
-        })?;
+        let facet_reader = reader.facet_reader(self.field)?;
 
         let mut collapse_mapping = Vec::new();
         let mut counts = Vec::new();
@@ -274,14 +277,14 @@ impl Collector for FacetCollector {
         let mut collapse_facet_it = self.facets.iter().peekable();
         collapse_facet_ords.push(0);
         {
-            let mut facet_streamer = facet_reader.facet_dict().range().into_stream();
+            let mut facet_streamer = facet_reader.facet_dict().range().into_stream()?;
             if facet_streamer.advance() {
                 'outer: loop {
                     // at the begining of this loop, facet_streamer
                     // is positionned on a term that has not been processed yet.
                     let skip_result = skip(facet_streamer.key(), &mut collapse_facet_it);
                     match skip_result {
-                        SkipResult::Reached => {
+                        SkipResult::Found => {
                             // we reach a facet we decided to collapse.
                             let collapse_depth = facet_depth(facet_streamer.key());
                             let mut collapsed_id = 0;
@@ -301,7 +304,7 @@ impl Collector for FacetCollector {
                             }
                             break;
                         }
-                        SkipResult::End | SkipResult::OverStep => {
+                        SkipResult::NotFound => {
                             collapse_mapping.push(0);
                             if !facet_streamer.advance() {
                                 break;
@@ -368,9 +371,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 +401,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 +422,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 +464,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,11 +474,11 @@ 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);
 
-        let mut index_writer = index.writer_with_num_threads(1, 3_000_000).unwrap();
+        let mut index_writer = index.writer_for_tests().unwrap();
         let num_facets: usize = 3 * 4 * 5;
         let facets: Vec<Facet> = (0..num_facets)
             .map(|mut n| {
@@ -524,10 +534,10 @@ 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_with_num_threads(1, 3_000_000).unwrap();
+        let mut index_writer = index.writer_for_tests().unwrap();
         index_writer.add_document(doc!(
             facet_field => Facet::from_text(&"/subjects/A/a"),
             facet_field => Facet::from_text(&"/subjects/B/a"),
@@ -546,12 +556,12 @@ mod tests {
     }
 
     #[test]
-    fn test_doc_search_by_facet() {
+    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_with_num_threads(1, 3_000_000).unwrap();
+        let mut index_writer = index.writer_for_tests()?;
         index_writer.add_document(doc!(
             facet_field => Facet::from_text(&"/A/A"),
         ));
@@ -564,8 +574,8 @@ mod tests {
         index_writer.add_document(doc!(
             facet_field => Facet::from_text(&"/D/C/A"),
         ));
-        index_writer.commit().unwrap();
-        let reader = index.reader().unwrap();
+        index_writer.commit()?;
+        let reader = index.reader()?;
         let searcher = reader.searcher();
         assert_eq!(searcher.num_docs(), 4);
 
@@ -582,17 +592,17 @@ mod tests {
         assert_eq!(count_facet("/A/C"), 1);
         assert_eq!(count_facet("/A/C/A"), 1);
         assert_eq!(count_facet("/C/A"), 0);
+
+        let query_parser = QueryParser::for_index(&index, vec![]);
         {
-            let query_parser = QueryParser::for_index(&index, vec![]);
-            {
-                let query = query_parser.parse_query("facet:/A/B").unwrap();
-                assert_eq!(1, searcher.search(&query, &Count).unwrap());
-            }
-            {
-                let query = query_parser.parse_query("facet:/A").unwrap();
-                assert_eq!(3, searcher.search(&query, &Count).unwrap());
-            }
+            let query = query_parser.parse_query("facet:/A/B")?;
+            assert_eq!(1, searcher.search(&query, &Count).unwrap());
         }
+        {
+            let query = query_parser.parse_query("facet:/A")?;
+            assert_eq!(3, searcher.search(&query, &Count)?);
+        }
+        Ok(())
     }
 
     #[test]
@@ -605,7 +615,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);
 
@@ -627,7 +637,7 @@ mod tests {
             .collect();
         docs[..].shuffle(&mut thread_rng());
 
-        let mut index_writer = index.writer_with_num_threads(1, 3_000_000).unwrap();
+        let mut index_writer = index.writer_for_tests().unwrap();
         for doc in docs {
             index_writer.add_document(doc);
         }
@@ -650,6 +660,41 @@ mod tests {
             );
         }
     }
+
+    #[test]
+    fn test_facet_collector_topk_tie_break() -> crate::Result<()> {
+        let mut schema_builder = Schema::builder();
+        let facet_field = schema_builder.add_facet_field("facet", INDEXED);
+        let schema = schema_builder.build();
+        let index = Index::create_in_ram(schema);
+
+        let docs: Vec<Document> = vec![("b", 2), ("a", 2), ("c", 4)]
+            .into_iter()
+            .flat_map(|(c, count)| {
+                let facet = Facet::from(&format!("/facet/{}", c));
+                let doc = doc!(facet_field => facet);
+                iter::repeat(doc).take(count)
+            })
+            .collect();
+
+        let mut index_writer = index.writer_for_tests()?;
+        for doc in docs {
+            index_writer.add_document(doc);
+        }
+        index_writer.commit()?;
+
+        let searcher = index.reader()?.searcher();
+        let mut facet_collector = FacetCollector::for_field(facet_field);
+        facet_collector.add_facet("/facet");
+        let counts: FacetCounts = searcher.search(&AllQuery, &facet_collector)?;
+
+        let facets: Vec<(&Facet, u64)> = counts.top_k("/facet", 2);
+        assert_eq!(
+            facets,
+            vec![(&Facet::from("/facet/c"), 4), (&Facet::from("/facet/a"), 2)]
+        );
+        Ok(())
+    }
 }
 
 #[cfg(all(test, feature = "unstable"))]
@@ -657,7 +702,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 +711,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);
 
@@ -680,7 +725,7 @@ mod bench {
         // 40425 docs
         docs[..].shuffle(&mut thread_rng());
 
-        let mut index_writer = index.writer_with_num_threads(1, 3_000_000).unwrap();
+        let mut index_writer = index.writer_for_tests().unwrap();
         for doc in docs {
             index_writer.add_document(doc);
         }

src/collector/filter_collector_wrapper.rs

@@ -0,0 +1,183 @@
+// # Custom collector example
+//
+// This example shows how you can implement your own
+// collector. As an example, we will compute a collector
+// that computes the standard deviation of a given fast field.
+//
+// Of course, you can have a look at the tantivy's built-in collectors
+// such as the `CountCollector` for more examples.
+
+// ---
+// Importing tantivy...
+use std::marker::PhantomData;
+
+use crate::collector::{Collector, SegmentCollector};
+use crate::fastfield::{FastFieldReader, FastValue};
+use crate::schema::Field;
+use crate::{Score, SegmentReader, TantivyError};
+
+/// The `FilterCollector` collector filters docs using a u64 fast field value and a predicate.
+/// Only the documents for which the predicate returned "true" will be passed on to the next collector.
+///
+/// ```rust
+/// use tantivy::collector::{TopDocs, FilterCollector};
+/// use tantivy::query::QueryParser;
+/// use tantivy::schema::{Schema, TEXT, INDEXED, FAST};
+/// use tantivy::{doc, DocAddress, Index};
+///
+/// let mut schema_builder = Schema::builder();
+/// let title = schema_builder.add_text_field("title", TEXT);
+/// let price = schema_builder.add_u64_field("price", INDEXED | 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));
+/// index_writer.add_document(doc!(title => "The Diary of Muadib", price => 29_240u64));
+/// index_writer.add_document(doc!(title => "A Dairy Cow", price => 21_240u64));
+/// index_writer.add_document(doc!(title => "The Diary of a Young Girl", price => 20_120u64));
+/// 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 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::new(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);
+/// ```
+pub struct FilterCollector<TCollector, TPredicate, TPredicateValue: FastValue>
+where
+    TPredicate: 'static + Clone,
+{
+    field: Field,
+    collector: TCollector,
+    predicate: TPredicate,
+    t_predicate_value: PhantomData<TPredicateValue>,
+}
+
+impl<TCollector, TPredicate, TPredicateValue: FastValue>
+    FilterCollector<TCollector, TPredicate, TPredicateValue>
+where
+    TCollector: Collector + Send + Sync,
+    TPredicate: Fn(TPredicateValue) -> bool + Send + Sync + Clone,
+{
+    /// Create a new FilterCollector.
+    pub fn new(
+        field: Field,
+        predicate: TPredicate,
+        collector: TCollector,
+    ) -> FilterCollector<TCollector, TPredicate, TPredicateValue> {
+        FilterCollector {
+            field,
+            predicate,
+            collector,
+            t_predicate_value: PhantomData,
+        }
+    }
+}
+
+impl<TCollector, TPredicate, TPredicateValue: FastValue> Collector
+    for FilterCollector<TCollector, TPredicate, TPredicateValue>
+where
+    TCollector: Collector + 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, TPredicateValue>;
+
+    fn for_segment(
+        &self,
+        segment_local_id: u32,
+        segment_reader: &SegmentReader,
+    ) -> 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()
+            .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.clone(),
+            t_predicate_value: PhantomData,
+        })
+    }
+
+    fn requires_scoring(&self) -> bool {
+        self.collector.requires_scoring()
+    }
+
+    fn merge_fruits(
+        &self,
+        segment_fruits: Vec<<TCollector::Child as SegmentCollector>::Fruit>,
+    ) -> crate::Result<TCollector::Fruit> {
+        self.collector.merge_fruits(segment_fruits)
+    }
+}
+
+pub struct FilterSegmentCollector<TSegmentCollector, TPredicate, TPredicateValue>
+where
+    TPredicate: 'static,
+    TPredicateValue: FastValue,
+{
+    fast_field_reader: FastFieldReader<TPredicateValue>,
+    segment_collector: TSegmentCollector,
+    predicate: TPredicate,
+    t_predicate_value: PhantomData<TPredicateValue>,
+}
+
+impl<TSegmentCollector, TPredicate, TPredicateValue> SegmentCollector
+    for FilterSegmentCollector<TSegmentCollector, TPredicate, TPredicateValue>
+where
+    TSegmentCollector: SegmentCollector,
+    TPredicate: 'static + Fn(TPredicateValue) -> bool + Send + Sync,
+    TPredicateValue: FastValue,
+{
+    type Fruit = TSegmentCollector::Fruit;
+
+    fn collect(&mut self, doc: u32, score: Score) {
+        let value = self.fast_field_reader.get(doc);
+        if (self.predicate)(value) {
+            self.segment_collector.collect(doc, score)
+        }
+    }
+
+    fn harvest(self) -> <TSegmentCollector as SegmentCollector>::Fruit {
+        self.segment_collector.harvest()
+    }
+}

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::SegmentOrdinal,
+        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/int_facet_collector.rs

@@ -1,127 +0,0 @@
-use std::cmp::Eq;
-use std::collections::HashMap;
-use std::hash::Hash;
-
-use collector::Collector;
-use fastfield::FastFieldReader;
-use schema::Field;
-
-use DocId;
-use Result;
-use Score;
-use SegmentReader;
-use SegmentLocalId;
-
-
-/// Facet collector  for i64/u64 fast field
-pub struct IntFacetCollector<T>
-where
-    T: FastFieldReader,
-    T::ValueType: Eq + Hash,
-{
-    counters: HashMap<T::ValueType, u64>,
-    field: Field,
-    ff_reader: Option<T>,
-}
-
-
-impl<T> IntFacetCollector<T>
-where
-    T: FastFieldReader,
-    T::ValueType: Eq + Hash,
-{
-    /// Creates a new facet collector for aggregating a given field.
-    pub fn new(field: Field) -> IntFacetCollector<T> {
-        IntFacetCollector {
-            counters: HashMap::new(),
-            field: field,
-            ff_reader: None,
-        }
-    }
-}
-
-
-impl<T> Collector for IntFacetCollector<T>
-where
-    T: FastFieldReader,
-    T::ValueType: Eq + Hash,
-{
-    fn set_segment(&mut self, _: SegmentLocalId, reader: &SegmentReader) -> Result<()> {
-        self.ff_reader = Some(reader.get_fast_field_reader(self.field)?);
-        Ok(())
-    }
-
-    fn collect(&mut self, doc: DocId, _: Score) {
-        let val = self.ff_reader
-            .as_ref()
-            .expect(
-                "collect() was called before set_segment. \
-                This should never happen.",
-            )
-            .get(doc);
-        *(self.counters.entry(val).or_insert(0)) += 1;
-    }
-}
-
-
-
-#[cfg(test)]
-mod tests {
-
-    use collector::{chain, IntFacetCollector};
-    use query::QueryParser;
-    use fastfield::{I64FastFieldReader, U64FastFieldReader};
-    use schema::{self, FAST, STRING};
-    use Index;
-
-    #[test]
-    // create 10 documents, set num field value to 0 or 1 for even/odd ones
-    // make sure we have facet counters correctly filled
-    fn test_facet_collector_results() {
-
-        let mut schema_builder = schema::Schema::builder();
-        let num_field_i64 = schema_builder.add_i64_field("num_i64", FAST);
-        let num_field_u64 = schema_builder.add_u64_field("num_u64", FAST);
-        let num_field_f64 = schema_builder.add_f64_field("num_f64", FAST);
-        let text_field = schema_builder.add_text_field("text", STRING);
-        let schema = schema_builder.build();
-
-        let index = Index::create_in_ram(schema.clone());
-
-        {
-            let mut index_writer = index.writer_with_num_threads(1, 3_000_000).unwrap();
-            {
-                for i in 0u64..10u64 {
-                    index_writer.add_document(doc!(
-                        num_field_i64 => ((i as i64) % 3i64) as i64,
-                        num_field_u64 => (i % 2u64) as u64,
-                        num_field_f64 => (i % 4u64) as f64,
-                        text_field => "text"
-                    ));
-                }
-            }
-            assert_eq!(index_writer.commit().unwrap(), 10u64);
-        }
-
-        let searcher = index.reader().searcher();
-        let mut ffvf_i64: IntFacetCollector<I64FastFieldReader> = IntFacetCollector::new(num_field_i64);
-        let mut ffvf_u64: IntFacetCollector<U64FastFieldReader> = IntFacetCollector::new(num_field_u64);
-        let mut ffvf_f64: IntFacetCollector<F64FastFieldReader> = IntFacetCollector::new(num_field_f64);
-
-        {
-            // perform the query
-            let mut facet_collectors = chain().push(&mut ffvf_i64).push(&mut ffvf_u64).push(&mut ffvf_f64);
-            let mut query_parser = QueryParser::for_index(index, vec![text_field]);
-            let query = query_parser.parse_query("text:text").unwrap();
-            query.search(&searcher, &mut facet_collectors).unwrap();
-        }
-
-        assert_eq!(ffvf_u64.counters[&0], 5);
-        assert_eq!(ffvf_u64.counters[&1], 5);
-        assert_eq!(ffvf_i64.counters[&0], 4);
-        assert_eq!(ffvf_i64.counters[&1], 3);
-        assert_eq!(ffvf_f64.counters[&0.0], 3);
-        assert_eq!(ffvf_f64.counters[&2.0], 2);
-
-    }
-}

src/collector/mod.rs

@@ -86,13 +86,16 @@ See the `custom_collector` example.
 
 use crate::DocId;
 use crate::Score;
-use crate::SegmentLocalId;
+use crate::SegmentOrdinal;
 use crate::SegmentReader;
 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,14 @@ 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;
+pub use self::docset_collector::DocSetCollector;
+
+mod filter_collector_wrapper;
+pub use self::filter_collector_wrapper::FilterCollector;
 
 /// `Fruit` is the type for the result of our collection.
 /// e.g. `usize` for the `Count` collector.
@@ -132,19 +143,19 @@ impl<T> Fruit for T where T: Send + downcast_rs::Downcast {}
 /// The collection logic itself is in the `SegmentCollector`.
 ///
 /// Segments are not guaranteed to be visited in any specific order.
-pub trait Collector: Sync {
+pub trait Collector: Sync + Send {
     /// `Fruit` is the type for the result of our collection.
     /// e.g. `usize` for the `Count` collector.
     type Fruit: Fruit;
 
     /// Type of the `SegmentCollector` associated to this collector.
-    type Child: SegmentCollector<Fruit = Self::Fruit>;
+    type Child: SegmentCollector;
 
     /// `set_segment` is called before beginning to enumerate
     /// on this segment.
     fn for_segment(
         &self,
-        segment_local_id: SegmentLocalId,
+        segment_local_id: SegmentOrdinal,
         segment: &SegmentReader,
     ) -> crate::Result<Self::Child>;
 
@@ -153,7 +164,88 @@ pub trait Collector: Sync {
 
     /// Combines the fruit associated to the collection of each segments
     /// into one fruit.
-    fn merge_fruits(&self, segment_fruits: Vec<Self::Fruit>) -> crate::Result<Self::Fruit>;
+    fn merge_fruits(
+        &self,
+        segment_fruits: Vec<<Self::Child as SegmentCollector>::Fruit>,
+    ) -> crate::Result<Self::Fruit>;
+
+    /// Created a segment collector and
+    fn collect_segment(
+        &self,
+        weight: &dyn Weight,
+        segment_ord: u32,
+        reader: &SegmentReader,
+    ) -> crate::Result<<Self::Child as SegmentCollector>::Fruit> {
+        let mut segment_collector = self.for_segment(segment_ord as u32, reader)?;
+
+        if let Some(delete_bitset) = reader.delete_bitset() {
+            weight.for_each(reader, &mut |doc, score| {
+                if delete_bitset.is_alive(doc) {
+                    segment_collector.collect(doc, score);
+                }
+            })?;
+        } else {
+            weight.for_each(reader, &mut |doc, score| {
+                segment_collector.collect(doc, score);
+            })?;
+        }
+        Ok(segment_collector.harvest())
+    }
+}
+
+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: SegmentOrdinal,
+        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
@@ -200,11 +292,11 @@ where
 
     fn merge_fruits(
         &self,
-        children: Vec<(Left::Fruit, Right::Fruit)>,
+        segment_fruits: Vec<<Self::Child as SegmentCollector>::Fruit>,
     ) -> crate::Result<(Left::Fruit, Right::Fruit)> {
         let mut left_fruits = vec![];
         let mut right_fruits = vec![];
-        for (left_fruit, right_fruit) in children {
+        for (left_fruit, right_fruit) in segment_fruits {
             left_fruits.push(left_fruit);
             right_fruits.push(right_fruit);
         }
@@ -258,7 +350,10 @@ where
         self.0.requires_scoring() || self.1.requires_scoring() || self.2.requires_scoring()
     }
 
-    fn merge_fruits(&self, children: Vec<Self::Fruit>) -> crate::Result<Self::Fruit> {
+    fn merge_fruits(
+        &self,
+        children: Vec<<Self::Child as SegmentCollector>::Fruit>,
+    ) -> crate::Result<Self::Fruit> {
         let mut one_fruits = vec![];
         let mut two_fruits = vec![];
         let mut three_fruits = vec![];
@@ -325,7 +420,10 @@ where
             || self.3.requires_scoring()
     }
 
-    fn merge_fruits(&self, children: Vec<Self::Fruit>) -> crate::Result<Self::Fruit> {
+    fn merge_fruits(
+        &self,
+        children: Vec<<Self::Child as SegmentCollector>::Fruit>,
+    ) -> crate::Result<Self::Fruit> {
         let mut one_fruits = vec![];
         let mut two_fruits = vec![];
         let mut three_fruits = vec![];

src/collector/multi_collector.rs

@@ -3,7 +3,7 @@ use super::SegmentCollector;
 use crate::collector::Fruit;
 use crate::DocId;
 use crate::Score;
-use crate::SegmentLocalId;
+use crate::SegmentOrdinal;
 use crate::SegmentReader;
 use crate::TantivyError;
 use std::marker::PhantomData;
@@ -34,13 +34,13 @@ impl<TCollector: Collector> Collector for CollectorWrapper<TCollector> {
 
     fn merge_fruits(
         &self,
-        children: Vec<<Self as Collector>::Fruit>,
+        children: Vec<<Self::Child as SegmentCollector>::Fruit>,
     ) -> crate::Result<Box<dyn Fruit>> {
-        let typed_fruit: Vec<TCollector::Fruit> = children
+        let typed_fruit: Vec<<TCollector::Child as SegmentCollector>::Fruit> = children
             .into_iter()
             .map(|untyped_fruit| {
                 untyped_fruit
-                    .downcast::<TCollector::Fruit>()
+                    .downcast::<<TCollector::Child as SegmentCollector>::Fruit>()
                     .map(|boxed_but_typed| *boxed_but_typed)
                     .map_err(|_| {
                         TantivyError::InvalidArgument("Failed to cast child fruit.".to_string())
@@ -55,7 +55,7 @@ impl<TCollector: Collector> Collector for CollectorWrapper<TCollector> {
 impl SegmentCollector for Box<dyn BoxableSegmentCollector> {
     type Fruit = Box<dyn Fruit>;
 
-    fn collect(&mut self, doc: u32, score: f32) {
+    fn collect(&mut self, doc: u32, score: Score) {
         self.as_mut().collect(doc, score);
     }
 
@@ -65,7 +65,7 @@ impl SegmentCollector for Box<dyn BoxableSegmentCollector> {
 }
 
 pub trait BoxableSegmentCollector {
-    fn collect(&mut self, doc: u32, score: f32);
+    fn collect(&mut self, doc: u32, score: Score);
     fn harvest_from_box(self: Box<Self>) -> Box<dyn Fruit>;
 }
 
@@ -74,7 +74,7 @@ pub struct SegmentCollectorWrapper<TSegmentCollector: SegmentCollector>(TSegment
 impl<TSegmentCollector: SegmentCollector> BoxableSegmentCollector
     for SegmentCollectorWrapper<TSegmentCollector>
 {
-    fn collect(&mut self, doc: u32, score: f32) {
+    fn collect(&mut self, doc: u32, score: Score) {
         self.0.collect(doc, score);
     }
 
@@ -175,7 +175,7 @@ impl<'a> Collector for MultiCollector<'a> {
 
     fn for_segment(
         &self,
-        segment_local_id: SegmentLocalId,
+        segment_local_id: SegmentOrdinal,
         segment: &SegmentReader,
     ) -> crate::Result<MultiCollectorChild> {
         let children = self
@@ -259,7 +259,7 @@ mod tests {
 
         let index = Index::create_in_ram(schema);
         {
-            let mut index_writer = index.writer_with_num_threads(1, 3_000_000).unwrap();
+            let mut index_writer = index.writer_for_tests().unwrap();
             index_writer.add_document(doc!(text=>"abc"));
             index_writer.add_document(doc!(text=>"abc abc abc"));
             index_writer.add_document(doc!(text=>"abc abc"));

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::SegmentOrdinal;
+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::new(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
@@ -27,7 +82,7 @@ pub struct TestCollector {
 }
 
 pub struct TestSegmentCollector {
-    segment_id: SegmentLocalId,
+    segment_id: SegmentOrdinal,
     fruit: TestFruit,
 }
 
@@ -53,7 +108,7 @@ impl Collector for TestCollector {
 
     fn for_segment(
         &self,
-        segment_id: SegmentLocalId,
+        segment_id: SegmentOrdinal,
         _reader: &SegmentReader,
     ) -> crate::Result<TestSegmentCollector> {
         Ok(TestSegmentCollector {
@@ -71,7 +126,7 @@ impl Collector for TestCollector {
             if fruit.docs().is_empty() {
                 0
             } else {
-                fruit.docs()[0].segment_ord()
+                fruit.docs()[0].segment_ord
             }
         });
         let mut docs = vec![];
@@ -88,7 +143,7 @@ impl SegmentCollector for TestSegmentCollector {
     type Fruit = TestFruit;
 
     fn collect(&mut self, doc: DocId, score: Score) {
-        self.fruit.docs.push(DocAddress(self.segment_id, doc));
+        self.fruit.docs.push(DocAddress::new(self.segment_id, doc));
         self.fruit.scores.push(score);
     }
 
@@ -122,7 +177,7 @@ impl Collector for FastFieldTestCollector {
 
     fn for_segment(
         &self,
-        _: SegmentLocalId,
+        _: SegmentOrdinal,
         segment_reader: &SegmentReader,
     ) -> crate::Result<FastFieldSegmentCollector> {
         let reader = segment_reader
@@ -185,12 +240,10 @@ impl Collector for BytesFastFieldTestCollector {
         _segment_local_id: u32,
         segment_reader: &SegmentReader,
     ) -> crate::Result<BytesFastFieldSegmentCollector> {
+        let reader = segment_reader.fast_fields().bytes(self.field)?;
         Ok(BytesFastFieldSegmentCollector {
             vals: Vec::new(),
-            reader: segment_reader
-                .fast_fields()
-                .bytes(self.field)
-                .expect("Field is not a bytes fast field."),
+            reader,
         })
     }
 
@@ -206,7 +259,7 @@ impl Collector for BytesFastFieldTestCollector {
 impl SegmentCollector for BytesFastFieldSegmentCollector {
     type Fruit = Vec<u8>;
 
-    fn collect(&mut self, doc: u32, _score: f32) {
+    fn collect(&mut self, doc: u32, _score: Score) {
         let data = self.reader.get_bytes(doc);
         self.vals.extend(data);
     }
@@ -215,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

@@ -1,10 +1,10 @@
 use crate::DocAddress;
 use crate::DocId;
-use crate::SegmentLocalId;
+use crate::SegmentOrdinal;
 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.
 ///
@@ -18,9 +18,9 @@ use std::collections::BinaryHeap;
 /// Two elements are equal if their feature is equal, and regardless of whether `doc`
 /// is equal. This should be perfectly fine for this usage, but let's make sure this
 /// struct is never public.
-struct ComparableDoc<T, D> {
-    feature: T,
-    doc: D,
+pub(crate) struct ComparableDoc<T, D> {
+    pub feature: T,
+    pub doc: D,
 }
 
 impl<T: PartialOrd, D: PartialOrd> PartialOrd for ComparableDoc<T, D> {
@@ -56,7 +56,8 @@ impl<T: PartialOrd, D: PartialOrd> PartialEq for ComparableDoc<T, D> {
 impl<T: PartialOrd, D: PartialOrd> Eq for ComparableDoc<T, D> {}
 
 pub(crate) struct TopCollector<T> {
-    limit: usize,
+    pub limit: usize,
+    pub offset: usize,
     _marker: PhantomData<T>,
 }
 
@@ -72,14 +73,20 @@ where
         if limit < 1 {
             panic!("Limit must be strictly greater than 0.");
         }
-        TopCollector {
+        Self {
             limit,
+            offset: 0,
             _marker: PhantomData,
         }
     }
 
-    pub fn limit(&self) -> usize {
-        self.limit
+    /// Skip the first "offset" documents when collecting.
+    ///
+    /// This is equivalent to `OFFSET` in MySQL or PostgreSQL and `start` in
+    /// Lucene's TopDocsCollector.
+    pub fn and_offset(mut self, offset: usize) -> TopCollector<T> {
+        self.offset = offset;
+        self
     }
 
     pub fn merge_fruits(
@@ -92,7 +99,7 @@ where
         let mut top_collector = BinaryHeap::new();
         for child_fruit in children {
             for (feature, doc) in child_fruit {
-                if top_collector.len() < self.limit {
+                if top_collector.len() < (self.limit + self.offset) {
                     top_collector.push(ComparableDoc { feature, doc });
                 } else if let Some(mut head) = top_collector.peek_mut() {
                     if head.feature < feature {
@@ -104,16 +111,30 @@ where
         Ok(top_collector
             .into_sorted_vec()
             .into_iter()
+            .skip(self.offset)
             .map(|cdoc| (cdoc.feature, cdoc.doc))
             .collect())
     }
 
     pub(crate) fn for_segment<F: PartialOrd>(
         &self,
-        segment_id: SegmentLocalId,
+        segment_id: SegmentOrdinal,
         _: &SegmentReader,
-    ) -> crate::Result<TopSegmentCollector<F>> {
-        Ok(TopSegmentCollector::new(segment_id, self.limit))
+    ) -> TopSegmentCollector<F> {
+        TopSegmentCollector::new(segment_id, self.limit + self.offset)
+    }
+
+    /// Create a new TopCollector with the same limit and offset.
+    ///
+    /// Ideally we would use Into but the blanket implementation seems to cause the Scorer traits
+    /// to fail.
+    #[doc(hidden)]
+    pub(crate) fn into_tscore<TScore: PartialOrd + Clone>(self) -> TopCollector<TScore> {
+        TopCollector {
+            limit: self.limit,
+            offset: self.offset,
+            _marker: PhantomData,
+        }
     }
 }
 
@@ -126,29 +147,32 @@ where
 pub(crate) struct TopSegmentCollector<T> {
     limit: usize,
     heap: BinaryHeap<ComparableDoc<T, DocId>>,
-    segment_id: u32,
+    segment_ord: u32,
 }
 
 impl<T: PartialOrd> TopSegmentCollector<T> {
-    fn new(segment_id: SegmentLocalId, limit: usize) -> TopSegmentCollector<T> {
+    fn new(segment_ord: SegmentOrdinal, limit: usize) -> TopSegmentCollector<T> {
         TopSegmentCollector {
             limit,
             heap: BinaryHeap::with_capacity(limit),
-            segment_id,
+            segment_ord,
         }
     }
 }
 
 impl<T: PartialOrd + Clone> TopSegmentCollector<T> {
     pub fn harvest(self) -> Vec<(T, DocAddress)> {
-        let segment_id = self.segment_id;
+        let segment_ord = self.segment_ord;
         self.heap
             .into_sorted_vec()
             .into_iter()
             .map(|comparable_doc| {
                 (
                     comparable_doc.feature,
-                    DocAddress(segment_id, comparable_doc.doc),
+                    DocAddress {
+                        segment_ord,
+                        doc_id: comparable_doc.doc,
+                    },
                 )
             })
             .collect()
@@ -187,7 +211,7 @@ impl<T: PartialOrd + Clone> TopSegmentCollector<T> {
 
 #[cfg(test)]
 mod tests {
-    use super::TopSegmentCollector;
+    use super::{TopCollector, TopSegmentCollector};
     use crate::DocAddress;
 
     #[test]
@@ -199,9 +223,9 @@ mod tests {
         assert_eq!(
             top_collector.harvest(),
             vec![
-                (0.8, DocAddress(0, 1)),
-                (0.3, DocAddress(0, 5)),
-                (0.2, DocAddress(0, 3))
+                (0.8, DocAddress::new(0, 1)),
+                (0.3, DocAddress::new(0, 5)),
+                (0.2, DocAddress::new(0, 3))
             ]
         );
     }
@@ -217,10 +241,10 @@ mod tests {
         assert_eq!(
             top_collector.harvest(),
             vec![
-                (0.9, DocAddress(0, 7)),
-                (0.8, DocAddress(0, 1)),
-                (0.3, DocAddress(0, 5)),
-                (0.2, DocAddress(0, 3))
+                (0.9, DocAddress::new(0, 7)),
+                (0.8, DocAddress::new(0, 1)),
+                (0.3, DocAddress::new(0, 5)),
+                (0.2, DocAddress::new(0, 3))
             ]
         );
     }
@@ -248,6 +272,54 @@ mod tests {
             top_collector_limit_3.harvest()[..2].to_vec(),
         );
     }
+
+    #[test]
+    fn test_top_collector_with_limit_and_offset() {
+        let collector = TopCollector::with_limit(2).and_offset(1);
+
+        let results = collector
+            .merge_fruits(vec![vec![
+                (0.9, DocAddress::new(0, 1)),
+                (0.8, DocAddress::new(0, 2)),
+                (0.7, DocAddress::new(0, 3)),
+                (0.6, DocAddress::new(0, 4)),
+                (0.5, DocAddress::new(0, 5)),
+            ]])
+            .unwrap();
+
+        assert_eq!(
+            results,
+            vec![(0.8, DocAddress::new(0, 2)), (0.7, DocAddress::new(0, 3)),]
+        );
+    }
+
+    #[test]
+    fn test_top_collector_with_limit_larger_than_set_and_offset() {
+        let collector = TopCollector::with_limit(2).and_offset(1);
+
+        let results = collector
+            .merge_fruits(vec![vec![
+                (0.9, DocAddress::new(0, 1)),
+                (0.8, DocAddress::new(0, 2)),
+            ]])
+            .unwrap();
+
+        assert_eq!(results, vec![(0.8, DocAddress::new(0, 2)),]);
+    }
+
+    #[test]
+    fn test_top_collector_with_limit_and_offset_larger_than_set() {
+        let collector = TopCollector::with_limit(2).and_offset(20);
+
+        let results = collector
+            .merge_fruits(vec![vec![
+                (0.9, DocAddress::new(0, 1)),
+                (0.8, DocAddress::new(0, 2)),
+            ]])
+            .unwrap();
+
+        assert_eq!(results, vec![]);
+    }
 }
 
 #[cfg(all(test, feature = "unstable"))]

src/collector/top_score_collector.rs

@@ -1,19 +1,82 @@
 use super::Collector;
-use crate::collector::custom_score_top_collector::CustomScoreTopCollector;
-use crate::collector::top_collector::TopCollector;
-use crate::collector::top_collector::TopSegmentCollector;
+use crate::collector::top_collector::{ComparableDoc, TopCollector};
 use crate::collector::tweak_score_top_collector::TweakedScoreTopCollector;
 use crate::collector::{
     CustomScorer, CustomSegmentScorer, ScoreSegmentTweaker, ScoreTweaker, SegmentCollector,
 };
 use crate::fastfield::FastFieldReader;
+use crate::query::Weight;
 use crate::schema::Field;
 use crate::DocAddress;
 use crate::DocId;
 use crate::Score;
-use crate::SegmentLocalId;
+use crate::SegmentOrdinal;
 use crate::SegmentReader;
+use crate::{collector::custom_score_top_collector::CustomScoreTopCollector, fastfield::FastValue};
+use crate::{collector::top_collector::TopSegmentCollector, TantivyError};
 use std::fmt;
+use std::{collections::BinaryHeap, marker::PhantomData};
+
+struct FastFieldConvertCollector<
+    TCollector: Collector<Fruit = Vec<(u64, DocAddress)>>,
+    TFastValue: FastValue,
+> {
+    pub collector: TCollector,
+    pub field: Field,
+    pub fast_value: std::marker::PhantomData<TFastValue>,
+}
+
+impl<TCollector, TFastValue> Collector for FastFieldConvertCollector<TCollector, TFastValue>
+where
+    TCollector: Collector<Fruit = Vec<(u64, DocAddress)>>,
+    TFastValue: FastValue,
+{
+    type Fruit = Vec<(TFastValue, DocAddress)>;
+
+    type Child = TCollector::Child;
+
+    fn for_segment(
+        &self,
+        segment_local_id: crate::SegmentOrdinal,
+        segment: &SegmentReader,
+    ) -> crate::Result<Self::Child> {
+        let schema = segment.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 schema_type = TFastValue::to_type();
+        let requested_type = field_entry.field_type().value_type();
+        if schema_type != requested_type {
+            return Err(TantivyError::SchemaError(format!(
+                "Field {:?} is of type {:?}!={:?}",
+                field_entry.name(),
+                schema_type,
+                requested_type
+            )));
+        }
+        self.collector.for_segment(segment_local_id, segment)
+    }
+
+    fn requires_scoring(&self) -> bool {
+        self.collector.requires_scoring()
+    }
+
+    fn merge_fruits(
+        &self,
+        segment_fruits: Vec<<Self::Child as SegmentCollector>::Fruit>,
+    ) -> crate::Result<Self::Fruit> {
+        let raw_result = self.collector.merge_fruits(segment_fruits)?;
+        let transformed_result = raw_result
+            .into_iter()
+            .map(|(score, doc_address)| (TFastValue::from_u64(score), doc_address))
+            .collect::<Vec<_>>();
+        Ok(transformed_result)
+    }
+}
 
 /// The `TopDocs` collector keeps track of the top `K` documents
 /// sorted by their score.
@@ -36,7 +99,7 @@ use std::fmt;
 /// let schema = schema_builder.build();
 /// let index = Index::create_in_ram(schema);
 ///
-/// let mut index_writer = index.writer_with_num_threads(1, 3_000_000).unwrap();
+/// 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"));
 /// index_writer.add_document(doc!(title => "The Diary of Muadib"));
 /// index_writer.add_document(doc!(title => "A Dairy Cow"));
@@ -50,14 +113,18 @@ use std::fmt;
 /// let query = query_parser.parse_query("diary").unwrap();
 /// let top_docs = searcher.search(&query, &TopDocs::with_limit(2)).unwrap();
 ///
-/// assert_eq!(&top_docs[0], &(0.7261542, DocAddress(0, 1)));
-/// assert_eq!(&top_docs[1], &(0.6099695, DocAddress(0, 3)));
+/// assert_eq!(top_docs[0].1, DocAddress::new(0, 1));
+/// assert_eq!(top_docs[1].1, DocAddress::new(0, 3));
 /// ```
 pub struct TopDocs(TopCollector<Score>);
 
 impl fmt::Debug for TopDocs {
     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
-        write!(f, "TopDocs({})", self.0.limit())
+        write!(
+            f,
+            "TopDocs(limit={}, offset={})",
+            self.0.limit, self.0.offset
+        )
     }
 }
 
@@ -66,8 +133,8 @@ struct ScorerByFastFieldReader {
 }
 
 impl CustomSegmentScorer<u64> for ScorerByFastFieldReader {
-    fn score(&self, doc: DocId) -> u64 {
-        self.ff_reader.get_u64(u64::from(doc))
+    fn score(&mut self, doc: DocId) -> u64 {
+        self.ff_reader.get(doc)
     }
 }
 
@@ -79,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(self.field)
-            .ok_or_else(|| {
-                crate::TantivyError::SchemaError(format!(
-                    "Field requested ({:?}) is not a i64/u64 fast field.",
-                    self.field
-                ))
-            })?;
+            .typed_fast_field_reader(self.field)?;
         Ok(ScorerByFastFieldReader { ff_reader })
     }
 }
@@ -101,8 +167,57 @@ impl TopDocs {
         TopDocs(TopCollector::with_limit(limit))
     }
 
+    /// Skip the first "offset" documents when collecting.
+    ///
+    /// This is equivalent to `OFFSET` in MySQL or PostgreSQL and `start` in
+    /// Lucene's TopDocsCollector.
+    ///
+    /// # Example
+    ///
+    /// ```rust
+    /// use tantivy::collector::TopDocs;
+    /// use tantivy::query::QueryParser;
+    /// use tantivy::schema::{Schema, TEXT};
+    /// use tantivy::{doc, DocAddress, Index};
+    ///
+    /// let mut schema_builder = Schema::builder();
+    /// let title = schema_builder.add_text_field("title", TEXT);
+    /// 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"));
+    /// index_writer.add_document(doc!(title => "The Diary of Muadib"));
+    /// index_writer.add_document(doc!(title => "A Dairy Cow"));
+    /// index_writer.add_document(doc!(title => "The Diary of a Young Girl"));
+    /// index_writer.add_document(doc!(title => "The Diary of Lena Mukhina"));
+    /// 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 top_docs = searcher.search(&query, &TopDocs::with_limit(2).and_offset(1)).unwrap();
+    ///
+    /// assert_eq!(top_docs.len(), 2);
+    /// assert_eq!(top_docs[0].1, DocAddress::new(0, 4));
+    /// assert_eq!(top_docs[1].1, DocAddress::new(0, 3));
+    /// ```
+    pub fn and_offset(self, offset: usize) -> TopDocs {
+        TopDocs(self.0.and_offset(offset))
+    }
+
     /// Set top-K to rank documents by a given fast field.
     ///
+    /// If the field is not a fast or does not exist, this method returns successfully (it is not aware of any schema).
+    /// An error will be returned at the moment of search.
+    ///
+    /// If the field is a FAST field but not a u64 field, search will return successfully but it will return
+    /// returns a monotonic u64-representation (ie. the order is still correct) of the requested field type.
+    ///
+    /// # Example
+    ///
     /// ```rust
     /// # use tantivy::schema::{Schema, FAST, TEXT};
     /// # use tantivy::{doc, Index, DocAddress};
@@ -116,42 +231,37 @@ 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, 3_000_000)?;
+    /// #   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));
     /// #   index_writer.add_document(doc!(title => "The Diary of Muadib", rating => 97u64));
     /// #   index_writer.add_document(doc!(title => "A Dairy Cow", rating => 63u64));
     /// #   index_writer.add_document(doc!(title => "The Diary of a Young Girl", rating => 80u64));
     /// #   assert!(index_writer.commit().is_ok());
-    /// #   let reader = index.reader().unwrap();
+    /// #   let reader = index.reader()?;
     /// #   let query = QueryParser::for_index(&index, vec![title]).parse_query("diary")?;
     /// #   let top_docs = docs_sorted_by_rating(&reader.searcher(), &query, rating)?;
     /// #   assert_eq!(top_docs,
-    /// #            vec![(97u64, DocAddress(0u32, 1)),
-    /// #                 (80u64, DocAddress(0u32, 3))]);
+    /// #            vec![(97u64, DocAddress::new(0u32, 1)),
+    /// #                 (80u64, DocAddress::new(0u32, 3))]);
     /// #   Ok(())
     /// # }
-    ///
-    ///
     /// /// Searches the document matching the given query, and
     /// /// collects the top 10 documents, order by the u64-`field`
     /// /// given in argument.
-    /// ///
-    /// /// `field` is required to be a FAST field.
     /// fn docs_sorted_by_rating(searcher: &Searcher,
     ///                          query: &dyn Query,
-    ///                          sort_by_field: Field)
+    ///                          rating_field: Field)
     ///     -> tantivy::Result<Vec<(u64, DocAddress)>> {
     ///
     ///     // This is where we build our topdocs collector
     ///     //
-    ///     // Note the generics parameter that needs to match the
-    ///     // type `sort_by_field`.
-    ///     let top_docs_by_rating = TopDocs
+    ///     // Note the `rating_field` needs to be a FAST field here.
+    ///     let top_books_by_rating = TopDocs
     ///                 ::with_limit(10)
-    ///                  .order_by_u64_field(sort_by_field);
-    ///     
+    ///                  .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.
@@ -160,21 +270,105 @@ impl TopDocs {
     ///     // length of 10, or less if not enough documents matched the
     ///     // query.
     ///     let resulting_docs: Vec<(u64, DocAddress)> =
-    ///          searcher.search(query, &top_docs_by_rating)?;
-    ///     
+    ///          searcher.search(query, &top_books_by_rating)?;
+    ///
     ///     Ok(resulting_docs)
     /// }
     /// ```
     ///
-    /// # Panics
-    ///
-    /// May panic if the field requested is not a fast field.
+    /// # 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(
         self,
         field: Field,
     ) -> impl Collector<Fruit = Vec<(u64, DocAddress)>> {
-        self.custom_score(ScorerByField { field })
+        CustomScoreTopCollector::new(ScorerByField { field }, self.0.into_tscore())
+    }
+
+    /// 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,
+    /// 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
+    /// inferred in your code by the rust compiler.
+    ///
+    /// Implementation-wise, for performance reason, tantivy will manipulate the u64 representation of your fast
+    /// field until the last moment.
+    ///
+    /// # Example
+    ///
+    /// ```rust
+    /// # use tantivy::schema::{Schema, FAST, TEXT};
+    /// # use tantivy::{doc, Index, DocAddress};
+    /// # use tantivy::query::{Query, AllQuery};
+    /// use tantivy::Searcher;
+    /// use tantivy::collector::TopDocs;
+    /// use tantivy::schema::Field;
+    ///
+    /// # fn main() -> tantivy::Result<()> {
+    /// #   let mut schema_builder = Schema::builder();
+    /// #   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));
+    /// #   index_writer.add_document(doc!(title => "Zozo Cow KKK", rating => 119_000_000i64));
+    /// #   index_writer.add_document(doc!(title => "Declining Cow", rating => -63_000_000i64));
+    /// #   assert!(index_writer.commit().is_ok());
+    /// #   let reader = index.reader()?;
+    /// #   let top_docs = docs_sorted_by_revenue(&reader.searcher(), &AllQuery, rating)?;
+    /// #   assert_eq!(top_docs,
+    /// #            vec![(119_000_000i64, DocAddress::new(0, 1)),
+    /// #                 (92_000_000i64, DocAddress::new(0, 0))]);
+    /// #   Ok(())
+    /// # }
+    /// /// Searches the document matching the given query, and
+    /// /// collects the top 10 documents, order by the u64-`field`
+    /// /// given in argument.
+    /// fn docs_sorted_by_revenue(searcher: &Searcher,
+    ///                          query: &dyn Query,
+    ///                          revenue_field: Field)
+    ///     -> tantivy::Result<Vec<(i64, DocAddress)>> {
+    ///
+    ///     // This is where we build our topdocs collector
+    ///     //
+    ///     // Note the generics parameter that needs to match the
+    ///     // type `sort_by_field`. revenue_field here is a FAST i64 field.
+    ///     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.
+    ///     //
+    ///     // The vec is sorted decreasingly by `sort_by_field`, and has a
+    ///     // length of 10, or less if not enough documents matched the
+    ///     // query.
+    ///     let resulting_docs: Vec<(i64, DocAddress)> =
+    ///          searcher.search(query, &top_company_by_revenue)?;
+    ///
+    ///     Ok(resulting_docs)
+    /// }
+    /// ```
+    pub fn order_by_fast_field<TFastValue>(
+        self,
+        fast_field: Field,
+    ) -> impl Collector<Fruit = Vec<(TFastValue, DocAddress)>>
+    where
+        TFastValue: FastValue,
+    {
+        let u64_collector = self.order_by_u64_field(fast_field);
+        FastFieldConvertCollector {
+            collector: u64_collector,
+            field: fast_field,
+            fast_value: PhantomData,
+        }
     }
 
     /// Ranks the documents using a custom score.
@@ -197,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
     ///
@@ -219,7 +413,7 @@ impl TopDocs {
     /// fn create_index() -> tantivy::Result<Index> {
     ///   let schema = create_schema();
     ///   let index = Index::create_in_ram(schema);
-    ///   let mut index_writer = index.writer_with_num_threads(1, 3_000_000)?;
+    ///   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();
     ///   index_writer.add_document(doc!(product_name => "The Diary of Muadib", popularity => 1u64));
@@ -258,7 +452,7 @@ impl TopDocs {
     ///                 let popularity: u64 = popularity_reader.get(doc);
     ///                 // Well.. For the sake of the example we use a simple logarithm
     ///                 // function.
-    ///                 let popularity_boost_score = ((2u64 + popularity) as f32).log2();
+    ///                 let popularity_boost_score = ((2u64 + popularity) as Score).log2();
     ///                 popularity_boost_score * original_score
     ///             }
     ///           });
@@ -279,9 +473,9 @@ impl TopDocs {
     where
         TScore: 'static + Send + Sync + Clone + PartialOrd,
         TScoreSegmentTweaker: ScoreSegmentTweaker<TScore> + 'static,
-        TScoreTweaker: ScoreTweaker<TScore, Child = TScoreSegmentTweaker>,
+        TScoreTweaker: ScoreTweaker<TScore, Child = TScoreSegmentTweaker> + Send + Sync,
     {
-        TweakedScoreTopCollector::new(score_tweaker, self.0.limit())
+        TweakedScoreTopCollector::new(score_tweaker, self.0.into_tscore())
     }
 
     /// Ranks the documents using a custom score.
@@ -326,9 +520,9 @@ impl TopDocs {
     /// # fn main() -> tantivy::Result<()> {
     /// #   let schema = create_schema();
     /// #   let index = Index::create_in_ram(schema);
-    /// #   let mut index_writer = index.writer_with_num_threads(1, 3_000_000)?;
+    /// #   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));
@@ -362,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);
@@ -393,9 +587,9 @@ impl TopDocs {
     where
         TScore: 'static + Send + Sync + Clone + PartialOrd,
         TCustomSegmentScorer: CustomSegmentScorer<TScore> + 'static,
-        TCustomScorer: CustomScorer<TScore, Child = TCustomSegmentScorer>,
+        TCustomScorer: CustomScorer<TScore, Child = TCustomSegmentScorer> + Send + Sync,
     {
-        CustomScoreTopCollector::new(custom_score, self.0.limit())
+        CustomScoreTopCollector::new(custom_score, self.0.into_tscore())
     }
 }
 
@@ -406,10 +600,10 @@ impl Collector for TopDocs {
 
     fn for_segment(
         &self,
-        segment_local_id: SegmentLocalId,
+        segment_local_id: SegmentOrdinal,
         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))
     }
 
@@ -423,6 +617,72 @@ impl Collector for TopDocs {
     ) -> crate::Result<Self::Fruit> {
         self.0.merge_fruits(child_fruits)
     }
+
+    fn collect_segment(
+        &self,
+        weight: &dyn Weight,
+        segment_ord: u32,
+        reader: &SegmentReader,
+    ) -> crate::Result<<Self::Child as SegmentCollector>::Fruit> {
+        let heap_len = self.0.limit + self.0.offset;
+        let mut heap: BinaryHeap<ComparableDoc<Score, DocId>> = BinaryHeap::with_capacity(heap_len);
+
+        if let Some(delete_bitset) = reader.delete_bitset() {
+            let mut threshold = Score::MIN;
+            weight.for_each_pruning(threshold, reader, &mut |doc, score| {
+                if delete_bitset.is_deleted(doc) {
+                    return threshold;
+                }
+                let heap_item = ComparableDoc {
+                    feature: score,
+                    doc,
+                };
+                if heap.len() < heap_len {
+                    heap.push(heap_item);
+                    if heap.len() == heap_len {
+                        threshold = heap.peek().map(|el| el.feature).unwrap_or(Score::MIN);
+                    }
+                    return threshold;
+                }
+                *heap.peek_mut().unwrap() = heap_item;
+                threshold = heap.peek().map(|el| el.feature).unwrap_or(Score::MIN);
+                threshold
+            })?;
+        } else {
+            weight.for_each_pruning(Score::MIN, reader, &mut |doc, score| {
+                let heap_item = ComparableDoc {
+                    feature: score,
+                    doc,
+                };
+                if heap.len() < heap_len {
+                    heap.push(heap_item);
+                    // TODO the threshold is suboptimal for heap.len == heap_len
+                    if heap.len() == heap_len {
+                        return heap.peek().map(|el| el.feature).unwrap_or(Score::MIN);
+                    } else {
+                        return Score::MIN;
+                    }
+                }
+                *heap.peek_mut().unwrap() = heap_item;
+                heap.peek().map(|el| el.feature).unwrap_or(Score::MIN)
+            })?;
+        }
+
+        let fruit = heap
+            .into_sorted_vec()
+            .into_iter()
+            .map(|cid| {
+                (
+                    cid.feature,
+                    DocAddress {
+                        segment_ord,
+                        doc_id: cid.doc,
+                    },
+                )
+            })
+            .collect();
+        Ok(fruit)
+    }
 }
 
 /// Segment Collector associated to `TopDocs`.
@@ -432,7 +692,7 @@ impl SegmentCollector for TopScoreSegmentCollector {
     type Fruit = Vec<(Score, DocAddress)>;
 
     fn collect(&mut self, doc: DocId, score: Score) {
-        self.0.collect(doc, score)
+        self.0.collect(doc, score);
     }
 
     fn harvest(self) -> Vec<(Score, DocAddress)> {
@@ -446,10 +706,10 @@ mod tests {
     use crate::collector::Collector;
     use crate::query::{AllQuery, Query, QueryParser};
     use crate::schema::{Field, Schema, FAST, STORED, TEXT};
-    use crate::DocAddress;
     use crate::Index;
     use crate::IndexWriter;
     use crate::Score;
+    use crate::{DocAddress, DocId, SegmentReader};
 
     fn make_index() -> Index {
         let mut schema_builder = Schema::builder();
@@ -458,7 +718,7 @@ mod tests {
         let index = Index::create_in_ram(schema);
         {
             // writing the segment
-            let mut index_writer = index.writer_with_num_threads(1, 3_000_000).unwrap();
+            let mut index_writer = index.writer_with_num_threads(1, 10_000_000).unwrap();
             index_writer.add_document(doc!(text_field=>"Hello happy tax payer."));
             index_writer.add_document(doc!(text_field=>"Droopy says hello happy tax payer"));
             index_writer.add_document(doc!(text_field=>"I like Droopy"));
@@ -467,8 +727,15 @@ mod tests {
         index
     }
 
+    fn assert_results_equals(results: &[(Score, DocAddress)], expected: &[(Score, DocAddress)]) {
+        for (result, expected) in results.iter().zip(expected.iter()) {
+            assert_eq!(result.1, expected.1);
+            crate::assert_nearly_equals!(result.0, expected.0);
+        }
+    }
+
     #[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]);
@@ -479,16 +746,31 @@ mod tests {
             .searcher()
             .search(&text_query, &TopDocs::with_limit(4))
             .unwrap();
-        assert_eq!(
-            score_docs,
-            vec![
-                (0.81221175, DocAddress(0u32, 1)),
-                (0.5376842, DocAddress(0u32, 2)),
-                (0.48527452, DocAddress(0, 0))
-            ]
+        assert_results_equals(
+            &score_docs,
+            &[
+                (0.81221175, DocAddress::new(0u32, 1)),
+                (0.5376842, DocAddress::new(0u32, 2)),
+                (0.48527452, DocAddress::new(0, 0)),
+            ],
         );
     }
 
+    #[test]
+    fn test_top_collector_not_at_capacity_with_offset() {
+        let index = make_index();
+        let field = index.schema().get_field("text").unwrap();
+        let query_parser = QueryParser::for_index(&index, vec![field]);
+        let text_query = query_parser.parse_query("droopy tax").unwrap();
+        let score_docs: Vec<(Score, DocAddress)> = index
+            .reader()
+            .unwrap()
+            .searcher()
+            .search(&text_query, &TopDocs::with_limit(4).and_offset(2))
+            .unwrap();
+        assert_results_equals(&score_docs[..], &[(0.48527452, DocAddress::new(0, 0))]);
+    }
+
     #[test]
     fn test_top_collector_at_capacity() {
         let index = make_index();
@@ -501,12 +783,33 @@ mod tests {
             .searcher()
             .search(&text_query, &TopDocs::with_limit(2))
             .unwrap();
-        assert_eq!(
-            score_docs,
-            vec![
-                (0.81221175, DocAddress(0u32, 1)),
-                (0.5376842, DocAddress(0u32, 2)),
-            ]
+        assert_results_equals(
+            &score_docs,
+            &[
+                (0.81221175, DocAddress::new(0u32, 1)),
+                (0.5376842, DocAddress::new(0u32, 2)),
+            ],
+        );
+    }
+
+    #[test]
+    fn test_top_collector_at_capacity_with_offset() {
+        let index = make_index();
+        let field = index.schema().get_field("text").unwrap();
+        let query_parser = QueryParser::for_index(&index, vec![field]);
+        let text_query = query_parser.parse_query("droopy tax").unwrap();
+        let score_docs: Vec<(Score, DocAddress)> = index
+            .reader()
+            .unwrap()
+            .searcher()
+            .search(&text_query, &TopDocs::with_limit(2).and_offset(1))
+            .unwrap();
+        assert_results_equals(
+            &score_docs[..],
+            &[
+                (0.5376842, DocAddress::new(0u32, 2)),
+                (0.48527452, DocAddress::new(0, 0)),
+            ],
         );
     }
 
@@ -567,15 +870,109 @@ mod tests {
         let top_collector = TopDocs::with_limit(4).order_by_u64_field(size);
         let top_docs: Vec<(u64, DocAddress)> = searcher.search(&query, &top_collector).unwrap();
         assert_eq!(
-            top_docs,
-            vec![
-                (64, DocAddress(0, 1)),
-                (16, DocAddress(0, 2)),
-                (12, DocAddress(0, 0))
+            &top_docs[..],
+            &[
+                (64, DocAddress::new(0, 1)),
+                (16, DocAddress::new(0, 2)),
+                (12, DocAddress::new(0, 0))
             ]
         );
     }
 
+    #[test]
+    fn test_top_field_collector_datetime() -> crate::Result<()> {
+        use std::str::FromStr;
+        let mut schema_builder = Schema::builder();
+        let name = schema_builder.add_text_field("name", TEXT);
+        let birthday = schema_builder.add_date_field("birthday", FAST);
+        let schema = schema_builder.build();
+        let index = Index::create_in_ram(schema);
+        let mut index_writer = index.writer_for_tests()?;
+        let pr_birthday = crate::DateTime::from_str("1898-04-09T00:00:00+00:00")?;
+        index_writer.add_document(doc!(
+            name => "Paul Robeson",
+            birthday => pr_birthday
+        ));
+        let mr_birthday = crate::DateTime::from_str("1947-11-08T00:00:00+00:00")?;
+        index_writer.add_document(doc!(
+            name => "Minnie Riperton",
+            birthday => mr_birthday
+        ));
+        index_writer.commit()?;
+        let searcher = index.reader()?.searcher();
+        let top_collector = TopDocs::with_limit(3).order_by_fast_field(birthday);
+        let top_docs: Vec<(crate::DateTime, DocAddress)> =
+            searcher.search(&AllQuery, &top_collector)?;
+        assert_eq!(
+            &top_docs[..],
+            &[
+                (mr_birthday, DocAddress::new(0, 1)),
+                (pr_birthday, DocAddress::new(0, 0)),
+            ]
+        );
+        Ok(())
+    }
+
+    #[test]
+    fn test_top_field_collector_i64() -> crate::Result<()> {
+        let mut schema_builder = Schema::builder();
+        let city = schema_builder.add_text_field("city", TEXT);
+        let altitude = schema_builder.add_i64_field("altitude", FAST);
+        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!(
+                city => "georgetown",
+                altitude =>  -1i64,
+        ));
+        index_writer.add_document(doc!(
+            city => "tokyo",
+            altitude =>  40i64,
+        ));
+        index_writer.commit()?;
+        let searcher = index.reader()?.searcher();
+        let top_collector = TopDocs::with_limit(3).order_by_fast_field(altitude);
+        let top_docs: Vec<(i64, DocAddress)> = searcher.search(&AllQuery, &top_collector)?;
+        assert_eq!(
+            &top_docs[..],
+            &[
+                (40i64, DocAddress::new(0, 1)),
+                (-1i64, DocAddress::new(0, 0)),
+            ]
+        );
+        Ok(())
+    }
+
+    #[test]
+    fn test_top_field_collector_f64() -> crate::Result<()> {
+        let mut schema_builder = Schema::builder();
+        let city = schema_builder.add_text_field("city", TEXT);
+        let altitude = schema_builder.add_f64_field("altitude", FAST);
+        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!(
+                city => "georgetown",
+                altitude =>  -1.0f64,
+        ));
+        index_writer.add_document(doc!(
+            city => "tokyo",
+            altitude =>  40f64,
+        ));
+        index_writer.commit()?;
+        let searcher = index.reader()?.searcher();
+        let top_collector = TopDocs::with_limit(3).order_by_fast_field(altitude);
+        let top_docs: Vec<(f64, DocAddress)> = searcher.search(&AllQuery, &top_collector)?;
+        assert_eq!(
+            &top_docs[..],
+            &[
+                (40f64, DocAddress::new(0, 1)),
+                (-1.0f64, DocAddress::new(0, 0)),
+            ]
+        );
+        Ok(())
+    }
+
     #[test]
     #[should_panic]
     fn test_field_does_not_exist() {
@@ -598,29 +995,83 @@ mod tests {
     }
 
     #[test]
-    fn test_field_not_fast_field() {
+    fn test_field_not_fast_field() -> crate::Result<()> {
         let mut schema_builder = Schema::builder();
-        let title = schema_builder.add_text_field(TITLE, TEXT);
         let size = schema_builder.add_u64_field(SIZE, STORED);
         let schema = schema_builder.build();
-        let (index, _) = index("beer", title, schema, |index_writer| {
-            index_writer.add_document(doc!(
-                title => "bottle of beer",
-                size => 12u64,
-            ));
-        });
-        let searcher = index.reader().unwrap().searcher();
+        let index = Index::create_in_ram(schema);
+        let mut index_writer = index.writer_for_tests()?;
+        index_writer.add_document(doc!(size=>1u64));
+        index_writer.commit()?;
+        let searcher = index.reader()?.searcher();
         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);
-        if let Err(crate::TantivyError::SchemaError(msg)) = err {
-            assert_eq!(
-                msg,
-                "Field requested (Field(1)) is not a i64/u64 fast field."
-            );
-        } else {
-            assert!(false);
-        }
+        let err = top_collector.for_segment(0, segment).err().unwrap();
+        assert!(matches!(err, crate::TantivyError::SchemaError(_)));
+        Ok(())
+    }
+
+    #[test]
+    fn test_field_wrong_type() -> crate::Result<()> {
+        let mut schema_builder = Schema::builder();
+        let size = schema_builder.add_u64_field(SIZE, 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!(size=>1u64));
+        index_writer.commit()?;
+        let searcher = index.reader()?.searcher();
+        let segment = searcher.segment_reader(0);
+        let top_collector = TopDocs::with_limit(4).order_by_fast_field::<i64>(size);
+        let err = top_collector.for_segment(0, segment).err().unwrap();
+        assert!(
+            matches!(err, crate::TantivyError::SchemaError(msg) if msg == "Field \"size\" is not a fast field.")
+        );
+        Ok(())
+    }
+
+    #[test]
+    fn test_tweak_score_top_collector_with_offset() {
+        let index = make_index();
+        let field = index.schema().get_field("text").unwrap();
+        let query_parser = QueryParser::for_index(&index, vec![field]);
+        let text_query = query_parser.parse_query("droopy tax").unwrap();
+        let collector = TopDocs::with_limit(2).and_offset(1).tweak_score(
+            move |_segment_reader: &SegmentReader| move |doc: DocId, _original_score: Score| doc,
+        );
+        let score_docs: Vec<(u32, DocAddress)> = index
+            .reader()
+            .unwrap()
+            .searcher()
+            .search(&text_query, &collector)
+            .unwrap();
+
+        assert_eq!(
+            score_docs,
+            vec![(1, DocAddress::new(0, 1)), (0, DocAddress::new(0, 0)),]
+        );
+    }
+
+    #[test]
+    fn test_custom_score_top_collector_with_offset() {
+        let index = make_index();
+        let field = index.schema().get_field("text").unwrap();
+        let query_parser = QueryParser::for_index(&index, vec![field]);
+        let text_query = query_parser.parse_query("droopy tax").unwrap();
+        let collector = TopDocs::with_limit(2)
+            .and_offset(1)
+            .custom_score(move |_segment_reader: &SegmentReader| move |doc: DocId| doc);
+        let score_docs: Vec<(u32, DocAddress)> = index
+            .reader()
+            .unwrap()
+            .searcher()
+            .search(&text_query, &collector)
+            .unwrap();
+
+        assert_eq!(
+            score_docs,
+            vec![(1, DocAddress::new(0, 1)), (0, DocAddress::new(0, 0)),]
+        );
     }
 
     fn index(
@@ -630,8 +1081,7 @@ mod tests {
         mut doc_adder: impl FnMut(&mut IndexWriter) -> (),
     ) -> (Index, Box<dyn Query>) {
         let index = Index::create_in_ram(schema);
-
-        let mut index_writer = index.writer_with_num_threads(1, 3_000_000).unwrap();
+        let mut index_writer = index.writer_with_num_threads(1, 10_000_000).unwrap();
         doc_adder(&mut index_writer);
         index_writer.commit().unwrap();
         let query_parser = QueryParser::for_index(&index, vec![query_field]);

src/collector/tweak_score_top_collector.rs

@@ -14,11 +14,11 @@ where
 {
     pub fn new(
         score_tweaker: TScoreTweaker,
-        limit: usize,
+        collector: TopCollector<TScore>,
     ) -> TweakedScoreTopCollector<TScoreTweaker, TScore> {
         TweakedScoreTopCollector {
             score_tweaker,
-            collector: TopCollector::with_limit(limit),
+            collector,
         }
     }
 }
@@ -29,7 +29,7 @@ where
 /// It is the segment local version of the [`ScoreTweaker`](./trait.ScoreTweaker.html).
 pub trait ScoreSegmentTweaker<TScore>: 'static {
     /// Tweak the given `score` for the document `doc`.
-    fn score(&self, doc: DocId, score: Score) -> TScore;
+    fn score(&mut self, doc: DocId, score: Score) -> TScore;
 }
 
 /// `ScoreTweaker` makes it possible to tweak the score
@@ -49,7 +49,7 @@ pub trait ScoreTweaker<TScore>: Sync {
 
 impl<TScoreTweaker, TScore> Collector for TweakedScoreTopCollector<TScoreTweaker, TScore>
 where
-    TScoreTweaker: ScoreTweaker<TScore>,
+    TScoreTweaker: ScoreTweaker<TScore> + Send + Sync,
     TScore: 'static + PartialOrd + Clone + Send + Sync,
 {
     type Fruit = Vec<(TScore, DocAddress)>;
@@ -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,
@@ -121,9 +119,9 @@ where
 
 impl<F, TScore> ScoreSegmentTweaker<TScore> for F
 where
-    F: 'static + Sync + Send + Fn(DocId, Score) -> TScore,
+    F: 'static + FnMut(DocId, Score) -> TScore,
 {
-    fn score(&self, doc: DocId, score: Score) -> TScore {
+    fn score(&mut self, doc: DocId, score: Score) -> TScore {
         (self)(doc, score)
     }
 }

src/common/bitpacker.rs

@@ -1,6 +1,7 @@
 use byteorder::{ByteOrder, LittleEndian, WriteBytesExt};
 use std::io;
-use std::ops::Deref;
+
+use crate::directory::OwnedBytes;
 
 pub(crate) struct BitPacker {
     mini_buffer: u64,
@@ -60,20 +61,14 @@ impl BitPacker {
 }
 
 #[derive(Clone)]
-pub struct BitUnpacker<Data>
-where
-    Data: Deref<Target = [u8]>,
-{
+pub struct BitUnpacker {
     num_bits: u64,
     mask: u64,
-    data: Data,
+    data: OwnedBytes,
 }
 
-impl<Data> BitUnpacker<Data>
-where
-    Data: Deref<Target = [u8]>,
-{
-    pub fn new(data: Data, num_bits: u8) -> BitUnpacker<Data> {
+impl BitUnpacker {
+    pub fn new(data: OwnedBytes, num_bits: u8) -> BitUnpacker {
         let mask: u64 = if num_bits == 64 {
             !0u64
         } else {
@@ -90,7 +85,7 @@ where
         if self.num_bits == 0 {
             return 0u64;
         }
-        let data: &[u8] = &*self.data;
+        let data: &[u8] = self.data.as_slice();
         let num_bits = self.num_bits;
         let mask = self.mask;
         let addr_in_bits = idx * num_bits;
@@ -109,8 +104,9 @@ where
 #[cfg(test)]
 mod test {
     use super::{BitPacker, BitUnpacker};
+    use crate::directory::OwnedBytes;
 
-    fn create_fastfield_bitpacker(len: usize, num_bits: u8) -> (BitUnpacker<Vec<u8>>, Vec<u64>) {
+    fn create_fastfield_bitpacker(len: usize, num_bits: u8) -> (BitUnpacker, Vec<u64>) {
         let mut data = Vec::new();
         let mut bitpacker = BitPacker::new();
         let max_val: u64 = (1u64 << num_bits as u64) - 1u64;
@@ -122,7 +118,7 @@ mod test {
         }
         bitpacker.close(&mut data).unwrap();
         assert_eq!(data.len(), ((num_bits as usize) * len + 7) / 8 + 7);
-        let bitunpacker = BitUnpacker::new(data, num_bits);
+        let bitunpacker = BitUnpacker::new(OwnedBytes::new(data), num_bits);
         (bitunpacker, vals)
     }
 

src/common/bitset.rs

@@ -33,6 +33,10 @@ impl TinySet {
         TinySet(0u64)
     }
 
+    pub fn clear(&mut self) {
+        self.0 = 0u64;
+    }
+
     /// Returns the complement of the set in `[0, 64[`.
     fn complement(self) -> TinySet {
         TinySet(!self.0)
@@ -43,6 +47,11 @@ impl TinySet {
         !self.intersect(TinySet::singleton(el)).is_empty()
     }
 
+    /// Returns the number of elements in the TinySet.
+    pub fn len(self) -> u32 {
+        self.0.count_ones()
+    }
+
     /// Returns the intersection of `self` and `other`
     pub fn intersect(self, other: TinySet) -> TinySet {
         TinySet(self.0 & other.0)
@@ -109,22 +118,12 @@ impl TinySet {
     pub fn range_greater_or_equal(from_included: u32) -> TinySet {
         TinySet::range_lower(from_included).complement()
     }
-
-    pub fn clear(&mut self) {
-        self.0 = 0u64;
-    }
-
-    pub fn len(self) -> u32 {
-        self.0.count_ones()
-    }
 }
 
 #[derive(Clone)]
 pub struct BitSet {
     tinysets: Box<[TinySet]>,
-    len: usize, //< Technically it should be u32, but we
-    // count multiple inserts.
-    // `usize` guards us from overflow.
+    len: usize,
     max_value: u32,
 }
 
@@ -204,7 +203,7 @@ mod tests {
 
     use super::BitSet;
     use super::TinySet;
-    use crate::docset::DocSet;
+    use crate::docset::{DocSet, TERMINATED};
     use crate::query::BitSetDocSet;
     use crate::tests;
     use crate::tests::generate_nonunique_unsorted;
@@ -278,11 +277,13 @@ mod tests {
         }
         assert_eq!(btreeset.len(), bitset.len());
         let mut bitset_docset = BitSetDocSet::from(bitset);
+        let mut remaining = true;
         for el in btreeset.into_iter() {
-            bitset_docset.advance();
+            assert!(remaining);
             assert_eq!(bitset_docset.doc(), el);
+            remaining = bitset_docset.advance() != TERMINATED;
         }
-        assert!(!bitset_docset.advance());
+        assert!(!remaining);
     }
 
     #[test]

src/common/composite_file.rs

@@ -1,14 +1,17 @@
 use crate::common::BinarySerializable;
 use crate::common::CountingWriter;
 use crate::common::VInt;
-use crate::directory::ReadOnlySource;
+use crate::directory::FileSlice;
 use crate::directory::{TerminatingWrite, WritePtr};
 use crate::schema::Field;
 use crate::space_usage::FieldUsage;
 use crate::space_usage::PerFieldSpaceUsage;
 use std::collections::HashMap;
-use std::io::Write;
-use std::io::{self, Read};
+use std::io::{self, Read, Write};
+use std::iter::ExactSizeIterator;
+use std::ops::Range;
+
+use super::HasLen;
 
 #[derive(Eq, PartialEq, Hash, Copy, Ord, PartialOrd, Clone, Debug)]
 pub struct FileAddr {
@@ -103,25 +106,26 @@ impl<W: TerminatingWrite + Write> CompositeWrite<W> {
 /// for each field.
 #[derive(Clone)]
 pub struct CompositeFile {
-    data: ReadOnlySource,
-    offsets_index: HashMap<FileAddr, (usize, usize)>,
+    data: FileSlice,
+    offsets_index: HashMap<FileAddr, Range<usize>>,
 }
 
 impl CompositeFile {
     /// Opens a composite file stored in a given
-    /// `ReadOnlySource`.
-    pub fn open(data: &ReadOnlySource) -> io::Result<CompositeFile> {
+    /// `FileSlice`.
+    pub fn open(data: &FileSlice) -> io::Result<CompositeFile> {
         let end = data.len();
-        let footer_len_data = data.slice_from(end - 4);
+        let footer_len_data = data.slice_from(end - 4).read_bytes()?;
         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);
+        let footer_data = data
+            .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;
 
         let mut file_addrs = vec![];
         let mut offsets = vec![];
-
         let mut field_index = HashMap::new();
 
         let mut offset = 0;
@@ -136,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 {
@@ -150,31 +154,31 @@ impl CompositeFile {
     pub fn empty() -> CompositeFile {
         CompositeFile {
             offsets_index: HashMap::new(),
-            data: ReadOnlySource::empty(),
+            data: FileSlice::empty(),
         }
     }
 
-    /// Returns the `ReadOnlySource` associated
+    /// Returns the `FileSlice` associated
     /// to a given `Field` and stored in a `CompositeFile`.
-    pub fn open_read(&self, field: Field) -> Option<ReadOnlySource> {
+    pub fn open_read(&self, field: Field) -> Option<FileSlice> {
         self.open_read_with_idx(field, 0)
     }
 
-    /// Returns the `ReadOnlySource` associated
+    /// Returns the `FileSlice` associated
     /// to a given `Field` and stored in a `CompositeFile`.
-    pub fn open_read_with_idx(&self, field: Field, idx: usize) -> Option<ReadOnlySource> {
+    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)
     }
@@ -190,49 +194,46 @@ mod test {
     use crate::schema::Field;
     use std::io::Write;
     use std::path::Path;
-    
 
     #[test]
-    fn test_composite_file() {
+    fn test_composite_file() -> crate::Result<()> {
         let path = Path::new("test_path");
-        let mut directory = RAMDirectory::default();
+        let directory = RAMDirectory::create();
         {
             let w = directory.open_write(path).unwrap();
             let mut composite_write = CompositeWrite::wrap(w);
-            {
-                let mut write_0 = composite_write.for_field(Field::from_field_id(0u32));
-                VInt(32431123u64).serialize(&mut write_0).unwrap();
-                write_0.flush().unwrap();
-            }
-
-            {
-                let mut write_4 = composite_write.for_field(Field::from_field_id(4u32));
-                VInt(2).serialize(&mut write_4).unwrap();
-                write_4.flush().unwrap();
-            }
-            composite_write.close().unwrap();
+            let mut write_0 = composite_write.for_field(Field::from_field_id(0u32));
+            VInt(32431123u64).serialize(&mut write_0)?;
+            write_0.flush()?;
+            let mut write_4 = composite_write.for_field(Field::from_field_id(4u32));
+            VInt(2).serialize(&mut write_4)?;
+            write_4.flush()?;
+            composite_write.close()?;
         }
         {
-            let r = directory.open_read(path).unwrap();
-            let composite_file = CompositeFile::open(&r).unwrap();
+            let r = directory.open_read(path)?;
+            let composite_file = CompositeFile::open(&r)?;
             {
                 let file0 = composite_file
                     .open_read(Field::from_field_id(0u32))
-                    .unwrap();
+                    .unwrap()
+                    .read_bytes()?;
                 let mut file0_buf = file0.as_slice();
-                let payload_0 = VInt::deserialize(&mut file0_buf).unwrap().0;
+                let payload_0 = VInt::deserialize(&mut file0_buf)?.0;
                 assert_eq!(file0_buf.len(), 0);
                 assert_eq!(payload_0, 32431123u64);
             }
             {
                 let file4 = composite_file
                     .open_read(Field::from_field_id(4u32))
-                    .unwrap();
+                    .unwrap()
+                    .read_bytes()?;
                 let mut file4_buf = file4.as_slice();
-                let payload_4 = VInt::deserialize(&mut file4_buf).unwrap().0;
+                let payload_4 = VInt::deserialize(&mut file4_buf)?.0;
                 assert_eq!(file4_buf.len(), 0);
                 assert_eq!(payload_4, 2u64);
             }
         }
+        Ok(())
     }
 }

src/common/counting_writer.rs

@@ -20,9 +20,10 @@ impl<W: Write> CountingWriter<W> {
         self.written_bytes
     }
 
-    pub fn finish(mut self) -> io::Result<(W, u64)> {
-        self.flush()?;
-        Ok((self.underlying, self.written_bytes))
+    /// Returns the underlying write object.
+    /// Note that this method does not trigger any flushing.
+    pub fn finish(self) -> W {
+        self.underlying
     }
 }
 
@@ -46,7 +47,6 @@ impl<W: Write> Write for CountingWriter<W> {
 
 impl<W: TerminatingWrite> TerminatingWrite for CountingWriter<W> {
     fn terminate_ref(&mut self, token: AntiCallToken) -> io::Result<()> {
-        self.flush()?;
         self.underlying.terminate_ref(token)
     }
 }
@@ -63,8 +63,9 @@ mod test {
         let mut counting_writer = CountingWriter::wrap(buffer);
         let bytes = (0u8..10u8).collect::<Vec<u8>>();
         counting_writer.write_all(&bytes).unwrap();
-        let (w, len): (Vec<u8>, u64) = counting_writer.finish().unwrap();
+        let len = counting_writer.written_bytes();
+        let buffer_restituted: Vec<u8> = counting_writer.finish();
         assert_eq!(len, 10u64);
-        assert_eq!(w.len(), 10);
+        assert_eq!(buffer_restituted.len(), 10);
     }
 }

src/common/mod.rs

@@ -2,7 +2,6 @@ pub mod bitpacker;
 mod bitset;
 mod composite_file;
 mod counting_writer;
-mod mutable_enum;
 mod serialize;
 mod vint;
 
@@ -10,9 +9,10 @@ pub use self::bitset::BitSet;
 pub(crate) use self::bitset::TinySet;
 pub(crate) use self::composite_file::{CompositeFile, CompositeWrite};
 pub use self::counting_writer::CountingWriter;
-pub(crate) use self::mutable_enum::MutableEnum;
 pub use self::serialize::{BinarySerializable, FixedSize};
-pub use self::vint::{read_u32_vint, serialize_vint_u32, write_u32_vint, VInt};
+pub use self::vint::{
+    read_u32_vint, read_u32_vint_no_advance, serialize_vint_u32, write_u32_vint, VInt,
+};
 pub use byteorder::LittleEndian as Endianness;
 
 /// Segment's max doc must be `< MAX_DOC_LIMIT`.
@@ -66,10 +66,6 @@ pub(crate) fn compute_num_bits(n: u64) -> u8 {
     }
 }
 
-pub(crate) fn is_power_of_2(n: usize) -> bool {
-    (n > 0) && (n & (n - 1) == 0)
-}
-
 /// Has length trait
 pub trait HasLen {
     /// Return length
@@ -119,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)]
@@ -152,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) {
@@ -162,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/common/mutable_enum.rs

@@ -1,37 +0,0 @@
-use std::ops::{Deref, DerefMut};
-
-pub(crate) struct MutableEnum<T>(Option<T>);
-
-impl<T> MutableEnum<T> {
-    pub fn wrap(val: T) -> Self {
-        MutableEnum(Some(val))
-    }
-
-    pub fn into(self) -> T {
-        self.0.unwrap()
-    }
-}
-
-impl<T> MutableEnum<T> {
-    pub fn map_mutate<E, F>(&mut self, transformation: F) -> Result<(), E>
-    where
-        F: FnOnce(T) -> Result<T, E>,
-    {
-        self.0 = self.0.take().map(transformation).transpose()?;
-        Ok(())
-    }
-}
-
-impl<T> Deref for MutableEnum<T> {
-    type Target = T;
-
-    fn deref(&self) -> &Self::Target {
-        self.0.as_ref().unwrap()
-    }
-}
-
-impl<T> DerefMut for MutableEnum<T> {
-    fn deref_mut(&mut self) -> &mut Self::Target {
-        self.0.as_mut().unwrap()
-    }
-}

src/common/serialize.rs

@@ -89,6 +89,19 @@ impl FixedSize for u64 {
     const SIZE_IN_BYTES: usize = 8;
 }
 
+impl BinarySerializable for f32 {
+    fn serialize<W: Write>(&self, writer: &mut W) -> io::Result<()> {
+        writer.write_f32::<Endianness>(*self)
+    }
+    fn deserialize<R: Read>(reader: &mut R) -> io::Result<Self> {
+        reader.read_f32::<Endianness>()
+    }
+}
+
+impl FixedSize for f32 {
+    const SIZE_IN_BYTES: usize = 4;
+}
+
 impl BinarySerializable for i64 {
     fn serialize<W: Write>(&self, writer: &mut W) -> io::Result<()> {
         writer.write_i64::<Endianness>(*self)

src/common/vint.rs

@@ -5,12 +5,12 @@ use std::io::Read;
 use std::io::Write;
 
 ///   Wrapper over a `u64` that serializes as a variable int.
-#[derive(Debug, Eq, PartialEq)]
+#[derive(Clone, Copy, Debug, Eq, PartialEq)]
 pub struct VInt(pub u64);
 
 const STOP_BIT: u8 = 128;
 
-pub fn serialize_vint_u32(val: u32) -> (u64, usize) {
+pub fn serialize_vint_u32(val: u32, buf: &mut [u8; 8]) -> &[u8] {
     const START_2: u64 = 1 << 7;
     const START_3: u64 = 1 << 14;
     const START_4: u64 = 1 << 21;
@@ -29,7 +29,7 @@ pub fn serialize_vint_u32(val: u32) -> (u64, usize) {
 
     let val = u64::from(val);
     const STOP_BIT: u64 = 128u64;
-    match val {
+    let (res, num_bytes) = match val {
         0..=STOP_1 => (val | STOP_BIT, 1),
         START_2..=STOP_2 => (
             (val & MASK_1) | ((val & MASK_2) << 1) | (STOP_BIT << (8)),
@@ -56,7 +56,9 @@ pub fn serialize_vint_u32(val: u32) -> (u64, usize) {
                 | (STOP_BIT << (8 * 4)),
             5,
         ),
-    }
+    };
+    LittleEndian::write_u64(&mut buf[..], res);
+    &buf[0..num_bytes]
 }
 
 /// Returns the number of bytes covered by a
@@ -85,23 +87,26 @@ fn vint_len(data: &[u8]) -> usize {
 /// If the buffer does not start by a valid
 /// vint payload
 pub fn read_u32_vint(data: &mut &[u8]) -> u32 {
-    let vlen = vint_len(*data);
+    let (result, vlen) = read_u32_vint_no_advance(*data);
+    *data = &data[vlen..];
+    result
+}
+
+pub fn read_u32_vint_no_advance(data: &[u8]) -> (u32, usize) {
+    let vlen = vint_len(data);
     let mut result = 0u32;
     let mut shift = 0u64;
     for &b in &data[..vlen] {
         result |= u32::from(b & 127u8) << shift;
         shift += 7;
     }
-    *data = &data[vlen..];
-    result
+    (result, vlen)
 }
-
 /// Write a `u32` as a vint payload.
 pub fn write_u32_vint<W: io::Write>(val: u32, writer: &mut W) -> io::Result<()> {
-    let (val, num_bytes) = serialize_vint_u32(val);
-    let mut buffer = [0u8; 8];
-    LittleEndian::write_u64(&mut buffer, val);
-    writer.write_all(&buffer[..num_bytes])
+    let mut buf = [0u8; 8];
+    let data = serialize_vint_u32(val, &mut buf);
+    writer.write_all(&data)
 }
 
 impl VInt {
@@ -172,7 +177,6 @@ mod tests {
     use super::serialize_vint_u32;
     use super::VInt;
     use crate::common::BinarySerializable;
-    use byteorder::{ByteOrder, LittleEndian};
 
     fn aux_test_vint(val: u64) {
         let mut v = [14u8; 10];
@@ -208,12 +212,10 @@ mod tests {
 
     fn aux_test_serialize_vint_u32(val: u32) {
         let mut buffer = [0u8; 10];
-        let mut buffer2 = [0u8; 10];
+        let mut buffer2 = [0u8; 8];
         let len_vint = VInt(val as u64).serialize_into(&mut buffer);
-        let (vint, len) = serialize_vint_u32(val);
-        assert_eq!(len, len_vint, "len wrong for val {}", val);
-        LittleEndian::write_u64(&mut buffer2, vint);
-        assert_eq!(&buffer[..len], &buffer2[..len], "array wrong for {}", val);
+        let res2 = serialize_vint_u32(val, &mut buffer2);
+        assert_eq!(&buffer[..len_vint], res2, "array wrong for {}", val);
     }
 
     #[test]

src/core/index.rs

@@ -5,6 +5,7 @@ use crate::core::SegmentId;
 use crate::core::SegmentMeta;
 use crate::core::SegmentMetaInventory;
 use crate::core::META_FILEPATH;
+use crate::directory::error::OpenReadError;
 use crate::directory::ManagedDirectory;
 #[cfg(feature = "mmap")]
 use crate::directory::MmapDirectory;
@@ -12,8 +13,8 @@ use crate::directory::INDEX_WRITER_LOCK;
 use crate::directory::{Directory, RAMDirectory};
 use crate::error::DataCorruption;
 use crate::error::TantivyError;
+use crate::indexer::index_writer::HEAP_SIZE_MIN;
 use crate::indexer::segment_updater::save_new_metas;
-use crate::indexer::IndexWriterConfig;
 use crate::reader::IndexReader;
 use crate::reader::IndexReaderBuilder;
 use crate::schema::Field;
@@ -21,12 +22,12 @@ use crate::schema::FieldType;
 use crate::schema::Schema;
 use crate::tokenizer::{TextAnalyzer, TokenizerManager};
 use crate::IndexWriter;
-use num_cpus;
-use std::borrow::BorrowMut;
 use std::collections::HashSet;
 use std::fmt;
+
 #[cfg(feature = "mmap")]
-use std::path::{Path, PathBuf};
+use std::path::Path;
+use std::path::PathBuf;
 use std::sync::Arc;
 
 fn load_metas(
@@ -34,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)
@@ -56,8 +66,10 @@ pub struct Index {
 }
 
 impl Index {
-    /// Examines the director to see if it contains an index
-    pub fn exists<Dir: Directory>(dir: &Dir) -> bool {
+    /// Examines the directory to see if it contains an index.
+    ///
+    /// Effectively, it only checks for the presence of the `meta.json` file.
+    pub fn exists<Dir: Directory>(dir: &Dir) -> Result<bool, OpenReadError> {
         dir.exists(&META_FILEPATH)
     }
 
@@ -104,7 +116,7 @@ impl Index {
         schema: Schema,
     ) -> crate::Result<Index> {
         let mmap_directory = MmapDirectory::open(directory_path)?;
-        if Index::exists(&mmap_directory) {
+        if Index::exists(&mmap_directory)? {
             return Err(TantivyError::IndexAlreadyExists);
         }
         Index::create(mmap_directory, schema)
@@ -112,7 +124,7 @@ impl Index {
 
     /// Opens or creates a new index in the provided directory
     pub fn open_or_create<Dir: Directory>(dir: Dir, schema: Schema) -> crate::Result<Index> {
-        if !Index::exists(&dir) {
+        if !Index::exists(&dir)? {
             return Index::create(dir, schema);
         }
         let index = Index::open(dir)?;
@@ -139,7 +151,9 @@ impl Index {
         Index::create(mmap_directory, schema)
     }
 
-    /// Creates a new index given an implementation of the trait `Directory`
+    /// Creates a new index given an implementation of the trait `Directory`.
+    ///
+    /// If a directory previously existed, it will be erased.
     pub fn create<Dir: Directory>(dir: Dir, schema: Schema) -> crate::Result<Index> {
         let directory = ManagedDirectory::wrap(dir)?;
         Index::from_directory(directory, schema)
@@ -148,10 +162,11 @@ impl Index {
     /// Create a new index from a directory.
     ///
     /// This will overwrite existing meta.json
-    fn from_directory(mut directory: ManagedDirectory, schema: Schema) -> crate::Result<Index> {
-        save_new_metas(schema.clone(), directory.borrow_mut())?;
+    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`.
@@ -159,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.
@@ -224,7 +239,7 @@ impl Index {
     /// Such segments can of course be part of the index,
     /// but also they could be segments being currently built or in the middle of a merge
     /// operation.
-    pub fn list_all_segment_metas(&self) -> Vec<SegmentMeta> {
+    pub(crate) fn list_all_segment_metas(&self) -> Vec<SegmentMeta> {
         self.inventory.all()
     }
 
@@ -242,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.
@@ -273,40 +289,8 @@ impl Index {
     pub fn writer_with_num_threads(
         &self,
         num_threads: usize,
-        overall_heap_size_in_bytes: u64,
+        overall_heap_size_in_bytes: usize,
     ) -> crate::Result<IndexWriter> {
-        let config = IndexWriterConfig {
-            max_indexing_threads: num_threads,
-            memory_budget: overall_heap_size_in_bytes,
-            ..Default::default()
-        };
-        self.writer_from_config(config)
-    }
-
-    /// Creates a multithreaded writer
-    ///
-    /// Tantivy will automatically define the number of threads to use.
-    /// `overall_heap_size_in_bytes` is the total target memory usage that will be split
-    /// between a given number of threads.
-    ///
-    /// # Errors
-    /// If the lockfile already exists, returns `Error::FileAlreadyExists`.
-    /// # Panics
-    /// If the heap size per thread is too small, panics.
-    pub fn writer(&self, overall_heap_size_in_bytes: u64) -> crate::Result<IndexWriter> {
-        let config = IndexWriterConfig {
-            max_indexing_threads: num_cpus::get(),
-            memory_budget: overall_heap_size_in_bytes,
-            ..Default::default()
-        };
-        self.writer_from_config(config)
-    }
-
-    /// Creates a new writer with a given configuration.
-    ///
-    /// See [`IndexWriterConfig`](./struct.IndexWriterConfig.html) for more information.
-    pub fn writer_from_config(&self, mut config: IndexWriterConfig) -> crate::Result<IndexWriter> {
-        config.validate()?;
         let directory_lock = self
             .directory
             .acquire_lock(&INDEX_WRITER_LOCK)
@@ -322,7 +306,41 @@ impl Index {
                     ),
                 )
             })?;
-        IndexWriter::new(self, config, directory_lock)
+        let heap_size_in_bytes_per_thread = overall_heap_size_in_bytes / num_threads;
+        IndexWriter::new(
+            self,
+            num_threads,
+            heap_size_in_bytes_per_thread,
+            directory_lock,
+        )
+    }
+
+    /// Helper to create an index writer for tests.
+    ///
+    /// That index writer only simply has a single thread and a heap of 5 MB.
+    /// Using a single thread gives us a deterministic allocation of DocId.
+    #[cfg(test)]
+    pub fn writer_for_tests(&self) -> crate::Result<IndexWriter> {
+        self.writer_with_num_threads(1, 10_000_000)
+    }
+
+    /// Creates a multithreaded writer
+    ///
+    /// Tantivy will automatically define the number of threads to use.
+    /// `overall_heap_size_in_bytes` is the total target memory usage that will be split
+    /// between a given number of threads.
+    ///
+    /// # Errors
+    /// If the lockfile already exists, returns `Error::FileAlreadyExists`.
+    /// # Panics
+    /// If the heap size per thread is too small, panics.
+    pub fn writer(&self, overall_heap_size_in_bytes: usize) -> crate::Result<IndexWriter> {
+        let mut num_threads = num_cpus::get();
+        let heap_size_in_bytes_per_thread = overall_heap_size_in_bytes / num_threads;
+        if heap_size_in_bytes_per_thread < HEAP_SIZE_MIN {
+            num_threads = (overall_heap_size_in_bytes / HEAP_SIZE_MIN).max(1);
+        }
+        self.writer_with_num_threads(num_threads, overall_heap_size_in_bytes)
     }
 
     /// Accessor to the index schema
@@ -393,7 +411,7 @@ impl fmt::Debug for Index {
 
 #[cfg(test)]
 mod tests {
-    use crate::directory::RAMDirectory;
+    use crate::directory::{RAMDirectory, WatchCallback};
     use crate::schema::Field;
     use crate::schema::{Schema, INDEXED, TEXT};
     use crate::IndexReader;
@@ -417,24 +435,24 @@ mod tests {
     #[test]
     fn test_index_exists() {
         let directory = RAMDirectory::create();
-        assert!(!Index::exists(&directory));
+        assert!(!Index::exists(&directory).unwrap());
         assert!(Index::create(directory.clone(), throw_away_schema()).is_ok());
-        assert!(Index::exists(&directory));
+        assert!(Index::exists(&directory).unwrap());
     }
 
     #[test]
     fn open_or_create_should_create() {
         let directory = RAMDirectory::create();
-        assert!(!Index::exists(&directory));
+        assert!(!Index::exists(&directory).unwrap());
         assert!(Index::open_or_create(directory.clone(), throw_away_schema()).is_ok());
-        assert!(Index::exists(&directory));
+        assert!(Index::exists(&directory).unwrap());
     }
 
     #[test]
     fn open_or_create_should_open() {
         let directory = RAMDirectory::create();
         assert!(Index::create(directory.clone(), throw_away_schema()).is_ok());
-        assert!(Index::exists(&directory));
+        assert!(Index::exists(&directory).unwrap());
         assert!(Index::open_or_create(directory, throw_away_schema()).is_ok());
     }
 
@@ -442,7 +460,7 @@ mod tests {
     fn create_should_wipeoff_existing() {
         let directory = RAMDirectory::create();
         assert!(Index::create(directory.clone(), throw_away_schema()).is_ok());
-        assert!(Index::exists(&directory));
+        assert!(Index::exists(&directory).unwrap());
         assert!(Index::create(directory.clone(), Schema::builder().build()).is_ok());
     }
 
@@ -450,7 +468,7 @@ mod tests {
     fn open_or_create_exists_but_schema_does_not_match() {
         let directory = RAMDirectory::create();
         assert!(Index::create(directory.clone(), throw_away_schema()).is_ok());
-        assert!(Index::exists(&directory));
+        assert!(Index::exists(&directory).unwrap());
         assert!(Index::open_or_create(directory.clone(), throw_away_schema()).is_ok());
         let err = Index::open_or_create(directory, Schema::builder().build());
         assert_eq!(
@@ -476,7 +494,7 @@ mod tests {
             .try_into()
             .unwrap();
         assert_eq!(reader.searcher().num_docs(), 0);
-        test_index_on_commit_reload_policy_aux(field, index.clone(), &index, &reader);
+        test_index_on_commit_reload_policy_aux(field, &index, &reader);
     }
 
     #[cfg(feature = "mmap")]
@@ -500,32 +518,32 @@ mod tests {
                 .try_into()
                 .unwrap();
             assert_eq!(reader.searcher().num_docs(), 0);
-            test_index_on_commit_reload_policy_aux(field, index.clone(), &index, &reader);
+            test_index_on_commit_reload_policy_aux(field, &index, &reader);
         }
 
         #[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_with_num_threads(1, 3_000_000).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(Box::new(move || {
+            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]
@@ -542,30 +560,38 @@ mod tests {
                 .try_into()
                 .unwrap();
             assert_eq!(reader.searcher().num_docs(), 0);
-            test_index_on_commit_reload_policy_aux(field, read_index, &write_index, &reader);
+            test_index_on_commit_reload_policy_aux(field, &write_index, &reader);
         }
     }
-
-    fn test_index_on_commit_reload_policy_aux(
-        field: Field,
-        mut reader_index: Index,
-        index: &Index,
-        reader: &IndexReader,
-    ) {
+    fn test_index_on_commit_reload_policy_aux(field: Field, index: &Index, reader: &IndexReader) {
+        let mut reader_index = reader.index();
         let (sender, receiver) = crossbeam::channel::unbounded();
-        let _watch_handle = reader_index.directory_mut().watch(Box::new(move || {
-            let _ = sender.send(());
-        }));
-        let mut writer = index.writer_with_num_threads(1, 3_000_000).unwrap();
+        let _watch_handle = reader_index
+            .directory_mut()
+            .watch(WatchCallback::new(move || {
+                let _ = sender.send(());
+            }));
+        let mut writer = index.writer_for_tests().unwrap();
         assert_eq!(reader.searcher().num_docs(), 0);
         writer.add_document(doc!(field=>1u64));
         writer.commit().unwrap();
-        assert!(receiver.recv().is_ok());
-        assert_eq!(reader.searcher().num_docs(), 1);
+        // We need a loop here because it is possible for notify to send more than
+        // one modify event. It was observed on CI on MacOS.
+        loop {
+            assert!(receiver.recv().is_ok());
+            if reader.searcher().num_docs() == 1 {
+                break;
+            }
+        }
         writer.add_document(doc!(field=>2u64));
         writer.commit().unwrap();
-        assert!(receiver.recv().is_ok());
-        assert_eq!(reader.searcher().num_docs(), 2);
+        // ... Same as above
+        loop {
+            assert!(receiver.recv().is_ok());
+            if reader.searcher().num_docs() == 2 {
+                break;
+            }
+        }
     }
 
     // This test will not pass on windows, because windows
@@ -583,7 +609,7 @@ mod tests {
             writer.add_document(doc!(field => i));
         }
         let (sender, receiver) = crossbeam::channel::unbounded();
-        let _handle = directory.watch(Box::new(move || {
+        let _handle = directory.watch(WatchCallback::new(move || {
             let _ = sender.send(());
         }));
         writer.commit().unwrap();

src/core/index_meta.rs

@@ -3,9 +3,7 @@ use crate::core::SegmentId;
 use crate::schema::Schema;
 use crate::Opstamp;
 use census::{Inventory, TrackedObject};
-use serde;
 use serde::{Deserialize, Serialize};
-use serde_json;
 use std::collections::HashSet;
 use std::fmt;
 use std::path::PathBuf;
@@ -215,7 +213,7 @@ pub struct IndexMeta {
     #[serde(skip_serializing_if = "Option::is_none")]
     /// Payload associated to the last commit.
     ///
-    /// Upon commit, clients can optionally add a small `Striing` payload to their commit
+    /// Upon commit, clients can optionally add a small `String` payload to their commit
     /// to help identify this commit.
     /// This payload is entirely unused by tantivy.
     pub payload: Option<String>,

src/core/inverted_index_reader.rs

@@ -1,13 +1,13 @@
+use std::io;
+
 use crate::common::BinarySerializable;
-use crate::directory::ReadOnlySource;
+use crate::directory::FileSlice;
 use crate::positions::PositionReader;
 use crate::postings::TermInfo;
 use crate::postings::{BlockSegmentPostings, SegmentPostings};
-use crate::schema::FieldType;
 use crate::schema::IndexRecordOption;
 use crate::schema::Term;
 use crate::termdict::TermDictionary;
-use owned_read::OwnedRead;
 
 /// The inverted index reader is in charge of accessing
 /// the inverted index associated to a specific field.
@@ -16,7 +16,7 @@ use owned_read::OwnedRead;
 ///
 /// It is safe to delete the segment associated to
 /// an `InvertedIndexReader`. As long as it is open,
-/// the `ReadOnlySource` it is relying on should
+/// the `FileSlice` it is relying on should
 /// stay available.
 ///
 ///
@@ -24,9 +24,9 @@ use owned_read::OwnedRead;
 /// the `SegmentReader`'s [`.inverted_index(...)`] method
 pub struct InvertedIndexReader {
     termdict: TermDictionary,
-    postings_source: ReadOnlySource,
-    positions_source: ReadOnlySource,
-    positions_idx_source: ReadOnlySource,
+    postings_file_slice: FileSlice,
+    positions_file_slice: FileSlice,
+    positions_idx_file_slice: FileSlice,
     record_option: IndexRecordOption,
     total_num_tokens: u64,
 }
@@ -35,42 +35,38 @@ impl InvertedIndexReader {
     #[cfg_attr(feature = "cargo-clippy", allow(clippy::needless_pass_by_value))] // for symmetry
     pub(crate) fn new(
         termdict: TermDictionary,
-        postings_source: ReadOnlySource,
-        positions_source: ReadOnlySource,
-        positions_idx_source: ReadOnlySource,
+        postings_file_slice: FileSlice,
+        positions_file_slice: FileSlice,
+        positions_idx_file_slice: FileSlice,
         record_option: IndexRecordOption,
-    ) -> InvertedIndexReader {
-        let total_num_tokens_data = postings_source.slice(0, 8);
-        let mut total_num_tokens_cursor = total_num_tokens_data.as_slice();
-        let total_num_tokens = u64::deserialize(&mut total_num_tokens_cursor).unwrap_or(0u64);
-        InvertedIndexReader {
+    ) -> io::Result<InvertedIndexReader> {
+        let (total_num_tokens_slice, postings_body) = postings_file_slice.split(8);
+        let total_num_tokens = u64::deserialize(&mut total_num_tokens_slice.read_bytes()?)?;
+        Ok(InvertedIndexReader {
             termdict,
-            postings_source: postings_source.slice_from(8),
-            positions_source,
-            positions_idx_source,
+            postings_file_slice: postings_body,
+            positions_file_slice,
+            positions_idx_file_slice,
             record_option,
             total_num_tokens,
-        }
+        })
     }
 
     /// Creates an empty `InvertedIndexReader` object, which
     /// contains no terms at all.
-    pub fn empty(field_type: &FieldType) -> InvertedIndexReader {
-        let record_option = field_type
-            .get_index_record_option()
-            .unwrap_or(IndexRecordOption::Basic);
+    pub fn empty(record_option: IndexRecordOption) -> InvertedIndexReader {
         InvertedIndexReader {
             termdict: TermDictionary::empty(),
-            postings_source: ReadOnlySource::empty(),
-            positions_source: ReadOnlySource::empty(),
-            positions_idx_source: ReadOnlySource::empty(),
+            postings_file_slice: FileSlice::empty(),
+            positions_file_slice: FileSlice::empty(),
+            positions_idx_file_slice: FileSlice::empty(),
             record_option,
             total_num_tokens: 0u64,
         }
     }
 
     /// Returns the term info associated with the term.
-    pub fn get_term_info(&self, term: &Term) -> Option<TermInfo> {
+    pub fn get_term_info(&self, term: &Term) -> io::Result<Option<TermInfo>> {
         self.termdict.get(term.value_bytes())
     }
 
@@ -93,12 +89,12 @@ impl InvertedIndexReader {
         &self,
         term_info: &TermInfo,
         block_postings: &mut BlockSegmentPostings,
-    ) {
-        let offset = term_info.postings_offset as usize;
-        let end_source = self.postings_source.len();
-        let postings_slice = self.postings_source.slice(offset, end_source);
-        let postings_reader = OwnedRead::new(postings_slice);
-        block_postings.reset(term_info.doc_freq, postings_reader);
+    ) -> io::Result<()> {
+        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(())
     }
 
     /// Returns a block postings given a `Term`.
@@ -109,9 +105,10 @@ impl InvertedIndexReader {
         &self,
         term: &Term,
         option: IndexRecordOption,
-    ) -> Option<BlockSegmentPostings> {
-        self.get_term_info(term)
+    ) -> io::Result<Option<BlockSegmentPostings>> {
+        self.get_term_info(term)?
             .map(move |term_info| self.read_block_postings_from_terminfo(&term_info, option))
+            .transpose()
     }
 
     /// Returns a block postings given a `term_info`.
@@ -122,12 +119,13 @@ impl InvertedIndexReader {
         &self,
         term_info: &TermInfo,
         requested_option: IndexRecordOption,
-    ) -> BlockSegmentPostings {
-        let offset = term_info.postings_offset as usize;
-        let postings_data = self.postings_source.slice_from(offset);
-        BlockSegmentPostings::from_data(
+    ) -> io::Result<BlockSegmentPostings> {
+        let postings_data = self
+            .postings_file_slice
+            .slice(term_info.postings_range.clone());
+        BlockSegmentPostings::open(
             term_info.doc_freq,
-            OwnedRead::new(postings_data),
+            postings_data,
             self.record_option,
             requested_option,
         )
@@ -141,20 +139,23 @@ impl InvertedIndexReader {
         &self,
         term_info: &TermInfo,
         option: IndexRecordOption,
-    ) -> SegmentPostings {
-        let block_postings = self.read_block_postings_from_terminfo(term_info, option);
+    ) -> io::Result<SegmentPostings> {
+        let block_postings = self.read_block_postings_from_terminfo(term_info, option)?;
         let position_stream = {
             if option.has_positions() {
-                let position_reader = self.positions_source.clone();
-                let skip_reader = self.positions_idx_source.clone();
+                let position_reader = self.positions_file_slice.clone();
+                let skip_reader = self.positions_idx_file_slice.clone();
                 let position_reader =
-                    PositionReader::new(position_reader, skip_reader, term_info.positions_idx);
+                    PositionReader::new(position_reader, skip_reader, term_info.positions_idx)?;
                 Some(position_reader)
             } else {
                 None
             }
         };
-        SegmentPostings::from_block_postings(block_postings, position_stream)
+        Ok(SegmentPostings::from_block_postings(
+            block_postings,
+            position_stream,
+        ))
     }
 
     /// Returns the total number of tokens recorded for all documents
@@ -173,24 +174,31 @@ impl InvertedIndexReader {
     /// For instance, requesting `IndexRecordOption::Freq` for a
     /// `TextIndexingOptions` that does not index position will return a `SegmentPostings`
     /// with `DocId`s and frequencies.
-    pub fn read_postings(&self, term: &Term, option: IndexRecordOption) -> Option<SegmentPostings> {
-        self.get_term_info(term)
+    pub fn read_postings(
+        &self,
+        term: &Term,
+        option: IndexRecordOption,
+    ) -> io::Result<Option<SegmentPostings>> {
+        self.get_term_info(term)?
             .map(move |term_info| self.read_postings_from_terminfo(&term_info, option))
+            .transpose()
     }
 
     pub(crate) fn read_postings_no_deletes(
         &self,
         term: &Term,
         option: IndexRecordOption,
-    ) -> Option<SegmentPostings> {
-        self.get_term_info(term)
+    ) -> io::Result<Option<SegmentPostings>> {
+        self.get_term_info(term)?
             .map(|term_info| self.read_postings_from_terminfo(&term_info, option))
+            .transpose()
     }
 
     /// Returns the number of documents containing the term.
-    pub fn doc_freq(&self, term: &Term) -> u32 {
-        self.get_term_info(term)
+    pub fn doc_freq(&self, term: &Term) -> io::Result<u32> {
+        Ok(self
+            .get_term_info(term)?
             .map(|term_info| term_info.doc_freq)
-            .unwrap_or(0u32)
+            .unwrap_or(0u32))
     }
 }

src/core/searcher.rs

@@ -1,41 +1,17 @@
 use crate::collector::Collector;
-use crate::collector::SegmentCollector;
 use crate::core::Executor;
-use crate::core::InvertedIndexReader;
+
 use crate::core::SegmentReader;
 use crate::query::Query;
-use crate::query::Scorer;
-use crate::query::Weight;
 use crate::schema::Document;
 use crate::schema::Schema;
-use crate::schema::{Field, Term};
+use crate::schema::Term;
 use crate::space_usage::SearcherSpaceUsage;
 use crate::store::StoreReader;
-use crate::termdict::TermMerger;
 use crate::DocAddress;
 use crate::Index;
-use std::fmt;
-use std::sync::Arc;
 
-fn collect_segment<C: Collector>(
-    collector: &C,
-    weight: &dyn Weight,
-    segment_ord: u32,
-    segment_reader: &SegmentReader,
-) -> crate::Result<C::Fruit> {
-    let mut scorer = weight.scorer(segment_reader, 1.0f32)?;
-    let mut segment_collector = collector.for_segment(segment_ord as u32, segment_reader)?;
-    if let Some(delete_bitset) = segment_reader.delete_bitset() {
-        scorer.for_each(&mut |doc, score| {
-            if delete_bitset.is_alive(doc) {
-                segment_collector.collect(doc, score);
-            }
-        });
-    } else {
-        scorer.for_each(&mut |doc, score| segment_collector.collect(doc, score));
-    }
-    Ok(segment_collector.harvest())
-}
+use std::{fmt, io};
 
 /// Holds a list of `SegmentReader`s ready for search.
 ///
@@ -55,17 +31,17 @@ impl Searcher {
         schema: Schema,
         index: Index,
         segment_readers: Vec<SegmentReader>,
-    ) -> Searcher {
-        let store_readers = segment_readers
+    ) -> io::Result<Searcher> {
+        let store_readers: Vec<StoreReader> = segment_readers
             .iter()
             .map(SegmentReader::get_store_reader)
-            .collect();
-        Searcher {
+            .collect::<io::Result<Vec<_>>>()?;
+        Ok(Searcher {
             schema,
             index,
             segment_readers,
             store_readers,
-        }
+        })
     }
 
     /// Returns the `Index` associated to the `Searcher`
@@ -78,9 +54,8 @@ impl Searcher {
     /// The searcher uses the segment ordinal to route the
     /// the request to the right `Segment`.
     pub fn doc(&self, doc_address: DocAddress) -> crate::Result<Document> {
-        let DocAddress(segment_local_id, doc_id) = doc_address;
-        let store_reader = &self.store_readers[segment_local_id as usize];
-        store_reader.get(doc_id)
+        let store_reader = &self.store_readers[doc_address.segment_ord as usize];
+        store_reader.get(doc_address.doc_id)
     }
 
     /// Access the schema associated to the index of this searcher.
@@ -98,13 +73,14 @@ impl Searcher {
 
     /// Return the overall number of documents containing
     /// the given term.
-    pub fn doc_freq(&self, term: &Term) -> u64 {
-        self.segment_readers
-            .iter()
-            .map(|segment_reader| {
-                u64::from(segment_reader.inverted_index(term.field()).doc_freq(term))
-            })
-            .sum::<u64>()
+    pub fn doc_freq(&self, term: &Term) -> crate::Result<u64> {
+        let mut total_doc_freq = 0;
+        for segment_reader in &self.segment_readers {
+            let inverted_index = segment_reader.inverted_index(term.field())?;
+            let doc_freq = inverted_index.doc_freq(term)?;
+            total_doc_freq += u64::from(doc_freq);
+        }
+        Ok(total_doc_freq)
     }
 
     /// Return the list of segment readers
@@ -163,56 +139,20 @@ impl Searcher {
         let segment_readers = self.segment_readers();
         let fruits = executor.map(
             |(segment_ord, segment_reader)| {
-                collect_segment(
-                    collector,
-                    weight.as_ref(),
-                    segment_ord as u32,
-                    segment_reader,
-                )
+                collector.collect_segment(weight.as_ref(), segment_ord as u32, segment_reader)
             },
             segment_readers.iter().enumerate(),
         )?;
         collector.merge_fruits(fruits)
     }
 
-    /// Return the field searcher associated to a `Field`.
-    pub fn field(&self, field: Field) -> FieldSearcher {
-        let inv_index_readers = self
-            .segment_readers
-            .iter()
-            .map(|segment_reader| segment_reader.inverted_index(field))
-            .collect::<Vec<_>>();
-        FieldSearcher::new(inv_index_readers)
-    }
-
     /// Summarize total space usage of this searcher.
-    pub fn space_usage(&self) -> SearcherSpaceUsage {
+    pub fn space_usage(&self) -> io::Result<SearcherSpaceUsage> {
         let mut space_usage = SearcherSpaceUsage::new();
-        for segment_reader in self.segment_readers.iter() {
-            space_usage.add_segment(segment_reader.space_usage());
+        for segment_reader in &self.segment_readers {
+            space_usage.add_segment(segment_reader.space_usage()?);
         }
-        space_usage
-    }
-}
-
-pub struct FieldSearcher {
-    inv_index_readers: Vec<Arc<InvertedIndexReader>>,
-}
-
-impl FieldSearcher {
-    fn new(inv_index_readers: Vec<Arc<InvertedIndexReader>>) -> FieldSearcher {
-        FieldSearcher { inv_index_readers }
-    }
-
-    /// Returns a Stream over all of the sorted unique terms of
-    /// for the given field.
-    pub fn terms(&self) -> TermMerger<'_> {
-        let term_streamers: Vec<_> = self
-            .inv_index_readers
-            .iter()
-            .map(|inverted_index| inverted_index.terms().stream())
-            .collect();
-        TermMerger::new(term_streamers)
+        Ok(space_usage)
     }
 }
 

src/core/segment.rs

@@ -3,140 +3,41 @@ use crate::core::Index;
 use crate::core::SegmentId;
 use crate::core::SegmentMeta;
 use crate::directory::error::{OpenReadError, OpenWriteError};
-use crate::directory::{Directory, ManagedDirectory, RAMDirectory};
-use crate::directory::{ReadOnlySource, WritePtr};
+use crate::directory::Directory;
+use crate::directory::{FileSlice, WritePtr};
 use crate::indexer::segment_serializer::SegmentSerializer;
 use crate::schema::Schema;
 use crate::Opstamp;
 use std::fmt;
-use std::ops::{Deref, DerefMut};
 use std::path::PathBuf;
-use crate::indexer::{ResourceManager};
-
-#[derive(Clone)]
-pub(crate) enum SegmentDirectory {
-    Persisted(ManagedDirectory),
-    Volatile {
-        directory: RAMDirectory,
-    },
-}
-
-impl SegmentDirectory {
-    fn new_volatile(memory_manager: ResourceManager) -> SegmentDirectory {
-        SegmentDirectory::Volatile {
-            directory: RAMDirectory::create_with_memory_manager(memory_manager),
-        }
-    }
-}
-
-impl fmt::Debug for SegmentDirectory {
-    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
-        match self {
-            SegmentDirectory::Volatile { .. } => write!(f, "volatile")?,
-            SegmentDirectory::Persisted(dir) => write!(f, "Persisted({:?})", dir)?,
-        }
-        Ok(())
-    }
-}
-
-impl From<ManagedDirectory> for SegmentDirectory {
-    fn from(directory: ManagedDirectory) -> Self {
-        SegmentDirectory::Persisted(directory)
-    }
-}
-
-impl Deref for SegmentDirectory {
-    type Target = dyn Directory;
-
-    fn deref(&self) -> &Self::Target {
-        match self {
-            SegmentDirectory::Volatile {
-                directory, ..
-            } => directory,
-            SegmentDirectory::Persisted(dir) => dir,
-        }
-    }
-}
-
-impl DerefMut for SegmentDirectory {
-    fn deref_mut(&mut self) -> &mut Self::Target {
-        match self {
-            SegmentDirectory::Volatile { directory, .. } => directory,
-            SegmentDirectory::Persisted(dir) => dir,
-        }
-    }
-}
 
 /// A segment is a piece of the index.
 #[derive(Clone)]
 pub struct Segment {
-    schema: Schema,
+    index: Index,
     meta: SegmentMeta,
-    directory: SegmentDirectory,
 }
 
 impl fmt::Debug for Segment {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        write!(
-            f,
-            "Segment(id={:?}, directory={:?})",
-            self.id().uuid_string(),
-            self.directory
-        )
+        write!(f, "Segment({:?})", self.id().uuid_string())
     }
 }
 
 impl Segment {
-    pub(crate) fn new_persisted(
-        meta: SegmentMeta,
-        directory: ManagedDirectory,
-        schema: Schema,
-    ) -> Segment {
-        Segment {
-            meta,
-            schema,
-            directory: SegmentDirectory::from(directory),
-        }
-    }
-
-    /// Creates a new segment that embeds its own `RAMDirectory`.
-    ///
-    /// That segment is entirely dissociated from the index directory.
-    /// It will be persisted by a background thread in charge of IO.
-    pub fn new_volatile(meta: SegmentMeta, schema: Schema, resource_manager: ResourceManager) -> Segment {
-        Segment {
-            schema,
-            meta,
-            directory: SegmentDirectory::new_volatile(resource_manager),
-        }
-    }
-
     /// Creates a new segment given an `Index` and a `SegmentId`
     pub(crate) fn for_index(index: Index, meta: SegmentMeta) -> Segment {
-        let segment_directory = index.directory().clone();
-        Segment::new_persisted(meta, segment_directory, index.schema())
+        Segment { index, meta }
     }
 
-    /// Persists a given `Segment` to a directory.
-    pub fn persist(&mut self, mut dest_directory: ManagedDirectory) -> crate::Result<()> {
-        if let SegmentDirectory::Persisted(_) = self.directory {
-            // this segment is already persisted.
-            return Ok(());
-        }
-        if let SegmentDirectory::Volatile { directory, ..} = &self.directory {
-            directory.persist(&mut dest_directory)?;
-        }
-        self.directory = SegmentDirectory::Persisted(dest_directory);
-        Ok(())
-    }
-
-    pub fn into_volatile(&self, memory_manager: ResourceManager) -> Segment {
-        Segment::new_volatile(self.meta.clone(), self.schema.clone(), memory_manager)
+    /// Returns the index the segment belongs to.
+    pub fn index(&self) -> &Index {
+        &self.index
     }
 
     /// Returns our index's schema.
     pub fn schema(&self) -> Schema {
-        self.schema.clone()
+        self.index.schema()
     }
 
     /// Returns the segment meta-information
@@ -150,18 +51,16 @@ impl Segment {
     /// as we finalize a fresh new segment.
     pub(crate) fn with_max_doc(self, max_doc: u32) -> Segment {
         Segment {
-            schema: self.schema,
+            index: self.index,
             meta: self.meta.with_max_doc(max_doc),
-            directory: self.directory,
         }
     }
 
     #[doc(hidden)]
     pub fn with_delete_meta(self, num_deleted_docs: u32, opstamp: Opstamp) -> Segment {
         Segment {
-            schema: self.schema,
+            index: self.index,
             meta: self.meta.with_delete_meta(num_deleted_docs, opstamp),
-            directory: self.directory,
         }
     }
 
@@ -179,17 +78,16 @@ impl Segment {
     }
 
     /// Open one of the component file for a *regular* read.
-    pub fn open_read(&self, component: SegmentComponent) -> Result<ReadOnlySource, OpenReadError> {
+    pub fn open_read(&self, component: SegmentComponent) -> Result<FileSlice, OpenReadError> {
         let path = self.relative_path(component);
-        let source = self.directory.open_read(&path)?;
-        Ok(source)
+        self.index.directory().open_read(&path)
     }
 
     /// Open one of the component file for *regular* write.
     pub fn open_write(&mut self, component: SegmentComponent) -> Result<WritePtr, OpenWriteError> {
         let path = self.relative_path(component);
-        let wrt = self.directory.open_write(&path)?;
-        Ok(wrt)
+        let write = self.index.directory_mut().open_write(&path)?;
+        Ok(write)
     }
 }
 

src/core/segment_component.rs

@@ -20,7 +20,7 @@ pub enum SegmentComponent {
     /// Dictionary associating `Term`s to `TermInfo`s which is
     /// simply an address into the `postings` file and the `positions` file.
     TERMS,
-    /// Row-oriented, LZ4-compressed storage of the documents.
+    /// Row-oriented, compressed storage of the documents.
     /// Accessing a document from the store is relatively slow, as it
     /// requires to decompress the entire block it belongs to.
     STORE,

src/core/segment_reader.rs

@@ -1,26 +1,26 @@
-use crate::common::CompositeFile;
 use crate::common::HasLen;
 use crate::core::InvertedIndexReader;
 use crate::core::Segment;
 use crate::core::SegmentComponent;
 use crate::core::SegmentId;
-use crate::directory::ReadOnlySource;
+use crate::directory::FileSlice;
 use crate::fastfield::DeleteBitSet;
 use crate::fastfield::FacetReader;
 use crate::fastfield::FastFieldReaders;
-use crate::fieldnorm::FieldNormReader;
-use crate::schema::Field;
+use crate::fieldnorm::{FieldNormReader, FieldNormReaders};
 use crate::schema::FieldType;
 use crate::schema::Schema;
+use crate::schema::{Field, IndexRecordOption};
 use crate::space_usage::SegmentSpaceUsage;
 use crate::store::StoreReader;
 use crate::termdict::TermDictionary;
 use crate::DocId;
+use crate::{common::CompositeFile, error::DataCorruption};
 use fail::fail_point;
-use std::collections::HashMap;
 use std::fmt;
 use std::sync::Arc;
 use std::sync::RwLock;
+use std::{collections::HashMap, io};
 
 /// Entry point to access all of the datastructures of the `Segment`
 ///
@@ -48,9 +48,9 @@ pub struct SegmentReader {
     positions_composite: CompositeFile,
     positions_idx_composite: CompositeFile,
     fast_fields_readers: Arc<FastFieldReaders>,
-    fieldnorms_composite: CompositeFile,
+    fieldnorm_readers: FieldNormReaders,
 
-    store_source: ReadOnlySource,
+    store_file: FileSlice,
     delete_bitset_opt: Option<DeleteBitSet>,
     schema: Schema,
 }
@@ -106,16 +106,24 @@ impl SegmentReader {
     }
 
     /// Accessor to the `FacetReader` associated to a given `Field`.
-    pub fn facet_reader(&self, field: Field) -> Option<FacetReader> {
+    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 None;
+
+        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)?;
-        let termdict_source = self.termdict_composite.open_read(field)?;
-        let termdict = TermDictionary::from_source(&termdict_source);
-        let facet_reader = FacetReader::new(term_ords_reader, termdict);
-        Some(facet_reader)
     }
 
     /// Accessor to the segment's `Field norms`'s reader.
@@ -125,47 +133,45 @@ impl SegmentReader {
     ///
     /// They are simply stored as a fast field, serialized in
     /// the `.fieldnorm` file of the segment.
-    pub fn get_fieldnorms_reader(&self, field: Field) -> FieldNormReader {
-        if let Some(fieldnorm_source) = self.fieldnorms_composite.open_read(field) {
-            FieldNormReader::open(fieldnorm_source)
-        } else {
+    pub fn get_fieldnorms_reader(&self, field: Field) -> crate::Result<FieldNormReader> {
+        self.fieldnorm_readers.get_field(field)?.ok_or_else(|| {
             let field_name = self.schema.get_field_name(field);
             let err_msg = format!(
-                "Field norm not found for field {:?}. Was it market as indexed during indexing.",
+                "Field norm not found for field {:?}. Was it marked as indexed during indexing?",
                 field_name
             );
-            panic!(err_msg);
-        }
+            crate::TantivyError::SchemaError(err_msg)
+        })
     }
 
     /// Accessor to the segment's `StoreReader`.
-    pub fn get_store_reader(&self) -> StoreReader {
-        StoreReader::from_source(self.store_source.clone())
+    pub fn get_store_reader(&self) -> io::Result<StoreReader> {
+        StoreReader::open(self.store_file.clone())
     }
 
     /// Open a new segment for reading.
     pub fn open(segment: &Segment) -> crate::Result<SegmentReader> {
-        let termdict_source = segment.open_read(SegmentComponent::TERMS)?;
-        let termdict_composite = CompositeFile::open(&termdict_source)?;
+        let termdict_file = segment.open_read(SegmentComponent::TERMS)?;
+        let termdict_composite = CompositeFile::open(&termdict_file)?;
 
-        let store_source = segment.open_read(SegmentComponent::STORE)?;
+        let store_file = segment.open_read(SegmentComponent::STORE)?;
 
         fail_point!("SegmentReader::open#middle");
 
-        let postings_source = segment.open_read(SegmentComponent::POSTINGS)?;
-        let postings_composite = CompositeFile::open(&postings_source)?;
+        let postings_file = segment.open_read(SegmentComponent::POSTINGS)?;
+        let postings_composite = CompositeFile::open(&postings_file)?;
 
         let positions_composite = {
-            if let Ok(source) = segment.open_read(SegmentComponent::POSITIONS) {
-                CompositeFile::open(&source)?
+            if let Ok(positions_file) = segment.open_read(SegmentComponent::POSITIONS) {
+                CompositeFile::open(&positions_file)?
             } else {
                 CompositeFile::empty()
             }
         };
 
         let positions_idx_composite = {
-            if let Ok(source) = segment.open_read(SegmentComponent::POSITIONSSKIP) {
-                CompositeFile::open(&source)?
+            if let Ok(positions_skip_file) = segment.open_read(SegmentComponent::POSITIONSSKIP) {
+                CompositeFile::open(&positions_skip_file)?
             } else {
                 CompositeFile::empty()
             }
@@ -176,28 +182,29 @@ 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 fieldnorms_data = segment.open_read(SegmentComponent::FIELDNORMS)?;
-        let fieldnorms_composite = CompositeFile::open(&fieldnorms_data)?;
+        let fieldnorm_data = segment.open_read(SegmentComponent::FIELDNORMS)?;
+        let fieldnorm_readers = FieldNormReaders::open(fieldnorm_data)?;
 
         let delete_bitset_opt = if segment.meta().has_deletes() {
             let delete_data = segment.open_read(SegmentComponent::DELETE)?;
-            Some(DeleteBitSet::open(delete_data))
+            let delete_bitset = DeleteBitSet::open(delete_data)?;
+            Some(delete_bitset)
         } else {
             None
         };
 
         Ok(SegmentReader {
-            inv_idx_reader_cache: Arc::new(RwLock::new(HashMap::new())),
+            inv_idx_reader_cache: Default::default(),
             max_doc: segment.meta().max_doc(),
             num_docs: segment.meta().num_docs(),
             termdict_composite,
             postings_composite,
             fast_fields_readers: fast_field_readers,
-            fieldnorms_composite,
+            fieldnorm_readers,
             segment_id: segment.id(),
-            store_source,
+            store_file,
             delete_bitset_opt,
             positions_composite,
             positions_idx_composite,
@@ -212,58 +219,64 @@ impl SegmentReader {
     /// The field reader is in charge of iterating through the
     /// term dictionary associated to a specific field,
     /// and opening the posting list associated to any term.
-    pub fn inverted_index(&self, field: Field) -> Arc<InvertedIndexReader> {
+    ///
+    /// If the field is marked as index, a warn is logged and an empty `InvertedIndexReader`
+    /// is returned.
+    /// Similarly if the field is marked as indexed but no term has been indexed for the given
+    /// index. an empty `InvertedIndexReader` is returned (but no warning is logged).
+    pub fn inverted_index(&self, field: Field) -> crate::Result<Arc<InvertedIndexReader>> {
         if let Some(inv_idx_reader) = self
             .inv_idx_reader_cache
             .read()
             .expect("Lock poisoned. This should never happen")
             .get(&field)
         {
-            return Arc::clone(inv_idx_reader);
+            return Ok(Arc::clone(inv_idx_reader));
         }
         let field_entry = self.schema.get_field_entry(field);
         let field_type = field_entry.field_type();
         let record_option_opt = field_type.get_index_record_option();
 
         if record_option_opt.is_none() {
-            panic!("Field {:?} does not seem indexed.", field_entry.name());
+            warn!("Field {:?} does not seem indexed.", field_entry.name());
         }
 
-        let record_option = record_option_opt.unwrap();
+        let postings_file_opt = self.postings_composite.open_read(field);
 
-        let postings_source_opt = self.postings_composite.open_read(field);
-
-        if postings_source_opt.is_none() {
+        if postings_file_opt.is_none() || record_option_opt.is_none() {
             // no documents in the segment contained this field.
             // As a result, no data is associated to the inverted index.
             //
             // Returns an empty inverted index.
-            return Arc::new(InvertedIndexReader::empty(field_type));
+            let record_option = record_option_opt.unwrap_or(IndexRecordOption::Basic);
+            return Ok(Arc::new(InvertedIndexReader::empty(record_option)));
         }
 
-        let postings_source = postings_source_opt.unwrap();
+        let record_option = record_option_opt.unwrap();
+        let postings_file = postings_file_opt.unwrap();
 
-        let termdict_source = self.termdict_composite.open_read(field).expect(
-            "Failed to open field term dictionary in composite file. Is the field indexed?",
-        );
+        let termdict_file: FileSlice = self.termdict_composite.open_read(field)
+            .ok_or_else(||
+               DataCorruption::comment_only(format!("Failed to open field {:?}'s term dictionary in the composite file. Has the schema been modified?", field_entry.name()))
+            )?;
 
-        let positions_source = self
+        let positions_file = self
             .positions_composite
             .open_read(field)
             .expect("Index corrupted. Failed to open field positions in composite file.");
 
-        let positions_idx_source = self
+        let positions_idx_file = self
             .positions_idx_composite
             .open_read(field)
             .expect("Index corrupted. Failed to open field positions in composite file.");
 
         let inv_idx_reader = Arc::new(InvertedIndexReader::new(
-            TermDictionary::from_source(&termdict_source),
-            postings_source,
-            positions_source,
-            positions_idx_source,
+            TermDictionary::open(termdict_file)?,
+            postings_file,
+            positions_file,
+            positions_idx_file,
             record_option,
-        ));
+        )?);
 
         // by releasing the lock in between, we may end up opening the inverting index
         // twice, but this is fine.
@@ -272,7 +285,7 @@ impl SegmentReader {
             .expect("Field reader cache lock poisoned. This should never happen.")
             .insert(field, Arc::clone(&inv_idx_reader));
 
-        inv_idx_reader
+        Ok(inv_idx_reader)
     }
 
     /// Returns the segment id
@@ -295,26 +308,26 @@ impl SegmentReader {
     }
 
     /// Returns an iterator that will iterate over the alive document ids
-    pub fn doc_ids_alive(&self) -> SegmentReaderAliveDocsIterator<'_> {
-        SegmentReaderAliveDocsIterator::new(&self)
+    pub fn doc_ids_alive(&self) -> impl Iterator<Item = DocId> + '_ {
+        (0u32..self.max_doc).filter(move |doc| !self.is_deleted(*doc))
     }
 
     /// Summarize total space usage of this segment.
-    pub fn space_usage(&self) -> SegmentSpaceUsage {
-        SegmentSpaceUsage::new(
+    pub fn space_usage(&self) -> io::Result<SegmentSpaceUsage> {
+        Ok(SegmentSpaceUsage::new(
             self.num_docs(),
             self.termdict_composite.space_usage(),
             self.postings_composite.space_usage(),
             self.positions_composite.space_usage(),
             self.positions_idx_composite.space_usage(),
             self.fast_fields_readers.space_usage(),
-            self.fieldnorms_composite.space_usage(),
-            self.get_store_reader().space_usage(),
+            self.fieldnorm_readers.space_usage(),
+            self.get_store_reader()?.space_usage(),
             self.delete_bitset_opt
                 .as_ref()
                 .map(DeleteBitSet::space_usage)
                 .unwrap_or(0),
-        )
+        ))
     }
 }
 
@@ -324,52 +337,6 @@ impl fmt::Debug for SegmentReader {
     }
 }
 
-/// Implements the iterator trait to allow easy iteration
-/// over non-deleted ("alive") DocIds in a SegmentReader
-pub struct SegmentReaderAliveDocsIterator<'a> {
-    reader: &'a SegmentReader,
-    max_doc: DocId,
-    current: DocId,
-}
-
-impl<'a> SegmentReaderAliveDocsIterator<'a> {
-    pub fn new(reader: &'a SegmentReader) -> SegmentReaderAliveDocsIterator<'a> {
-        SegmentReaderAliveDocsIterator {
-            reader,
-            max_doc: reader.max_doc(),
-            current: 0,
-        }
-    }
-}
-
-impl<'a> Iterator for SegmentReaderAliveDocsIterator<'a> {
-    type Item = DocId;
-
-    fn next(&mut self) -> Option<Self::Item> {
-        // TODO: Use TinySet (like in BitSetDocSet) to speed this process up
-        if self.current >= self.max_doc {
-            return None;
-        }
-
-        // find the next alive doc id
-        while self.reader.is_deleted(self.current) {
-            self.current += 1;
-
-            if self.current >= self.max_doc {
-                return None;
-            }
-        }
-
-        // capture the current alive DocId
-        let result = Some(self.current);
-
-        // move down the chain
-        self.current += 1;
-
-        result
-    }
-}
-
 #[cfg(test)]
 mod test {
     use crate::core::Index;
@@ -377,7 +344,7 @@ mod test {
     use crate::DocId;
 
     #[test]
-    fn test_alive_docs_iterator() {
+    fn test_alive_docs_iterator() -> crate::Result<()> {
         let mut schema_builder = Schema::builder();
         schema_builder.add_text_field("name", TEXT | STORED);
         let schema = schema_builder.build();
@@ -385,26 +352,26 @@ mod test {
         let name = schema.get_field("name").unwrap();
 
         {
-            let mut index_writer = index.writer_with_num_threads(1, 3_000_000).unwrap();
+            let mut index_writer = index.writer_for_tests()?;
             index_writer.add_document(doc!(name => "tantivy"));
             index_writer.add_document(doc!(name => "horse"));
             index_writer.add_document(doc!(name => "jockey"));
             index_writer.add_document(doc!(name => "cap"));
-
             // we should now have one segment with two docs
-            index_writer.commit().unwrap();
+            index_writer.commit()?;
         }
 
         {
-            let mut index_writer2 = index.writer(50_000_000).unwrap();
+            let mut index_writer2 = index.writer(50_000_000)?;
             index_writer2.delete_term(Term::from_field_text(name, "horse"));
             index_writer2.delete_term(Term::from_field_text(name, "cap"));
 
             // ok, now we should have a deleted doc
-            index_writer2.commit().unwrap();
+            index_writer2.commit()?;
         }
-        let searcher = index.reader().unwrap().searcher();
+        let searcher = index.reader()?.searcher();
         let docs: Vec<DocId> = searcher.segment_reader(0).doc_ids_alive().collect();
         assert_eq!(vec![0u32, 2u32], docs);
+        Ok(())
     }
 }

src/directory/directory.rs

@@ -1,9 +1,9 @@
 use crate::directory::directory_lock::Lock;
 use crate::directory::error::LockError;
 use crate::directory::error::{DeleteError, OpenReadError, OpenWriteError};
-use crate::directory::WatchCallback;
 use crate::directory::WatchHandle;
-use crate::directory::{ReadOnlySource, WritePtr};
+use crate::directory::{FileHandle, WatchCallback};
+use crate::directory::{FileSlice, WritePtr};
 use std::fmt;
 use std::io;
 use std::io::Write;
@@ -11,7 +11,6 @@ use std::marker::Send;
 use std::marker::Sync;
 use std::path::Path;
 use std::path::PathBuf;
-use std::result;
 use std::thread;
 use std::time::Duration;
 
@@ -80,7 +79,7 @@ fn try_acquire_lock(
 ) -> Result<DirectoryLock, TryAcquireLockError> {
     let mut write = directory.open_write(filepath).map_err(|e| match e {
         OpenWriteError::FileAlreadyExists(_) => TryAcquireLockError::FileExists,
-        OpenWriteError::IOError(io_error) => TryAcquireLockError::IOError(io_error.into()),
+        OpenWriteError::IOError { io_error, .. } => TryAcquireLockError::IOError(io_error),
     })?;
     write.flush().map_err(TryAcquireLockError::IOError)?;
     Ok(DirectoryLock::from(Box::new(DirectoryLockGuard {
@@ -109,37 +108,43 @@ fn retry_policy(is_blocking: bool) -> RetryPolicy {
 /// should be your default choice.
 /// - The [`RAMDirectory`](struct.RAMDirectory.html), which
 /// should be used mostly for tests.
-///
 pub trait Directory: DirectoryClone + fmt::Debug + Send + Sync + 'static {
-    /// Opens a virtual file for read.
+    /// Opens a file and returns a boxed `FileHandle`.
     ///
+    /// Users of `Directory` should typically call `Directory::open_read(...)`,
+    /// while `Directory` implementor should implement `get_file_handle()`.
+    fn get_file_handle(&self, path: &Path) -> Result<Box<dyn FileHandle>, OpenReadError>;
+
     /// Once a virtual file is open, its data may not
     /// change.
     ///
     /// Specifically, subsequent writes or flushes should
-    /// have no effect on the returned `ReadOnlySource` object.
+    /// have no effect on the returned `FileSlice` object.
     ///
     /// You should only use this to read files create with [Directory::open_write].
-    fn open_read(&self, path: &Path) -> result::Result<ReadOnlySource, OpenReadError>;
+    fn open_read(&self, path: &Path) -> Result<FileSlice, OpenReadError> {
+        let file_handle = self.get_file_handle(path)?;
+        Ok(FileSlice::new(file_handle))
+    }
 
     /// Removes a file
     ///
     /// Removing a file will not affect an eventual
-    /// existing ReadOnlySource pointing to it.
+    /// existing FileSlice pointing to it.
     ///
     /// Removing a nonexistent file, yields a
     /// `DeleteError::DoesNotExist`.
-    fn delete(&self, path: &Path) -> result::Result<(), DeleteError>;
+    fn delete(&self, path: &Path) -> Result<(), DeleteError>;
 
     /// Returns true iff the file exists
-    fn exists(&self, path: &Path) -> bool;
+    fn exists(&self, path: &Path) -> Result<bool, OpenReadError>;
 
     /// Opens a writer for the *virtual file* associated with
     /// a Path.
     ///
     /// Right after this call, the file should be created
     /// and any subsequent call to `open_read` for the
-    /// same path should return a `ReadOnlySource`.
+    /// same path should return a `FileSlice`.
     ///
     /// Write operations may be aggressively buffered.
     /// The client of this trait is responsible for calling flush
@@ -153,7 +158,7 @@ pub trait Directory: DirectoryClone + fmt::Debug + Send + Sync + 'static {
     /// was not called.
     ///
     /// The file may not previously exist.
-    fn open_write(&mut self, path: &Path) -> Result<WritePtr, OpenWriteError>;
+    fn open_write(&self, path: &Path) -> Result<WritePtr, OpenWriteError>;
 
     /// Reads the full content file that has been written using
     /// atomic_write.
@@ -169,7 +174,7 @@ pub trait Directory: DirectoryClone + fmt::Debug + Send + Sync + 'static {
     /// a partially written file.
     ///
     /// The file may or may not previously exist.
-    fn atomic_write(&mut self, path: &Path, data: &[u8]) -> io::Result<()>;
+    fn atomic_write(&self, path: &Path, data: &[u8]) -> io::Result<()>;
 
     /// Acquire a lock in the given directory.
     ///

src/directory/error.rs

@@ -1,162 +1,68 @@
 use crate::Version;
-use std::error::Error as StdError;
 use std::fmt;
 use std::io;
 use std::path::PathBuf;
 
 /// Error while trying to acquire a directory lock.
-#[derive(Debug, Fail)]
+#[derive(Debug, Error)]
 pub enum LockError {
     /// Failed to acquired a lock as it is already held by another
     /// client.
     /// - In the context of a blocking lock, this means the lock was not released within some `timeout` period.
     /// - In the context of a non-blocking lock, this means the lock was busy at the moment of the call.
-    #[fail(
-        display = "Could not acquire lock as it is already held, possibly by a different process."
-    )]
+    #[error("Could not acquire lock as it is already held, possibly by a different process.")]
     LockBusy,
     /// Trying to acquire a lock failed with an `IOError`
-    #[fail(display = "Failed to acquire the lock due to an io:Error.")]
+    #[error("Failed to acquire the lock due to an io:Error.")]
     IOError(io::Error),
 }
 
-/// General IO error with an optional path to the offending file.
-#[derive(Debug)]
-pub struct IOError {
-    path: Option<PathBuf>,
-    err: io::Error,
-}
-
-impl Into<io::Error> for IOError {
-    fn into(self) -> io::Error {
-        self.err
-    }
-}
-
-impl fmt::Display for IOError {
-    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        match self.path {
-            Some(ref path) => write!(f, "io error occurred on path '{:?}': '{}'", path, self.err),
-            None => write!(f, "io error occurred: '{}'", self.err),
-        }
-    }
-}
-
-impl StdError for IOError {
-    fn description(&self) -> &str {
-        "io error occurred"
-    }
-
-    fn cause(&self) -> Option<&dyn StdError> {
-        Some(&self.err)
-    }
-}
-
-impl IOError {
-    pub(crate) fn with_path(path: PathBuf, err: io::Error) -> Self {
-        IOError {
-            path: Some(path),
-            err,
-        }
-    }
-}
-
-impl From<io::Error> for IOError {
-    fn from(err: io::Error) -> IOError {
-        IOError { path: None, err }
-    }
-}
-
 /// Error that may occur when opening a directory
-#[derive(Debug)]
+#[derive(Debug, Error)]
 pub enum OpenDirectoryError {
     /// The underlying directory does not exists.
+    #[error("Directory does not exist: '{0}'.")]
     DoesNotExist(PathBuf),
     /// The path exists but is not a directory.
+    #[error("Path exists but is not a directory: '{0}'.")]
     NotADirectory(PathBuf),
+    /// Failed to create a temp directory.
+    #[error("Failed to create a temporary directory: '{0}'.")]
+    FailedToCreateTempDir(io::Error),
     /// IoError
-    IoError(io::Error),
-}
-
-impl From<io::Error> for OpenDirectoryError {
-    fn from(io_err: io::Error) -> Self {
-        OpenDirectoryError::IoError(io_err)
-    }
-}
-
-impl fmt::Display for OpenDirectoryError {
-    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        match *self {
-            OpenDirectoryError::DoesNotExist(ref path) => {
-                write!(f, "the underlying directory '{:?}' does not exist", path)
-            }
-            OpenDirectoryError::NotADirectory(ref path) => {
-                write!(f, "the path '{:?}' exists but is not a directory", path)
-            }
-            OpenDirectoryError::IoError(ref err) => write!(
-                f,
-                "IOError while trying to open/create the directory. {:?}",
-                err
-            ),
-        }
-    }
-}
-
-impl StdError for OpenDirectoryError {
-    fn description(&self) -> &str {
-        "error occurred while opening a directory"
-    }
-
-    fn cause(&self) -> Option<&dyn StdError> {
-        None
-    }
+    #[error("IOError '{io_error:?}' while create directory in: '{directory_path:?}'.")]
+    IoError {
+        /// underlying io Error.
+        io_error: io::Error,
+        /// directory we tried to open.
+        directory_path: PathBuf,
+    },
 }
 
 /// Error that may occur when starting to write in a file
-#[derive(Debug)]
+#[derive(Debug, Error)]
 pub enum OpenWriteError {
     /// Our directory is WORM, writing an existing file is forbidden.
     /// Checkout the `Directory` documentation.
+    #[error("File already exists: '{0}'")]
     FileAlreadyExists(PathBuf),
     /// Any kind of IO error that happens when
     /// writing in the underlying IO device.
-    IOError(IOError),
+    #[error("IOError '{io_error:?}' while opening file for write: '{filepath}'.")]
+    IOError {
+        /// The underlying `io::Error`.
+        io_error: io::Error,
+        /// File path of the file that tantivy failed to open for write.
+        filepath: PathBuf,
+    },
 }
 
-impl From<IOError> for OpenWriteError {
-    fn from(err: IOError) -> OpenWriteError {
-        OpenWriteError::IOError(err)
+impl OpenWriteError {
+    /// Wraps an io error.
+    pub fn wrap_io_error(io_error: io::Error, filepath: PathBuf) -> Self {
+        Self::IOError { io_error, filepath }
     }
 }
-
-impl fmt::Display for OpenWriteError {
-    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        match *self {
-            OpenWriteError::FileAlreadyExists(ref path) => {
-                write!(f, "the file '{:?}' already exists", path)
-            }
-            OpenWriteError::IOError(ref err) => write!(
-                f,
-                "an io error occurred while opening a file for writing: '{}'",
-                err
-            ),
-        }
-    }
-}
-
-impl StdError for OpenWriteError {
-    fn description(&self) -> &str {
-        "error occurred while opening a file for writing"
-    }
-
-    fn cause(&self) -> Option<&dyn StdError> {
-        match *self {
-            OpenWriteError::FileAlreadyExists(_) => None,
-            OpenWriteError::IOError(ref err) => Some(err),
-        }
-    }
-}
-
 /// Type of index incompatibility between the library and the index found on disk
 /// Used to catch and provide a hint to solve this incompatibility issue
 pub enum Incompatibility {
@@ -217,55 +123,47 @@ impl fmt::Debug for Incompatibility {
 }
 
 /// Error that may occur when accessing a file read
-#[derive(Debug)]
+#[derive(Debug, Error)]
 pub enum OpenReadError {
     /// The file does not exists.
+    #[error("Files does not exists: {0:?}")]
     FileDoesNotExist(PathBuf),
-    /// Any kind of IO error that happens when
-    /// interacting with the underlying IO device.
-    IOError(IOError),
-    /// This library doesn't support the index version found on disk
+    /// Any kind of io::Error.
+    #[error(
+        "IOError: '{io_error:?}' happened while opening the following file for Read: {filepath}."
+    )]
+    IOError {
+        /// The underlying `io::Error`.
+        io_error: io::Error,
+        /// File path of the file that tantivy failed to open for read.
+        filepath: PathBuf,
+    },
+    /// This library does not support the index version found in file footer.
+    #[error("Index version unsupported: {0:?}")]
     IncompatibleIndex(Incompatibility),
 }
 
-impl From<IOError> for OpenReadError {
-    fn from(err: IOError) -> OpenReadError {
-        OpenReadError::IOError(err)
+impl OpenReadError {
+    /// Wraps an io error.
+    pub fn wrap_io_error(io_error: io::Error, filepath: PathBuf) -> Self {
+        Self::IOError { io_error, filepath }
     }
 }
-
-impl fmt::Display for OpenReadError {
-    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        match *self {
-            OpenReadError::FileDoesNotExist(ref path) => {
-                write!(f, "the file '{:?}' does not exist", path)
-            }
-            OpenReadError::IOError(ref err) => write!(
-                f,
-                "an io error occurred while opening a file for reading: '{}'",
-                err
-            ),
-            OpenReadError::IncompatibleIndex(ref footer) => {
-                write!(f, "Incompatible index format: {:?}", footer)
-            }
-        }
-    }
-}
-
 /// Error that may occur when trying to delete a file
-#[derive(Debug)]
+#[derive(Debug, Error)]
 pub enum DeleteError {
     /// The file does not exists.
+    #[error("File does not exists: '{0}'.")]
     FileDoesNotExist(PathBuf),
     /// Any kind of IO error that happens when
     /// interacting with the underlying IO device.
-    IOError(IOError),
-}
-
-impl From<IOError> for DeleteError {
-    fn from(err: IOError) -> DeleteError {
-        DeleteError::IOError(err)
-    }
+    #[error("The following IO error happened while deleting file '{filepath}': '{io_error:?}'.")]
+    IOError {
+        /// The underlying `io::Error`.
+        io_error: io::Error,
+        /// File path of the file that tantivy failed to delete.
+        filepath: PathBuf,
+    },
 }
 
 impl From<Incompatibility> for OpenReadError {
@@ -273,29 +171,3 @@ impl From<Incompatibility> for OpenReadError {
         OpenReadError::IncompatibleIndex(incompatibility)
     }
 }
-
-impl fmt::Display for DeleteError {
-    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        match *self {
-            DeleteError::FileDoesNotExist(ref path) => {
-                write!(f, "the file '{:?}' does not exist", path)
-            }
-            DeleteError::IOError(ref err) => {
-                write!(f, "an io error occurred while deleting a file: '{}'", err)
-            }
-        }
-    }
-}
-
-impl StdError for DeleteError {
-    fn description(&self) -> &str {
-        "error occurred while deleting a file"
-    }
-
-    fn cause(&self) -> Option<&dyn StdError> {
-        match *self {
-            DeleteError::FileDoesNotExist(_) => None,
-            DeleteError::IOError(ref err) => Some(err),
-        }
-    }
-}

src/directory/file_slice.rs

@@ -0,0 +1,246 @@
+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};
+
+pub type ArcBytes = Arc<dyn Deref<Target = [u8]> + Send + Sync + 'static>;
+pub type WeakArcBytes = Weak<dyn Deref<Target = [u8]> + Send + Sync + 'static>;
+
+/// Objects that represents files sections in tantivy.
+///
+/// By contract, whatever happens to the directory file, as long as a FileHandle
+/// is alive, the data associated with it cannot be altered or destroyed.
+///
+/// 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 + fmt::Debug {
+    /// Reads a slice of bytes.
+    ///
+    /// This method may panic if the range requested is invalid.
+    fn read_bytes(&self, range: Range<usize>) -> io::Result<OwnedBytes>;
+}
+
+impl FileHandle for &'static [u8] {
+    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.deref().len()
+    }
+}
+
+impl<B> From<B> for FileSlice
+where
+    B: StableDeref + Deref<Target = [u8]> + 'static + Send + Sync,
+{
+    fn from(bytes: B) -> FileSlice {
+        FileSlice::new(Box::new(OwnedBytes::new(bytes)))
+    }
+}
+
+/// Logical slice of read only file in tantivy.
+///
+/// It can be cloned and sliced cheaply.
+///
+#[derive(Clone)]
+pub struct FileSlice {
+    data: Arc<dyn FileHandle>,
+    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 {
+    /// Wraps a FileHandle.
+    pub fn new(file_handle: Box<dyn FileHandle>) -> Self {
+        let num_bytes = file_handle.len();
+        FileSlice::new_with_num_bytes(file_handle, num_bytes)
+    }
+
+    /// Wraps a FileHandle.
+    #[doc(hidden)]
+    pub fn new_with_num_bytes(file_handle: Box<dyn FileHandle>, num_bytes: usize) -> Self {
+        FileSlice {
+            data: Arc::from(file_handle),
+            range: 0..num_bytes,
+        }
+    }
+
+    /// Creates a fileslice that is just a view over a slice of the data.
+    ///
+    /// # Panics
+    ///
+    /// 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(),
+            range: self.range.start + byte_range.start..self.range.start + byte_range.end,
+        }
+    }
+
+    /// Creates an empty FileSlice
+    pub fn empty() -> FileSlice {
+        const EMPTY_SLICE: &[u8] = &[];
+        FileSlice::from(EMPTY_SLICE)
+    }
+
+    /// Returns a `OwnedBytes` with all of the data in the `FileSlice`.
+    ///
+    /// The behavior is strongly dependant on the implementation of the underlying
+    /// `Directory` and the `FileSliceTrait` it creates.
+    /// 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.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, range: Range<usize>) -> io::Result<OwnedBytes> {
+        assert!(
+            range.end <= self.len(),
+            "end of requested range exceeds the fileslice length ({} > {})",
+            range.end,
+            self.len()
+        );
+        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.
+    /// `file_slice[..split_offset]` and `file_slice[split_offset..]`.
+    ///
+    /// This operation is cheap and must not copy any underlying data.
+    pub fn split(self, left_len: usize) -> (FileSlice, FileSlice) {
+        let left = self.slice_to(left_len);
+        let right = self.slice_from(left_len);
+        (left, right)
+    }
+
+    /// Splits the file slice at the given offset and return two file slices.
+    /// `file_slice[..split_offset]` and `file_slice[split_offset..]`.
+    pub fn split_from_end(self, right_len: usize) -> (FileSlice, FileSlice) {
+        let left_len = self.len() - right_len;
+        self.split(left_len)
+    }
+
+    /// Like `.slice(...)` but enforcing only the `from`
+    /// boundary.
+    ///
+    /// Equivalent to `.slice(from_offset, self.len())`
+    pub fn slice_from(&self, from_offset: usize) -> FileSlice {
+        self.slice(from_offset..self.len())
+    }
+
+    /// Like `.slice(...)` but enforcing only the `to`
+    /// boundary.
+    ///
+    /// Equivalent to `.slice(0, to_offset)`
+    pub fn slice_to(&self, to_offset: usize) -> FileSlice {
+        self.slice(0..to_offset)
+    }
+}
+
+impl FileHandle for FileSlice {
+    fn read_bytes(&self, range: Range<usize>) -> io::Result<OwnedBytes> {
+        self.read_bytes_slice(range)
+    }
+}
+
+impl HasLen for FileSlice {
+    fn len(&self) -> usize {
+        self.range.len()
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::{FileHandle, FileSlice};
+    use crate::common::HasLen;
+    use std::io;
+
+    #[test]
+    fn test_file_slice() -> io::Result<()> {
+        let file_slice = FileSlice::new(Box::new(b"abcdef".as_ref()));
+        assert_eq!(file_slice.len(), 6);
+        assert_eq!(file_slice.slice_from(2).read_bytes()?.as_slice(), b"cdef");
+        assert_eq!(file_slice.slice_to(2).read_bytes()?.as_slice(), b"ab");
+        assert_eq!(
+            file_slice
+                .slice_from(1)
+                .slice_to(2)
+                .read_bytes()?
+                .as_slice(),
+            b"bc"
+        );
+        {
+            let (left, right) = file_slice.clone().split(0);
+            assert_eq!(left.read_bytes()?.as_slice(), b"");
+            assert_eq!(right.read_bytes()?.as_slice(), b"abcdef");
+        }
+        {
+            let (left, right) = file_slice.clone().split(2);
+            assert_eq!(left.read_bytes()?.as_slice(), b"ab");
+            assert_eq!(right.read_bytes()?.as_slice(), b"cdef");
+        }
+        {
+            let (left, right) = file_slice.clone().split_from_end(0);
+            assert_eq!(left.read_bytes()?.as_slice(), b"abcdef");
+            assert_eq!(right.read_bytes()?.as_slice(), b"");
+        }
+        {
+            let (left, right) = file_slice.clone().split_from_end(2);
+            assert_eq!(left.read_bytes()?.as_slice(), b"abcd");
+            assert_eq!(right.read_bytes()?.as_slice(), b"ef");
+        }
+        Ok(())
+    }
+
+    #[test]
+    fn test_file_slice_trait_slice_len() {
+        let blop: &'static [u8] = b"abc";
+        let owned_bytes: Box<dyn FileHandle> = Box::new(blop);
+        assert_eq!(owned_bytes.len(), 3);
+    }
+
+    #[test]
+    fn test_slice_simple_read() -> io::Result<()> {
+        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");
+        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");
+        Ok(())
+    }
+
+    #[test]
+    #[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(),
+            b"bcd"
+        );
+    }
+}

src/directory/file_watcher.rs

@@ -0,0 +1,182 @@
+use crate::directory::{WatchCallback, WatchCallbackList, WatchHandle};
+use crc32fast::Hasher;
+use std::fs;
+use std::io;
+use std::io::BufRead;
+use std::path::Path;
+use std::sync::atomic::{AtomicUsize, Ordering};
+use std::sync::Arc;
+use std::thread;
+use std::time::Duration;
+
+pub const POLLING_INTERVAL: Duration = Duration::from_millis(if cfg!(test) { 1 } else { 500 });
+
+// Watches a file and executes registered callbacks when the file is modified.
+pub struct FileWatcher {
+    path: Arc<Path>,
+    callbacks: Arc<WatchCallbackList>,
+    state: Arc<AtomicUsize>, // 0: new, 1: runnable, 2: terminated
+}
+
+impl FileWatcher {
+    pub fn new(path: &Path) -> FileWatcher {
+        FileWatcher {
+            path: Arc::from(path),
+            callbacks: Default::default(),
+            state: Default::default(),
+        }
+    }
+
+    pub fn spawn(&self) {
+        if self
+            .state
+            .compare_exchange(0, 1, Ordering::SeqCst, Ordering::SeqCst)
+            .is_err()
+        {
+            return;
+        }
+
+        let path = self.path.clone();
+        let callbacks = self.callbacks.clone();
+        let state = self.state.clone();
+
+        thread::Builder::new()
+            .name("thread-tantivy-meta-file-watcher".to_string())
+            .spawn(move || {
+                let mut current_checksum = None;
+
+                while state.load(Ordering::SeqCst) == 1 {
+                    if let Ok(checksum) = FileWatcher::compute_checksum(&path) {
+                        // `None.unwrap_or_else(|| !checksum) != checksum` evaluates to `true`
+                        if current_checksum.unwrap_or_else(|| !checksum) != checksum {
+                            info!("Meta file {:?} was modified", path);
+                            current_checksum = Some(checksum);
+                            futures::executor::block_on(callbacks.broadcast());
+                        }
+                    }
+
+                    thread::sleep(POLLING_INTERVAL);
+                }
+            })
+            .expect("Failed to spawn meta file watcher thread");
+    }
+
+    pub fn watch(&self, callback: WatchCallback) -> WatchHandle {
+        let handle = self.callbacks.subscribe(callback);
+        self.spawn();
+        handle
+    }
+
+    fn compute_checksum(path: &Path) -> Result<u32, io::Error> {
+        let reader = match fs::File::open(path) {
+            Ok(f) => io::BufReader::new(f),
+            Err(e) => {
+                warn!("Failed to open meta file {:?}: {:?}", path, e);
+                return Err(e);
+            }
+        };
+
+        let mut hasher = Hasher::new();
+
+        for line in reader.lines() {
+            hasher.update(line?.as_bytes())
+        }
+
+        Ok(hasher.finalize())
+    }
+}
+
+impl Drop for FileWatcher {
+    fn drop(&mut self) {
+        self.state.store(2, Ordering::SeqCst);
+    }
+}
+
+#[cfg(test)]
+mod tests {
+
+    use std::mem;
+
+    use crate::directory::mmap_directory::atomic_write;
+
+    use super::*;
+
+    #[test]
+    fn test_file_watcher_drop_watcher() -> crate::Result<()> {
+        let tmp_dir = tempfile::TempDir::new()?;
+        let tmp_file = tmp_dir.path().join("watched.txt");
+
+        let counter: Arc<AtomicUsize> = Default::default();
+        let (tx, rx) = crossbeam::channel::unbounded();
+        let timeout = Duration::from_millis(100);
+
+        let watcher = FileWatcher::new(&tmp_file);
+
+        let state = watcher.state.clone();
+        assert_eq!(state.load(Ordering::SeqCst), 0);
+
+        let counter_clone = counter.clone();
+
+        let _handle = watcher.watch(WatchCallback::new(move || {
+            let val = counter_clone.fetch_add(1, Ordering::SeqCst);
+            tx.send(val + 1).unwrap();
+        }));
+
+        assert_eq!(counter.load(Ordering::SeqCst), 0);
+        assert_eq!(state.load(Ordering::SeqCst), 1);
+
+        atomic_write(&tmp_file, b"foo")?;
+        assert_eq!(rx.recv_timeout(timeout), Ok(1));
+
+        atomic_write(&tmp_file, b"foo")?;
+        assert!(rx.recv_timeout(timeout).is_err());
+
+        atomic_write(&tmp_file, b"bar")?;
+        assert_eq!(rx.recv_timeout(timeout), Ok(2));
+
+        mem::drop(watcher);
+
+        atomic_write(&tmp_file, b"qux")?;
+        thread::sleep(Duration::from_millis(10));
+        assert_eq!(counter.load(Ordering::SeqCst), 2);
+        assert_eq!(state.load(Ordering::SeqCst), 2);
+
+        Ok(())
+    }
+
+    #[test]
+    fn test_file_watcher_drop_handle() -> crate::Result<()> {
+        let tmp_dir = tempfile::TempDir::new()?;
+        let tmp_file = tmp_dir.path().join("watched.txt");
+
+        let counter: Arc<AtomicUsize> = Default::default();
+        let (tx, rx) = crossbeam::channel::unbounded();
+        let timeout = Duration::from_millis(100);
+
+        let watcher = FileWatcher::new(&tmp_file);
+
+        let state = watcher.state.clone();
+        assert_eq!(state.load(Ordering::SeqCst), 0);
+
+        let counter_clone = counter.clone();
+
+        let handle = watcher.watch(WatchCallback::new(move || {
+            let val = counter_clone.fetch_add(1, Ordering::SeqCst);
+            tx.send(val + 1).unwrap();
+        }));
+
+        assert_eq!(counter.load(Ordering::SeqCst), 0);
+        assert_eq!(state.load(Ordering::SeqCst), 1);
+
+        atomic_write(&tmp_file, b"foo")?;
+        assert_eq!(rx.recv_timeout(timeout), Ok(1));
+
+        mem::drop(handle);
+
+        atomic_write(&tmp_file, b"qux")?;
+        assert_eq!(counter.load(Ordering::SeqCst), 1);
+        assert_eq!(state.load(Ordering::SeqCst), 1);
+
+        Ok(())
+    }
+}

src/directory/footer.rs

@@ -1,9 +1,8 @@
-use crate::common::{BinarySerializable, CountingWriter, FixedSize, VInt};
+use crate::common::{BinarySerializable, CountingWriter, FixedSize, HasLen, VInt};
 use crate::directory::error::Incompatibility;
-use crate::directory::read_only_source::ReadOnlySource;
+use crate::directory::FileSlice;
 use crate::directory::{AntiCallToken, TerminatingWrite};
 use crate::Version;
-use byteorder::{ByteOrder, LittleEndian, WriteBytesExt};
 use crc32fast::Hasher;
 use std::io;
 use std::io::Write;
@@ -64,26 +63,26 @@ impl Footer {
         let mut counting_write = CountingWriter::wrap(&mut write);
         self.serialize(&mut counting_write)?;
         let written_len = counting_write.written_bytes();
-        write.write_u32::<LittleEndian>(written_len as u32)?;
+        (written_len as u32).serialize(write)?;
         Ok(())
     }
 
-    pub fn extract_footer(source: ReadOnlySource) -> Result<(Footer, ReadOnlySource), io::Error> {
-        if source.len() < 4 {
+    pub fn extract_footer(file: FileSlice) -> io::Result<(Footer, FileSlice)> {
+        if file.len() < 4 {
             return Err(io::Error::new(
                 io::ErrorKind::UnexpectedEof,
                 format!(
                     "File corrupted. The file is smaller than 4 bytes (len={}).",
-                    source.len()
+                    file.len()
                 ),
             ));
         }
-        let (body_footer, footer_len_bytes) = source.split_from_end(u32::SIZE_IN_BYTES);
-        let footer_len = LittleEndian::read_u32(footer_len_bytes.as_slice()) as usize;
-        let body_len = body_footer.len() - footer_len;
-        let (body, footer_data) = body_footer.split(body_len);
-        let mut cursor = footer_data.as_slice();
-        let footer = Footer::deserialize(&mut cursor)?;
+        let (body_footer, footer_len_file) = file.split_from_end(u32::SIZE_IN_BYTES);
+        let mut footer_len_bytes = footer_len_file.read_bytes()?;
+        let footer_len = u32::deserialize(&mut footer_len_bytes)? as usize;
+        let (body, footer) = body_footer.split_from_end(footer_len);
+        let mut footer_bytes = footer.read_bytes()?;
+        let footer = Footer::deserialize(&mut footer_bytes)?;
         Ok((footer, body))
     }
 
@@ -94,12 +93,36 @@ impl Footer {
         match &self.versioned_footer {
             VersionedFooter::V1 {
                 crc32: _crc,
-                store_compression: compression,
+                store_compression,
             } => {
-                if &library_version.store_compression != compression {
+                if &library_version.store_compression != store_compression {
                     return Err(Incompatibility::CompressionMismatch {
                         library_compression_format: library_version.store_compression.to_string(),
-                        index_compression_format: compression.to_string(),
+                        index_compression_format: store_compression.to_string(),
+                    });
+                }
+                Ok(())
+            }
+            VersionedFooter::V2 {
+                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::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(())
@@ -120,24 +143,36 @@ pub enum VersionedFooter {
         crc32: CrcHashU32,
         store_compression: String,
     },
+    // Introduction of the Block WAND information.
+    V2 {
+        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::V1 {
+            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(&1u32, &mut buf)?;
+                BinarySerializable::serialize(&3u32, &mut buf)?;
                 BinarySerializable::serialize(crc32, &mut buf)?;
                 BinarySerializable::serialize(compression, &mut buf)?;
             }
-            VersionedFooter::UnknownVersion => {
+            VersionedFooter::V2 { .. }
+            | VersionedFooter::V1 { .. }
+            | VersionedFooter::UnknownVersion => {
                 return Err(io::Error::new(
                     io::ErrorKind::InvalidInput,
                     "Cannot serialize an unknown versioned footer ",
@@ -166,22 +201,36 @@ impl BinarySerializable for VersionedFooter {
         reader.read_exact(&mut buf[..])?;
         let mut cursor = &buf[..];
         let version = u32::deserialize(&mut cursor)?;
-        if version == 1 {
-            let crc32 = u32::deserialize(&mut cursor)?;
-            let compression = String::deserialize(&mut cursor)?;
-            Ok(VersionedFooter::V1 {
-                crc32,
-                store_compression: compression,
-            })
-        } else {
-            Ok(VersionedFooter::UnknownVersion)
+        if version > 3 {
+            return Ok(VersionedFooter::UnknownVersion);
         }
+        let crc32 = u32::deserialize(&mut cursor)?;
+        let store_compression = String::deserialize(&mut cursor)?;
+        Ok(if version == 1 {
+            VersionedFooter::V1 {
+                crc32,
+                store_compression,
+            }
+        } else if version == 2 {
+            VersionedFooter::V2 {
+                crc32,
+                store_compression,
+            }
+        } else {
+            assert_eq!(version, 3);
+            VersionedFooter::V3 {
+                crc32,
+                store_compression,
+            }
+        })
     }
 }
 
 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,
         }
@@ -219,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::V1 {
+        let footer = Footer::new(VersionedFooter::V3 {
             crc32,
             store_compression: crate::store::COMPRESSION.to_string(),
         });
@@ -246,17 +295,17 @@ mod tests {
         let mut vec = Vec::new();
         let footer_proxy = FooterProxy::new(&mut vec);
         assert!(footer_proxy.terminate().is_ok());
-        assert_eq!(vec.len(), 167);
-        let footer = Footer::deserialize(&mut &vec[..]).unwrap();
-        if let VersionedFooter::V1 {
-            crc32: _,
-            store_compression,
-        } = footer.versioned_footer
-        {
-            assert_eq!(store_compression, crate::store::COMPRESSION);
+        if crate::store::COMPRESSION == "lz4" {
+            assert_eq!(vec.len(), 158);
         } else {
-            panic!("Versioned footer should be V1.");
+            assert_eq!(vec.len(), 167);
         }
+        let footer = Footer::deserialize(&mut &vec[..]).unwrap();
+        assert!(matches!(
+           footer.versioned_footer,
+           VersionedFooter::V3 { store_compression, .. }
+           if store_compression == crate::store::COMPRESSION
+        ));
         assert_eq!(&footer.version, crate::version());
     }
 
@@ -264,7 +313,7 @@ mod tests {
     fn test_serialize_deserialize_footer() {
         let mut buffer = Vec::new();
         let crc32 = 123456u32;
-        let footer: Footer = Footer::new(VersionedFooter::V1 {
+        let footer: Footer = Footer::new(VersionedFooter::V3 {
             crc32,
             store_compression: "lz4".to_string(),
         });
@@ -276,7 +325,7 @@ mod tests {
     #[test]
     fn footer_length() {
         let crc32 = 1111111u32;
-        let versioned_footer = VersionedFooter::V1 {
+        let versioned_footer = VersionedFooter::V3 {
             crc32,
             store_compression: "lz4".to_string(),
         };
@@ -297,7 +346,7 @@ mod tests {
             // versionned footer length
             12 | 128,
             // index format version
-            1,
+            3,
             0,
             0,
             0,
@@ -316,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::V1 {
+        let expected_versioned_footer: VersionedFooter = VersionedFooter::V3 {
             crc32: expected_crc,
             store_compression: "lz4".to_string(),
         };

src/directory/managed_directory.rs

@@ -1,17 +1,16 @@
-use crate::core::MANAGED_FILEPATH;
-use crate::directory::error::{DeleteError, IOError, LockError, OpenReadError, OpenWriteError};
+use crate::core::{MANAGED_FILEPATH, META_FILEPATH};
+use crate::directory::error::{DeleteError, LockError, OpenReadError, OpenWriteError};
 use crate::directory::footer::{Footer, FooterProxy};
-use crate::directory::DirectoryLock;
 use crate::directory::GarbageCollectionResult;
 use crate::directory::Lock;
 use crate::directory::META_LOCK;
-use crate::directory::{ReadOnlySource, WritePtr};
+use crate::directory::{DirectoryLock, FileHandle};
+use crate::directory::{FileSlice, WritePtr};
 use crate::directory::{WatchCallback, WatchHandle};
 use crate::error::DataCorruption;
 use crate::Directory;
 
 use crc32fast::Hasher;
-use serde_json;
 use std::collections::HashSet;
 use std::io;
 use std::io::Write;
@@ -54,7 +53,7 @@ struct MetaInformation {
 /// Saves the file containing the list of existing files
 /// that were created by tantivy.
 fn save_managed_paths(
-    directory: &mut dyn Directory,
+    directory: &dyn Directory,
     wlock: &RwLockWriteGuard<'_, MetaInformation>,
 ) -> io::Result<()> {
     let mut w = serde_json::to_vec(&wlock.managed_paths)?;
@@ -87,7 +86,7 @@ impl ManagedDirectory {
                 directory: Box::new(directory),
                 meta_informations: Arc::default(),
             }),
-            Err(OpenReadError::IOError(e)) => Err(From::from(e)),
+            io_err @ Err(OpenReadError::IOError { .. }) => Err(io_err.err().unwrap().into()),
             Err(OpenReadError::IncompatibleIndex(incompatibility)) => {
                 // For the moment, this should never happen  `meta.json`
                 // do not have any footer and cannot detect incompatibility.
@@ -169,7 +168,7 @@ impl ManagedDirectory {
                         DeleteError::FileDoesNotExist(_) => {
                             deleted_files.push(file_to_delete.clone());
                         }
-                        DeleteError::IOError(_) => {
+                        DeleteError::IOError { .. } => {
                             failed_to_delete_files.push(file_to_delete.clone());
                             if !cfg!(target_os = "windows") {
                                 // On windows, delete is expected to fail if the file
@@ -213,7 +212,7 @@ impl ManagedDirectory {
     /// File starting by "." are reserved to locks.
     /// They are not managed and cannot be subjected
     /// to garbage collection.
-    fn register_file_as_managed(&mut self, filepath: &Path) -> io::Result<()> {
+    fn register_file_as_managed(&self, filepath: &Path) -> io::Result<()> {
         // Files starting by "." (e.g. lock files) are not managed.
         if !is_managed(filepath) {
             return Ok(());
@@ -224,7 +223,7 @@ impl ManagedDirectory {
             .expect("Managed file lock poisoned");
         let has_changed = meta_wlock.managed_paths.insert(filepath.to_owned());
         if has_changed {
-            save_managed_paths(self.directory.as_mut(), &meta_wlock)?;
+            save_managed_paths(self.directory.as_ref(), &meta_wlock)?;
         }
         Ok(())
     }
@@ -232,10 +231,19 @@ impl ManagedDirectory {
     /// Verify checksum of a managed file
     pub fn validate_checksum(&self, path: &Path) -> result::Result<bool, OpenReadError> {
         let reader = self.directory.open_read(path)?;
-        let (footer, data) = Footer::extract_footer(reader)
-            .map_err(|err| IOError::with_path(path.to_path_buf(), err))?;
+        let (footer, data) =
+            Footer::extract_footer(reader).map_err(|io_error| OpenReadError::IOError {
+                io_error,
+                filepath: path.to_path_buf(),
+            })?;
+        let bytes = data
+            .read_bytes()
+            .map_err(|io_error| OpenReadError::IOError {
+                filepath: path.to_path_buf(),
+                io_error,
+            })?;
         let mut hasher = Hasher::new();
-        hasher.update(data.as_slice());
+        hasher.update(bytes.as_slice());
         let crc = hasher.finalize();
         Ok(footer
             .versioned_footer
@@ -246,35 +254,42 @@ impl ManagedDirectory {
 
     /// List files for which checksum does not match content
     pub fn list_damaged(&self) -> result::Result<HashSet<PathBuf>, OpenReadError> {
-        let mut hashset = HashSet::new();
-        let managed_paths = self
+        let mut managed_paths = self
             .meta_informations
             .read()
             .expect("Managed directory rlock poisoned in list damaged.")
             .managed_paths
             .clone();
 
-        for path in managed_paths.into_iter() {
+        managed_paths.remove(*META_FILEPATH);
+
+        let mut damaged_files = HashSet::new();
+        for path in managed_paths {
             if !self.validate_checksum(&path)? {
-                hashset.insert(path);
+                damaged_files.insert(path);
             }
         }
-        Ok(hashset)
+        Ok(damaged_files)
     }
 }
 
 impl Directory for ManagedDirectory {
-    fn open_read(&self, path: &Path) -> result::Result<ReadOnlySource, OpenReadError> {
-        let read_only_source = self.directory.open_read(path)?;
-        let (footer, reader) = Footer::extract_footer(read_only_source)
-            .map_err(|err| IOError::with_path(path.to_path_buf(), err))?;
+    fn get_file_handle(&self, path: &Path) -> Result<Box<dyn FileHandle>, OpenReadError> {
+        let file_slice = self.open_read(path)?;
+        Ok(Box::new(file_slice))
+    }
+
+    fn open_read(&self, path: &Path) -> result::Result<FileSlice, OpenReadError> {
+        let file_slice = self.directory.open_read(path)?;
+        let (footer, reader) = Footer::extract_footer(file_slice)
+            .map_err(|io_error| OpenReadError::wrap_io_error(io_error, path.to_path_buf()))?;
         footer.is_compatible()?;
         Ok(reader)
     }
 
-    fn open_write(&mut self, path: &Path) -> result::Result<WritePtr, OpenWriteError> {
+    fn open_write(&self, path: &Path) -> result::Result<WritePtr, OpenWriteError> {
         self.register_file_as_managed(path)
-            .map_err(|e| IOError::with_path(path.to_owned(), e))?;
+            .map_err(|io_error| OpenWriteError::wrap_io_error(io_error, path.to_path_buf()))?;
         Ok(io::BufWriter::new(Box::new(FooterProxy::new(
             self.directory
                 .open_write(path)?
@@ -284,7 +299,7 @@ impl Directory for ManagedDirectory {
         ))))
     }
 
-    fn atomic_write(&mut self, path: &Path, data: &[u8]) -> io::Result<()> {
+    fn atomic_write(&self, path: &Path, data: &[u8]) -> io::Result<()> {
         self.register_file_as_managed(path)?;
         self.directory.atomic_write(path, data)
     }
@@ -297,7 +312,7 @@ impl Directory for ManagedDirectory {
         self.directory.delete(path)
     }
 
-    fn exists(&self, path: &Path) -> bool {
+    fn exists(&self, path: &Path) -> Result<bool, OpenReadError> {
         self.directory.exists(path)
     }
 
@@ -345,22 +360,22 @@ mod tests_mmap_specific {
             managed_directory
                 .atomic_write(test_path2, &[0u8, 1u8])
                 .unwrap();
-            assert!(managed_directory.exists(test_path1));
-            assert!(managed_directory.exists(test_path2));
+            assert!(managed_directory.exists(test_path1).unwrap());
+            assert!(managed_directory.exists(test_path2).unwrap());
             let living_files: HashSet<PathBuf> = [test_path1.to_owned()].iter().cloned().collect();
             assert!(managed_directory.garbage_collect(|| living_files).is_ok());
-            assert!(managed_directory.exists(test_path1));
-            assert!(!managed_directory.exists(test_path2));
+            assert!(managed_directory.exists(test_path1).unwrap());
+            assert!(!managed_directory.exists(test_path2).unwrap());
         }
         {
             let mmap_directory = MmapDirectory::open(&tempdir_path).unwrap();
             let mut managed_directory = ManagedDirectory::wrap(mmap_directory).unwrap();
-            assert!(managed_directory.exists(test_path1));
-            assert!(!managed_directory.exists(test_path2));
+            assert!(managed_directory.exists(test_path1).unwrap());
+            assert!(!managed_directory.exists(test_path2).unwrap());
             let living_files: HashSet<PathBuf> = HashSet::new();
             assert!(managed_directory.garbage_collect(|| living_files).is_ok());
-            assert!(!managed_directory.exists(test_path1));
-            assert!(!managed_directory.exists(test_path2));
+            assert!(!managed_directory.exists(test_path1).unwrap());
+            assert!(!managed_directory.exists(test_path2).unwrap());
         }
     }
 
@@ -377,7 +392,7 @@ mod tests_mmap_specific {
         let mut write = managed_directory.open_write(test_path1).unwrap();
         write.write_all(&[0u8, 1u8]).unwrap();
         write.terminate().unwrap();
-        assert!(managed_directory.exists(test_path1));
+        assert!(managed_directory.exists(test_path1).unwrap());
 
         let _mmap_read = managed_directory.open_read(test_path1).unwrap();
         assert!(managed_directory
@@ -385,52 +400,50 @@ mod tests_mmap_specific {
             .is_ok());
         if cfg!(target_os = "windows") {
             // On Windows, gc should try and fail the file as it is mmapped.
-            assert!(managed_directory.exists(test_path1));
+            assert!(managed_directory.exists(test_path1).unwrap());
             // unmap should happen here.
             drop(_mmap_read);
             // The file should still be in the list of managed file and
             // eventually be deleted once mmap is released.
             assert!(managed_directory.garbage_collect(|| living_files).is_ok());
-            assert!(!managed_directory.exists(test_path1));
+            assert!(!managed_directory.exists(test_path1).unwrap());
         } else {
-            assert!(!managed_directory.exists(test_path1));
+            assert!(!managed_directory.exists(test_path1).unwrap());
         }
     }
 
     #[test]
-    fn test_checksum() {
+    fn test_checksum() -> crate::Result<()> {
         let test_path1: &'static Path = Path::new("some_path_for_test");
         let test_path2: &'static Path = Path::new("other_test_path");
 
         let tempdir = TempDir::new().unwrap();
         let tempdir_path = PathBuf::from(tempdir.path());
 
-        let mmap_directory = MmapDirectory::open(&tempdir_path).unwrap();
-        let mut managed_directory = ManagedDirectory::wrap(mmap_directory).unwrap();
-        let mut write = managed_directory.open_write(test_path1).unwrap();
-        write.write_all(&[0u8, 1u8]).unwrap();
-        write.terminate().unwrap();
+        let mmap_directory = MmapDirectory::open(&tempdir_path)?;
+        let managed_directory = ManagedDirectory::wrap(mmap_directory)?;
+        let mut write = managed_directory.open_write(test_path1)?;
+        write.write_all(&[0u8, 1u8])?;
+        write.terminate()?;
 
-        let mut write = managed_directory.open_write(test_path2).unwrap();
-        write.write_all(&[3u8, 4u8, 5u8]).unwrap();
-        write.terminate().unwrap();
+        let mut write = managed_directory.open_write(test_path2)?;
+        write.write_all(&[3u8, 4u8, 5u8])?;
+        write.terminate()?;
 
-        let read_source = managed_directory.open_read(test_path2).unwrap();
-        assert_eq!(read_source.as_slice(), &[3u8, 4u8, 5u8]);
+        let read_file = managed_directory.open_read(test_path2)?.read_bytes()?;
+        assert_eq!(read_file.as_slice(), &[3u8, 4u8, 5u8]);
         assert!(managed_directory.list_damaged().unwrap().is_empty());
 
         let mut corrupted_path = tempdir_path.clone();
         corrupted_path.push(test_path2);
-        let mut file = OpenOptions::new()
-            .write(true)
-            .open(&corrupted_path)
-            .unwrap();
-        file.write_all(&[255u8]).unwrap();
-        file.flush().unwrap();
+        let mut file = OpenOptions::new().write(true).open(&corrupted_path)?;
+        file.write_all(&[255u8])?;
+        file.flush()?;
         drop(file);
 
-        let damaged = managed_directory.list_damaged().unwrap();
+        let damaged = managed_directory.list_damaged()?;
         assert_eq!(damaged.len(), 1);
         assert!(damaged.contains(test_path2));
+        Ok(())
     }
 }

src/directory/mmap_directory.rs

@@ -1,29 +1,19 @@
-use fs2;
-use notify;
-
-use self::fs2::FileExt;
-use self::notify::RawEvent;
-use self::notify::RecursiveMode;
-use self::notify::Watcher;
 use crate::core::META_FILEPATH;
 use crate::directory::error::LockError;
-use crate::directory::error::{
-    DeleteError, IOError, OpenDirectoryError, OpenReadError, OpenWriteError,
-};
-use crate::directory::read_only_source::BoxedData;
-use crate::directory::AntiCallToken;
+use crate::directory::error::{DeleteError, OpenDirectoryError, OpenReadError, OpenWriteError};
+use crate::directory::file_watcher::FileWatcher;
 use crate::directory::Directory;
 use crate::directory::DirectoryLock;
 use crate::directory::Lock;
-use crate::directory::ReadOnlySource;
 use crate::directory::WatchCallback;
-use crate::directory::WatchCallbackList;
 use crate::directory::WatchHandle;
+use crate::directory::{AntiCallToken, FileHandle, OwnedBytes};
+use crate::directory::{ArcBytes, WeakArcBytes};
 use crate::directory::{TerminatingWrite, WritePtr};
-use atomicwrites;
+use fs2::FileExt;
 use memmap::Mmap;
 use serde::{Deserialize, Serialize};
-use std::collections::HashMap;
+use stable_deref_trait::StableDeref;
 use std::convert::From;
 use std::fmt;
 use std::fs::OpenOptions;
@@ -32,12 +22,9 @@ use std::io::{self, Seek, SeekFrom};
 use std::io::{BufWriter, Read, Write};
 use std::path::{Path, PathBuf};
 use std::result;
-use std::sync::mpsc::{channel, Receiver, Sender};
 use std::sync::Arc;
-use std::sync::Mutex;
 use std::sync::RwLock;
-use std::sync::Weak;
-use std::thread;
+use std::{collections::HashMap, ops::Deref};
 use tempfile::TempDir;
 
 /// Create a default io error given a string.
@@ -48,17 +35,17 @@ pub(crate) fn make_io_err(msg: String) -> io::Error {
 /// Returns None iff the file exists, can be read, but is empty (and hence
 /// cannot be mmapped)
 fn open_mmap(full_path: &Path) -> result::Result<Option<Mmap>, OpenReadError> {
-    let file = File::open(full_path).map_err(|e| {
-        if e.kind() == io::ErrorKind::NotFound {
-            OpenReadError::FileDoesNotExist(full_path.to_owned())
+    let file = File::open(full_path).map_err(|io_err| {
+        if io_err.kind() == io::ErrorKind::NotFound {
+            OpenReadError::FileDoesNotExist(full_path.to_path_buf())
         } else {
-            OpenReadError::IOError(IOError::with_path(full_path.to_owned(), e))
+            OpenReadError::wrap_io_error(io_err, full_path.to_path_buf())
         }
     })?;
 
     let meta_data = file
         .metadata()
-        .map_err(|e| IOError::with_path(full_path.to_owned(), e))?;
+        .map_err(|io_err| OpenReadError::wrap_io_error(io_err, full_path.to_owned()))?;
     if meta_data.len() == 0 {
         // if the file size is 0, it will not be possible
         // to mmap the file, so we return None
@@ -68,7 +55,7 @@ fn open_mmap(full_path: &Path) -> result::Result<Option<Mmap>, OpenReadError> {
     unsafe {
         memmap::Mmap::map(&file)
             .map(Some)
-            .map_err(|e| From::from(IOError::with_path(full_path.to_owned(), e)))
+            .map_err(|io_err| OpenReadError::wrap_io_error(io_err, full_path.to_path_buf()))
     }
 }
 
@@ -89,7 +76,7 @@ pub struct CacheInfo {
 
 struct MmapCache {
     counters: CacheCounters,
-    cache: HashMap<PathBuf, Weak<BoxedData>>,
+    cache: HashMap<PathBuf, WeakArcBytes>,
 }
 
 impl Default for MmapCache {
@@ -123,7 +110,7 @@ impl MmapCache {
     }
 
     // Returns None if the file exists but as a len of 0 (and hence is not mmappable).
-    fn get_mmap(&mut self, full_path: &Path) -> Result<Option<Arc<BoxedData>>, OpenReadError> {
+    fn get_mmap(&mut self, full_path: &Path) -> Result<Option<ArcBytes>, OpenReadError> {
         if let Some(mmap_weak) = self.cache.get(full_path) {
             if let Some(mmap_arc) = mmap_weak.upgrade() {
                 self.counters.hit += 1;
@@ -134,7 +121,7 @@ impl MmapCache {
         self.counters.miss += 1;
         let mmap_opt = open_mmap(full_path)?;
         Ok(mmap_opt.map(|mmap| {
-            let mmap_arc: Arc<BoxedData> = Arc::new(Box::new(mmap));
+            let mmap_arc: ArcBytes = Arc::new(mmap);
             let mmap_weak = Arc::downgrade(&mmap_arc);
             self.cache.insert(full_path.to_owned(), mmap_weak);
             mmap_arc
@@ -142,63 +129,6 @@ impl MmapCache {
     }
 }
 
-struct WatcherWrapper {
-    _watcher: Mutex<notify::RecommendedWatcher>,
-    watcher_router: Arc<WatchCallbackList>,
-}
-
-impl WatcherWrapper {
-    pub fn new(path: &Path) -> Result<Self, OpenDirectoryError> {
-        let (tx, watcher_recv): (Sender<RawEvent>, Receiver<RawEvent>) = channel();
-        // We need to initialize the
-        let watcher = notify::raw_watcher(tx)
-            .and_then(|mut watcher| {
-                watcher.watch(path, RecursiveMode::Recursive)?;
-                Ok(watcher)
-            })
-            .map_err(|err| match err {
-                notify::Error::PathNotFound => OpenDirectoryError::DoesNotExist(path.to_owned()),
-                _ => {
-                    panic!("Unknown error while starting watching directory {:?}", path);
-                }
-            })?;
-        let watcher_router: Arc<WatchCallbackList> = Default::default();
-        let watcher_router_clone = watcher_router.clone();
-        thread::Builder::new()
-            .name("meta-file-watch-thread".to_string())
-            .spawn(move || {
-                loop {
-                    match watcher_recv.recv().map(|evt| evt.path) {
-                        Ok(Some(changed_path)) => {
-                            // ... Actually subject to false positive.
-                            // We might want to be more accurate than this at one point.
-                            if let Some(filename) = changed_path.file_name() {
-                                if filename == *META_FILEPATH {
-                                    let _ = watcher_router_clone.broadcast();
-                                }
-                            }
-                        }
-                        Ok(None) => {
-                            // not an event we are interested in.
-                        }
-                        Err(_e) => {
-                            // the watch send channel was dropped
-                            break;
-                        }
-                    }
-                }
-            })?;
-        Ok(WatcherWrapper {
-            _watcher: Mutex::new(watcher),
-            watcher_router,
-        })
-    }
-
-    pub fn watch(&mut self, watch_callback: WatchCallback) -> WatchHandle {
-        self.watcher_router.subscribe(watch_callback)
-    }
-}
-
 /// Directory storing data in files, read via mmap.
 ///
 /// The Mmap object are cached to limit the
@@ -220,44 +150,21 @@ struct MmapDirectoryInner {
     root_path: PathBuf,
     mmap_cache: RwLock<MmapCache>,
     _temp_directory: Option<TempDir>,
-    watcher: RwLock<Option<WatcherWrapper>>,
+    watcher: FileWatcher,
 }
 
 impl MmapDirectoryInner {
-    fn new(
-        root_path: PathBuf,
-        temp_directory: Option<TempDir>,
-    ) -> Result<MmapDirectoryInner, OpenDirectoryError> {
-        let mmap_directory_inner = MmapDirectoryInner {
-            root_path,
+    fn new(root_path: PathBuf, temp_directory: Option<TempDir>) -> MmapDirectoryInner {
+        MmapDirectoryInner {
             mmap_cache: Default::default(),
             _temp_directory: temp_directory,
-            watcher: RwLock::new(None),
-        };
-        Ok(mmap_directory_inner)
+            watcher: FileWatcher::new(&root_path.join(*META_FILEPATH)),
+            root_path,
+        }
     }
 
-    fn watch(&self, watch_callback: WatchCallback) -> crate::Result<WatchHandle> {
-        // a lot of juggling here, to ensure we don't do anything that panics
-        // while the rwlock is held. That way we ensure that the rwlock cannot
-        // be poisoned.
-        //
-        // The downside is that we might create a watch wrapper that is not useful.
-        let need_initialization = self.watcher.read().unwrap().is_none();
-        if need_initialization {
-            let watch_wrapper = WatcherWrapper::new(&self.root_path)?;
-            let mut watch_wlock = self.watcher.write().unwrap();
-            // the watcher could have been initialized when we released the lock, and
-            // we do not want to lose the watched files that were set.
-            if watch_wlock.is_none() {
-                *watch_wlock = Some(watch_wrapper);
-            }
-        }
-        if let Some(watch_wrapper) = self.watcher.write().unwrap().as_mut() {
-            Ok(watch_wrapper.watch(watch_callback))
-        } else {
-            unreachable!("At this point, watch wrapper is supposed to be initialized");
-        }
+    fn watch(&self, callback: WatchCallback) -> WatchHandle {
+        self.watcher.watch(callback)
     }
 }
 
@@ -268,14 +175,11 @@ impl fmt::Debug for MmapDirectory {
 }
 
 impl MmapDirectory {
-    fn new(
-        root_path: PathBuf,
-        temp_directory: Option<TempDir>,
-    ) -> Result<MmapDirectory, OpenDirectoryError> {
-        let inner = MmapDirectoryInner::new(root_path, temp_directory)?;
-        Ok(MmapDirectory {
+    fn new(root_path: PathBuf, temp_directory: Option<TempDir>) -> MmapDirectory {
+        let inner = MmapDirectoryInner::new(root_path, temp_directory);
+        MmapDirectory {
             inner: Arc::new(inner),
-        })
+        }
     }
 
     /// Creates a new MmapDirectory in a temporary directory.
@@ -283,9 +187,11 @@ impl MmapDirectory {
     /// This is mostly useful to test the MmapDirectory itself.
     /// For your unit tests, prefer the RAMDirectory.
     pub fn create_from_tempdir() -> Result<MmapDirectory, OpenDirectoryError> {
-        let tempdir = TempDir::new().map_err(OpenDirectoryError::IoError)?;
-        let tempdir_path = PathBuf::from(tempdir.path());
-        MmapDirectory::new(tempdir_path, Some(tempdir))
+        let tempdir = TempDir::new().map_err(OpenDirectoryError::FailedToCreateTempDir)?;
+        Ok(MmapDirectory::new(
+            tempdir.path().to_path_buf(),
+            Some(tempdir),
+        ))
     }
 
     /// Opens a MmapDirectory in a directory.
@@ -303,7 +209,7 @@ impl MmapDirectory {
                 directory_path,
             )))
         } else {
-            Ok(MmapDirectory::new(PathBuf::from(directory_path), None)?)
+            Ok(MmapDirectory::new(PathBuf::from(directory_path), None))
         }
     }
 
@@ -407,8 +313,38 @@ impl TerminatingWrite for SafeFileWriter {
     }
 }
 
+#[derive(Clone)]
+struct MmapArc(Arc<dyn Deref<Target = [u8]> + Send + Sync>);
+
+impl Deref for MmapArc {
+    type Target = [u8];
+
+    fn deref(&self) -> &[u8] {
+        self.0.deref()
+    }
+}
+unsafe impl StableDeref for MmapArc {}
+
+/// Writes a file in an atomic manner.
+pub(crate) fn atomic_write(path: &Path, content: &[u8]) -> io::Result<()> {
+    // We create the temporary file in the same directory as the target file.
+    // Indeed the canonical temp directory and the target file might sit in different
+    // filesystem, in which case the atomic write may actually not work.
+    let parent_path = path.parent().ok_or_else(|| {
+        io::Error::new(
+            io::ErrorKind::InvalidInput,
+            "Path {:?} does not have parent directory.",
+        )
+    })?;
+    let mut tempfile = tempfile::Builder::new().tempfile_in(&parent_path)?;
+    tempfile.write_all(content)?;
+    tempfile.flush()?;
+    tempfile.into_temp_path().persist(path)?;
+    Ok(())
+}
+
 impl Directory for MmapDirectory {
-    fn open_read(&self, path: &Path) -> result::Result<ReadOnlySource, OpenReadError> {
+    fn get_file_handle(&self, path: &Path) -> result::Result<Box<dyn FileHandle>, OpenReadError> {
         debug!("Open Read {:?}", path);
         let full_path = self.resolve_path(path);
 
@@ -418,12 +354,19 @@ impl Directory for MmapDirectory {
                  on mmap cache while reading {:?}",
                 path
             );
-            IOError::with_path(path.to_owned(), make_io_err(msg))
+            let io_err = make_io_err(msg);
+            OpenReadError::wrap_io_error(io_err, path.to_path_buf())
         })?;
-        Ok(mmap_cache
+
+        let owned_bytes = mmap_cache
             .get_mmap(&full_path)?
-            .map(ReadOnlySource::from)
-            .unwrap_or_else(ReadOnlySource::empty))
+            .map(|mmap_arc| {
+                let mmap_arc_obj = MmapArc(mmap_arc);
+                OwnedBytes::new(mmap_arc_obj)
+            })
+            .unwrap_or_else(OwnedBytes::empty);
+
+        Ok(Box::new(owned_bytes))
     }
 
     /// Any entry associated to the path in the mmap will be
@@ -431,25 +374,29 @@ impl Directory for MmapDirectory {
     fn delete(&self, path: &Path) -> result::Result<(), DeleteError> {
         let full_path = self.resolve_path(path);
         match fs::remove_file(&full_path) {
-            Ok(_) => self
-                .sync_directory()
-                .map_err(|e| IOError::with_path(path.to_owned(), e).into()),
+            Ok(_) => self.sync_directory().map_err(|e| DeleteError::IOError {
+                io_error: e,
+                filepath: path.to_path_buf(),
+            }),
             Err(e) => {
                 if e.kind() == io::ErrorKind::NotFound {
                     Err(DeleteError::FileDoesNotExist(path.to_owned()))
                 } else {
-                    Err(IOError::with_path(path.to_owned(), e).into())
+                    Err(DeleteError::IOError {
+                        io_error: e,
+                        filepath: path.to_path_buf(),
+                    })
                 }
             }
         }
     }
 
-    fn exists(&self, path: &Path) -> bool {
+    fn exists(&self, path: &Path) -> Result<bool, OpenReadError> {
         let full_path = self.resolve_path(path);
-        full_path.exists()
+        Ok(full_path.exists())
     }
 
-    fn open_write(&mut self, path: &Path) -> Result<WritePtr, OpenWriteError> {
+    fn open_write(&self, path: &Path) -> Result<WritePtr, OpenWriteError> {
         debug!("Open Write {:?}", path);
         let full_path = self.resolve_path(path);
 
@@ -458,22 +405,22 @@ impl Directory for MmapDirectory {
             .create_new(true)
             .open(full_path);
 
-        let mut file = open_res.map_err(|err| {
-            if err.kind() == io::ErrorKind::AlreadyExists {
-                OpenWriteError::FileAlreadyExists(path.to_owned())
+        let mut file = open_res.map_err(|io_err| {
+            if io_err.kind() == io::ErrorKind::AlreadyExists {
+                OpenWriteError::FileAlreadyExists(path.to_path_buf())
             } else {
-                IOError::with_path(path.to_owned(), err).into()
+                OpenWriteError::wrap_io_error(io_err, path.to_path_buf())
             }
         })?;
 
         // making sure the file is created.
         file.flush()
-            .map_err(|e| IOError::with_path(path.to_owned(), e))?;
+            .map_err(|io_error| OpenWriteError::wrap_io_error(io_error, path.to_path_buf()))?;
 
         // Apparetntly, on some filesystem syncing the parent
         // directory is required.
         self.sync_directory()
-            .map_err(|e| IOError::with_path(path.to_owned(), e))?;
+            .map_err(|io_err| OpenWriteError::wrap_io_error(io_err, path.to_path_buf()))?;
 
         let writer = SafeFileWriter::new(file);
         Ok(BufWriter::new(Box::new(writer)))
@@ -484,26 +431,26 @@ impl Directory for MmapDirectory {
         let mut buffer = Vec::new();
         match File::open(&full_path) {
             Ok(mut file) => {
-                file.read_to_end(&mut buffer)
-                    .map_err(|e| IOError::with_path(path.to_owned(), e))?;
+                file.read_to_end(&mut buffer).map_err(|io_error| {
+                    OpenReadError::wrap_io_error(io_error, path.to_path_buf())
+                })?;
                 Ok(buffer)
             }
-            Err(e) => {
-                if e.kind() == io::ErrorKind::NotFound {
+            Err(io_error) => {
+                if io_error.kind() == io::ErrorKind::NotFound {
                     Err(OpenReadError::FileDoesNotExist(path.to_owned()))
                 } else {
-                    Err(IOError::with_path(path.to_owned(), e).into())
+                    Err(OpenReadError::wrap_io_error(io_error, path.to_path_buf()))
                 }
             }
         }
     }
 
-    fn atomic_write(&mut self, path: &Path, data: &[u8]) -> io::Result<()> {
+    fn atomic_write(&self, path: &Path, content: &[u8]) -> io::Result<()> {
         debug!("Atomic Write {:?}", path);
         let full_path = self.resolve_path(path);
-        let meta_file = atomicwrites::AtomicFile::new(full_path, atomicwrites::AllowOverwrite);
-        meta_file.write(|f| f.write_all(data))?;
-        Ok(())
+        atomic_write(&full_path, content)?;
+        self.sync_directory()
     }
 
     fn acquire_lock(&self, lock: &Lock) -> Result<DirectoryLock, LockError> {
@@ -527,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))
     }
 }
 
@@ -538,12 +485,10 @@ mod tests {
     // The following tests are specific to the MmapDirectory
 
     use super::*;
-    use crate::indexer::LogMergePolicy;
     use crate::schema::{Schema, SchemaBuilder, TEXT};
     use crate::Index;
     use crate::ReloadPolicy;
-    use std::fs;
-    use std::sync::atomic::{AtomicUsize, Ordering};
+    use crate::{common::HasLen, indexer::LogMergePolicy};
 
     #[test]
     fn test_open_non_existent_path() {
@@ -556,7 +501,7 @@ mod tests {
         // cannot be mmapped.
         //
         // In that case the directory returns a SharedVecSlice.
-        let mut mmap_directory = MmapDirectory::create_from_tempdir().unwrap();
+        let mmap_directory = MmapDirectory::create_from_tempdir().unwrap();
         let path = PathBuf::from("test");
         {
             let mut w = mmap_directory.open_write(&path).unwrap();
@@ -572,7 +517,7 @@ mod tests {
 
         // here we test if the cache releases
         // mmaps correctly.
-        let mut mmap_directory = MmapDirectory::create_from_tempdir().unwrap();
+        let mmap_directory = MmapDirectory::create_from_tempdir().unwrap();
         let num_paths = 10;
         let paths: Vec<PathBuf> = (0..num_paths)
             .map(|i| PathBuf::from(&*format!("file_{}", i)))
@@ -632,27 +577,6 @@ mod tests {
         assert_eq!(mmap_directory.get_cache_info().mmapped.len(), 0);
     }
 
-    #[test]
-    fn test_watch_wrapper() {
-        let counter: Arc<AtomicUsize> = Default::default();
-        let counter_clone = counter.clone();
-        let tmp_dir = tempfile::TempDir::new().unwrap();
-        let tmp_dirpath = tmp_dir.path().to_owned();
-        let mut watch_wrapper = WatcherWrapper::new(&tmp_dirpath).unwrap();
-        let tmp_file = tmp_dirpath.join(*META_FILEPATH);
-        let _handle = watch_wrapper.watch(Box::new(move || {
-            counter_clone.fetch_add(1, Ordering::SeqCst);
-        }));
-        let (sender, receiver) = crossbeam::channel::unbounded();
-        let _handle2 = watch_wrapper.watch(Box::new(move || {
-            let _ = sender.send(());
-        }));
-        assert_eq!(counter.load(Ordering::SeqCst), 0);
-        fs::write(&tmp_file, b"whateverwilldo").unwrap();
-        assert!(receiver.recv().is_ok());
-        assert!(counter.load(Ordering::SeqCst) >= 1);
-    }
-
     #[test]
     fn test_mmap_released() {
         let mmap_directory = MmapDirectory::create_from_tempdir().unwrap();
@@ -663,7 +587,7 @@ mod tests {
         {
             let index = Index::create(mmap_directory.clone(), schema).unwrap();
 
-            let mut index_writer = index.writer_with_num_threads(1, 3_000_000).unwrap();
+            let mut index_writer = index.writer_for_tests().unwrap();
             let mut log_merge_policy = LogMergePolicy::default();
             log_merge_policy.set_min_merge_size(3);
             index_writer.set_merge_policy(Box::new(log_merge_policy));

src/directory/mod.rs

@@ -9,14 +9,13 @@ mod mmap_directory;
 
 mod directory;
 mod directory_lock;
+mod file_slice;
+mod file_watcher;
 mod footer;
 mod managed_directory;
+mod owned_bytes;
 mod ram_directory;
-mod read_only_source;
-mod spilling_writer;
 mod watch_event_router;
-mod persistor;
-
 
 /// Errors specific to the directory module.
 pub mod error;
@@ -24,12 +23,14 @@ pub mod error;
 pub use self::directory::DirectoryLock;
 pub use self::directory::{Directory, DirectoryClone};
 pub use self::directory_lock::{Lock, INDEX_WRITER_LOCK, META_LOCK};
+pub(crate) use self::file_slice::{ArcBytes, WeakArcBytes};
+pub use self::file_slice::{FileHandle, FileSlice};
+pub use self::owned_bytes::OwnedBytes;
 pub use self::ram_directory::RAMDirectory;
-pub use self::read_only_source::ReadOnlySource;
-pub(crate) use self::spilling_writer::{SpillingResult, SpillingWriter};
 pub use self::watch_event_router::{WatchCallback, WatchCallbackList, WatchHandle};
 use std::io::{self, BufWriter, Write};
 use std::path::PathBuf;
+
 /// Outcome of the Garbage collection
 pub struct GarbageCollectionResult {
     /// List of files that were deleted in this cycle
@@ -83,16 +84,10 @@ impl<W: TerminatingWrite> TerminatingWrite for BufWriter<W> {
     }
 }
 
-impl TerminatingWrite for Vec<u8> {
-    fn terminate_ref(&mut self, _a: AntiCallToken) -> io::Result<()> {
-        Ok(())
-    }
-}
-
 #[cfg(test)]
 impl<'a> TerminatingWrite for &'a mut Vec<u8> {
     fn terminate_ref(&mut self, _a: AntiCallToken) -> io::Result<()> {
-        Ok(())
+        self.flush()
     }
 }
 

src/directory/owned_bytes.rs

@@ -0,0 +1,290 @@
+use crate::directory::FileHandle;
+use stable_deref_trait::StableDeref;
+use std::convert::TryInto;
+use std::mem;
+use std::ops::{Deref, Range};
+use std::sync::Arc;
+use std::{fmt, io};
+
+/// An OwnedBytes simply wraps an object that owns a slice of data and exposes
+/// this data as a static slice.
+///
+/// The backing object is required to be `StableDeref`.
+#[derive(Clone)]
+pub struct OwnedBytes {
+    data: &'static [u8],
+    box_stable_deref: Arc<dyn Deref<Target = [u8]> + Sync + Send>,
+}
+
+impl FileHandle for OwnedBytes {
+    fn read_bytes(&self, range: Range<usize>) -> io::Result<OwnedBytes> {
+        Ok(self.slice(range))
+    }
+}
+
+impl OwnedBytes {
+    /// Creates an empty `OwnedBytes`.
+    pub fn empty() -> OwnedBytes {
+        OwnedBytes::new(&[][..])
+    }
+
+    /// Creates an `OwnedBytes` intance given a `StableDeref` object.
+    pub fn new<T: StableDeref + Deref<Target = [u8]> + 'static + Send + Sync>(
+        data_holder: T,
+    ) -> OwnedBytes {
+        let box_stable_deref = Arc::new(data_holder);
+        let bytes: &[u8] = box_stable_deref.as_ref();
+        let data = unsafe { mem::transmute::<_, &'static [u8]>(bytes.deref()) };
+        OwnedBytes {
+            box_stable_deref,
+            data,
+        }
+    }
+
+    /// creates a fileslice that is just a view over a slice of the data.
+    pub fn slice(&self, range: Range<usize>) -> Self {
+        OwnedBytes {
+            data: &self.data[range],
+            box_stable_deref: self.box_stable_deref.clone(),
+        }
+    }
+
+    /// Returns the underlying slice of data.
+    /// `Deref` and `AsRef` are also available.
+    #[inline(always)]
+    pub fn as_slice(&self) -> &[u8] {
+        self.data
+    }
+
+    /// Returns the len of the slice.
+    #[inline(always)]
+    pub fn len(&self) -> usize {
+        self.data.len()
+    }
+
+    /// Splits the OwnedBytes into two OwnedBytes `(left, right)`.
+    ///
+    /// Left will hold `split_len` bytes.
+    ///
+    /// This operation is cheap and does not require to copy any memory.
+    /// On the other hand, both `left` and `right` retain a handle over
+    /// the entire slice of memory. In other words, the memory will only
+    /// be released when both left and right are dropped.
+    pub fn split(self, split_len: usize) -> (OwnedBytes, OwnedBytes) {
+        let right_box_stable_deref = self.box_stable_deref.clone();
+        let left = OwnedBytes {
+            data: &self.data[..split_len],
+            box_stable_deref: self.box_stable_deref,
+        };
+        let right = OwnedBytes {
+            data: &self.data[split_len..],
+            box_stable_deref: right_box_stable_deref,
+        };
+        (left, right)
+    }
+
+    /// Returns true iff this `OwnedBytes` is empty.
+    #[inline(always)]
+    pub fn is_empty(&self) -> bool {
+        self.as_slice().is_empty()
+    }
+
+    /// Drops the left most `advance_len` bytes.
+    ///
+    /// See also [.clip(clip_len: usize))](#method.clip).
+    #[inline(always)]
+    pub fn advance(&mut self, advance_len: usize) {
+        self.data = &self.data[advance_len..]
+    }
+
+    /// Reads an `u8` from the `OwnedBytes` and advance by one byte.
+    pub fn read_u8(&mut self) -> u8 {
+        assert!(!self.is_empty());
+
+        let byte = self.as_slice()[0];
+        self.advance(1);
+        byte
+    }
+
+    /// Reads an `u64` encoded as little-endian from the `OwnedBytes` and advance by 8 bytes.
+    pub fn read_u64(&mut self) -> u64 {
+        assert!(self.len() > 7);
+
+        let octlet: [u8; 8] = self.as_slice()[..8].try_into().unwrap();
+        self.advance(8);
+        u64::from_le_bytes(octlet)
+    }
+}
+
+impl fmt::Debug for OwnedBytes {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        // We truncate the bytes in order to make sure the debug string
+        // is not too long.
+        let bytes_truncated: &[u8] = if self.len() > 8 {
+            &self.as_slice()[..10]
+        } else {
+            self.as_slice()
+        };
+        write!(f, "OwnedBytes({:?}, len={})", bytes_truncated, self.len())
+    }
+}
+
+impl Deref for OwnedBytes {
+    type Target = [u8];
+
+    fn deref(&self) -> &Self::Target {
+        self.as_slice()
+    }
+}
+
+impl io::Read for OwnedBytes {
+    fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
+        let read_len = {
+            let data = self.as_slice();
+            if data.len() >= buf.len() {
+                let buf_len = buf.len();
+                buf.copy_from_slice(&data[..buf_len]);
+                buf.len()
+            } else {
+                let data_len = data.len();
+                buf[..data_len].copy_from_slice(data);
+                data_len
+            }
+        };
+        self.advance(read_len);
+        Ok(read_len)
+    }
+    fn read_to_end(&mut self, buf: &mut Vec<u8>) -> io::Result<usize> {
+        let read_len = {
+            let data = self.as_slice();
+            buf.extend(data);
+            data.len()
+        };
+        self.advance(read_len);
+        Ok(read_len)
+    }
+    fn read_exact(&mut self, buf: &mut [u8]) -> io::Result<()> {
+        let read_len = self.read(buf)?;
+        if read_len != buf.len() {
+            return Err(io::Error::new(
+                io::ErrorKind::UnexpectedEof,
+                "failed to fill whole buffer",
+            ));
+        }
+        Ok(())
+    }
+}
+
+impl AsRef<[u8]> for OwnedBytes {
+    fn as_ref(&self) -> &[u8] {
+        self.as_slice()
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use std::io::{self, Read};
+
+    use super::OwnedBytes;
+
+    #[test]
+    fn test_owned_bytes_debug() {
+        let short_bytes = OwnedBytes::new(b"abcd".as_ref());
+        assert_eq!(
+            format!("{:?}", short_bytes),
+            "OwnedBytes([97, 98, 99, 100], len=4)"
+        );
+        let long_bytes = OwnedBytes::new(b"abcdefghijklmnopq".as_ref());
+        assert_eq!(
+            format!("{:?}", long_bytes),
+            "OwnedBytes([97, 98, 99, 100, 101, 102, 103, 104, 105, 106], len=17)"
+        );
+    }
+
+    #[test]
+    fn test_owned_bytes_read() -> io::Result<()> {
+        let mut bytes = OwnedBytes::new(b"abcdefghiklmnopqrstuvwxyz".as_ref());
+        {
+            let mut buf = [0u8; 5];
+            bytes.read_exact(&mut buf[..]).unwrap();
+            assert_eq!(&buf, b"abcde");
+            assert_eq!(bytes.as_slice(), b"fghiklmnopqrstuvwxyz")
+        }
+        {
+            let mut buf = [0u8; 2];
+            bytes.read_exact(&mut buf[..]).unwrap();
+            assert_eq!(&buf, b"fg");
+            assert_eq!(bytes.as_slice(), b"hiklmnopqrstuvwxyz")
+        }
+        Ok(())
+    }
+
+    #[test]
+    fn test_owned_bytes_read_right_at_the_end() -> io::Result<()> {
+        let mut bytes = OwnedBytes::new(b"abcde".as_ref());
+        let mut buf = [0u8; 5];
+        assert_eq!(bytes.read(&mut buf[..]).unwrap(), 5);
+        assert_eq!(&buf, b"abcde");
+        assert_eq!(bytes.as_slice(), b"");
+        assert_eq!(bytes.read(&mut buf[..]).unwrap(), 0);
+        assert_eq!(&buf, b"abcde");
+        Ok(())
+    }
+    #[test]
+    fn test_owned_bytes_read_incomplete() -> io::Result<()> {
+        let mut bytes = OwnedBytes::new(b"abcde".as_ref());
+        let mut buf = [0u8; 7];
+        assert_eq!(bytes.read(&mut buf[..]).unwrap(), 5);
+        assert_eq!(&buf[..5], b"abcde");
+        assert_eq!(bytes.read(&mut buf[..]).unwrap(), 0);
+        Ok(())
+    }
+
+    #[test]
+    fn test_owned_bytes_read_to_end() -> io::Result<()> {
+        let mut bytes = OwnedBytes::new(b"abcde".as_ref());
+        let mut buf = Vec::new();
+        bytes.read_to_end(&mut buf)?;
+        assert_eq!(buf.as_slice(), b"abcde".as_ref());
+        Ok(())
+    }
+
+    #[test]
+    fn test_owned_bytes_read_u8() -> io::Result<()> {
+        let mut bytes = OwnedBytes::new(b"\xFF".as_ref());
+        assert_eq!(bytes.read_u8(), 255);
+        assert_eq!(bytes.len(), 0);
+        Ok(())
+    }
+
+    #[test]
+    fn test_owned_bytes_read_u64() -> io::Result<()> {
+        let mut bytes = OwnedBytes::new(b"\0\xFF\xFF\xFF\xFF\xFF\xFF\xFF".as_ref());
+        assert_eq!(bytes.read_u64(), u64::MAX - 255);
+        assert_eq!(bytes.len(), 0);
+        Ok(())
+    }
+
+    #[test]
+    fn test_owned_bytes_split() {
+        let bytes = OwnedBytes::new(b"abcdefghi".as_ref());
+        let (left, right) = bytes.split(3);
+        assert_eq!(left.as_slice(), b"abc");
+        assert_eq!(right.as_slice(), b"defghi");
+    }
+
+    #[test]
+    fn test_owned_bytes_split_boundary() {
+        let bytes = OwnedBytes::new(b"abcdefghi".as_ref());
+        {
+            let (left, right) = bytes.clone().split(0);
+            assert_eq!(left.as_slice(), b"");
+            assert_eq!(right.as_slice(), b"abcdefghi");
+        }
+        {
+            let (left, right) = bytes.split(9);
+            assert_eq!(left.as_slice(), b"abcdefghi");
+            assert_eq!(right.as_slice(), b"");
+        }
+    }
+}

src/directory/persistor.rs

@@ -1,38 +0,0 @@
-use crate::indexer::{SegmentManager, ResourceManager, MergeOperationInventory};
-use std::thread::JoinHandle;
-use crate::{IndexWriterConfig, SegmentId};
-use std::collections::HashSet;
-
-pub(crate) struct Persistor {
-    memory_manager: ResourceManager,
-    thread_handle: JoinHandle<()>,
-}
-
-impl Persistor {
-    pub(crate) fn create_and_start(segment_manager: SegmentManager,
-                            memory_manager: ResourceManager,
-                            config: IndexWriterConfig) -> crate::Result<Persistor> {
-        let memory_manager_clone = memory_manager.clone();
-        let thread_handle = std::thread::Builder::new()
-            .name("persistor-thread".to_string())
-            .spawn(move || {
-                while let Ok(_) = memory_manager_clone.wait_until_in_range(config.persist_low..) {
-                    segment_manager.largest_segment_not_in_merge();
-                }
-            }).map_err(|_err| crate::TantivyError::ErrorInThread("Failed to start persistor thread.".to_string()))?;
-        Ok(Persistor {
-            memory_manager,
-            thread_handle
-        })
-    }
-
-    /// Stop the persisting thread.
-    ///
-    /// The memory manager will be terminated, which will unlock the thread from any waiting
-    /// position.
-    /// This method blocks for a short amount of tim until the persistor thread has terminated.
-    pub fn stop(self) {
-        self.memory_manager.terminate();
-        let _ = self.thread_handle.join();
-    }
-}

src/directory/ram_directory.rs

@@ -1,9 +1,9 @@
-use crate::core::META_FILEPATH;
 use crate::directory::error::{DeleteError, OpenReadError, OpenWriteError};
 use crate::directory::AntiCallToken;
 use crate::directory::WatchCallbackList;
-use crate::directory::{Directory, ReadOnlySource, WatchCallback, WatchHandle};
+use crate::directory::{Directory, FileSlice, WatchCallback, WatchHandle};
 use crate::directory::{TerminatingWrite, WritePtr};
+use crate::{common::HasLen, core::META_FILEPATH};
 use fail::fail_point;
 use std::collections::HashMap;
 use std::fmt;
@@ -11,7 +11,8 @@ use std::io::{self, BufWriter, Cursor, Seek, SeekFrom, Write};
 use std::path::{Path, PathBuf};
 use std::result;
 use std::sync::{Arc, RwLock};
-use crate::indexer::ResourceManager;
+
+use super::FileHandle;
 
 /// Writer associated with the `RAMDirectory`
 ///
@@ -81,18 +82,17 @@ impl TerminatingWrite for VecWriter {
 
 #[derive(Default)]
 struct InnerDirectory {
-    fs: HashMap<PathBuf, ReadOnlySource>,
+    fs: HashMap<PathBuf, FileSlice>,
     watch_router: WatchCallbackList,
-    memory_manager: ResourceManager,
 }
 
 impl InnerDirectory {
     fn write(&mut self, path: PathBuf, data: &[u8]) -> bool {
-        let data = ReadOnlySource::new_with_allocation(Vec::from(data), &self.memory_manager);
+        let data = FileSlice::from(data.to_vec());
         self.fs.insert(path, data).is_some()
     }
 
-    fn open_read(&self, path: &Path) -> Result<ReadOnlySource, OpenReadError> {
+    fn open_read(&self, path: &Path) -> Result<FileSlice, OpenReadError> {
         self.fs
             .get(path)
             .ok_or_else(|| OpenReadError::FileDoesNotExist(PathBuf::from(path)))
@@ -114,8 +114,8 @@ impl InnerDirectory {
         self.watch_router.subscribe(watch_handle)
     }
 
-    fn total_mem_usage(&self) -> u64 {
-        self.fs.values().map(|source| source.len() as u64).sum()
+    fn total_mem_usage(&self) -> usize {
+        self.fs.values().map(|f| f.len()).sum()
     }
 }
 
@@ -136,30 +136,14 @@ pub struct RAMDirectory {
 }
 
 impl RAMDirectory {
-
-    /// Creates a new RAMDirectory.
-    ///
-    /// Check `.create_with_memory_manager(..)` if you want to associate an external memory
-    /// manager to your RAMDirectory.
-    pub fn create() -> RAMDirectory {
-        RAMDirectory::default()
-    }
-
     /// Constructor
-    pub fn create_with_memory_manager(memory_manager: ResourceManager) -> RAMDirectory {
-        let inner_directory = InnerDirectory {
-            fs: Default::default(),
-            watch_router: Default::default(),
-            memory_manager
-        };
-        RAMDirectory {
-            fs: Arc::new(RwLock::new(inner_directory))
-        }
+    pub fn create() -> RAMDirectory {
+        Self::default()
     }
 
     /// Returns the sum of the size of the different files
     /// in the RAMDirectory.
-    pub fn total_mem_usage(&self) -> u64 {
+    pub fn total_mem_usage(&self) -> usize {
         self.fs.read().unwrap().total_mem_usage()
     }
 
@@ -169,11 +153,11 @@ impl RAMDirectory {
     /// written using the `atomic_write` api.
     ///
     /// If an error is encounterred, files may be persisted partially.
-    pub fn persist(&self, dest: &mut dyn Directory) -> crate::Result<()> {
+    pub fn persist(&self, dest: &dyn Directory) -> crate::Result<()> {
         let wlock = self.fs.write().unwrap();
-        for (path, source) in wlock.fs.iter() {
+        for (path, file) in wlock.fs.iter() {
             let mut dest_wrt = dest.open_write(path)?;
-            dest_wrt.write_all(source.as_slice())?;
+            dest_wrt.write_all(file.read_bytes()?.as_slice())?;
             dest_wrt.terminate()?;
         }
         Ok(())
@@ -181,24 +165,37 @@ impl RAMDirectory {
 }
 
 impl Directory for RAMDirectory {
-    fn open_read(&self, path: &Path) -> result::Result<ReadOnlySource, OpenReadError> {
+    fn get_file_handle(&self, path: &Path) -> Result<Box<dyn FileHandle>, OpenReadError> {
+        let file_slice = self.open_read(path)?;
+        Ok(Box::new(file_slice))
+    }
+
+    fn open_read(&self, path: &Path) -> result::Result<FileSlice, OpenReadError> {
         self.fs.read().unwrap().open_read(path)
     }
 
     fn delete(&self, path: &Path) -> result::Result<(), DeleteError> {
         fail_point!("RAMDirectory::delete", |_| {
-            use crate::directory::error::IOError;
-            let io_error = IOError::from(io::Error::from(io::ErrorKind::Other));
-            Err(DeleteError::from(io_error))
+            Err(DeleteError::IOError {
+                io_error: io::Error::from(io::ErrorKind::Other),
+                filepath: path.to_path_buf(),
+            })
         });
         self.fs.write().unwrap().delete(path)
     }
 
-    fn exists(&self, path: &Path) -> bool {
-        self.fs.read().unwrap().exists(path)
+    fn exists(&self, path: &Path) -> Result<bool, OpenReadError> {
+        Ok(self
+            .fs
+            .read()
+            .map_err(|e| OpenReadError::IOError {
+                io_error: io::Error::new(io::ErrorKind::Other, e.to_string()),
+                filepath: path.to_path_buf(),
+            })?
+            .exists(path))
     }
 
-    fn open_write(&mut self, path: &Path) -> Result<WritePtr, OpenWriteError> {
+    fn open_write(&self, path: &Path) -> Result<WritePtr, OpenWriteError> {
         let mut fs = self.fs.write().unwrap();
         let path_buf = PathBuf::from(path);
         let vec_writer = VecWriter::new(path_buf.clone(), self.clone());
@@ -212,23 +209,26 @@ impl Directory for RAMDirectory {
     }
 
     fn atomic_read(&self, path: &Path) -> Result<Vec<u8>, OpenReadError> {
-        Ok(self.open_read(path)?.as_slice().to_owned())
+        let bytes =
+            self.open_read(path)?
+                .read_bytes()
+                .map_err(|io_error| OpenReadError::IOError {
+                    io_error,
+                    filepath: path.to_path_buf(),
+                })?;
+        Ok(bytes.as_slice().to_owned())
     }
 
-    fn atomic_write(&mut self, path: &Path, data: &[u8]) -> io::Result<()> {
+    fn atomic_write(&self, path: &Path, data: &[u8]) -> io::Result<()> {
         fail_point!("RAMDirectory::atomic_write", |msg| Err(io::Error::new(
             io::ErrorKind::Other,
             msg.unwrap_or_else(|| "Undefined".to_string())
         )));
         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(())
@@ -245,9 +245,6 @@ mod tests {
     use crate::Directory;
     use std::io::Write;
     use std::path::Path;
-    use crate::indexer::ResourceManager;
-    use crate::directory::TerminatingWrite;
-    use std::mem;
 
     #[test]
     fn test_persist() {
@@ -255,69 +252,14 @@ mod tests {
         let msg_seq: &'static [u8] = b"sequential is the way";
         let path_atomic: &'static Path = Path::new("atomic");
         let path_seq: &'static Path = Path::new("seq");
-        let mut directory = RAMDirectory::create();
+        let directory = RAMDirectory::create();
         assert!(directory.atomic_write(path_atomic, msg_atomic).is_ok());
         let mut wrt = directory.open_write(path_seq).unwrap();
         assert!(wrt.write_all(msg_seq).is_ok());
         assert!(wrt.flush().is_ok());
-        let mut directory_copy = RAMDirectory::create();
-        assert!(directory.persist(&mut directory_copy).is_ok());
+        let directory_copy = RAMDirectory::create();
+        assert!(directory.persist(&directory_copy).is_ok());
         assert_eq!(directory_copy.atomic_read(path_atomic).unwrap(), msg_atomic);
         assert_eq!(directory_copy.atomic_read(path_seq).unwrap(), msg_seq);
     }
-
-    #[test]
-    fn test_memory_manager_several_path() {
-        let memory_manager = ResourceManager::default();
-        let mut ram_directory = RAMDirectory::create_with_memory_manager(memory_manager.clone());
-        assert!(ram_directory.atomic_write(Path::new("/titi"), b"abcd").is_ok());
-        assert_eq!(memory_manager.total_amount(), 4u64);
-        assert!(ram_directory.atomic_write(Path::new("/toto"), b"abcde").is_ok());
-        assert_eq!(memory_manager.total_amount(), 9u64);
-    }
-
-    #[test]
-    fn test_memory_manager_override() {
-        let memory_manager = ResourceManager::default();
-        let mut ram_directory = RAMDirectory::create_with_memory_manager(memory_manager.clone());
-        assert!(ram_directory.atomic_write(Path::new("/titi"), b"abcde").is_ok());
-        assert_eq!(memory_manager.total_amount(), 5u64);
-        assert!(ram_directory.atomic_write(Path::new("/titi"), b"abcdef").is_ok());
-        assert_eq!(memory_manager.total_amount(), 6u64);
-    }
-
-    #[test]
-    fn test_memory_manager_seq_wrt() {
-        let memory_manager = ResourceManager::default();
-        let mut ram_directory = RAMDirectory::create_with_memory_manager(memory_manager.clone());
-        let mut wrt = ram_directory.open_write(Path::new("/titi")).unwrap();
-        assert!(wrt.write_all(b"abcde").is_ok());
-        assert!(wrt.terminate().is_ok());
-        assert_eq!(memory_manager.total_amount(), 5u64);
-        assert!(ram_directory.atomic_write(Path::new("/titi"), b"abcdef").is_ok());
-        assert_eq!(memory_manager.total_amount(), 6u64);
-    }
-
-    #[test]
-    fn test_release_on_drop() {
-        let memory_manager = ResourceManager::default();
-        let mut ram_directory = RAMDirectory::create_with_memory_manager(memory_manager.clone());
-        let mut wrt = ram_directory.open_write(Path::new("/titi")).unwrap();
-        assert!(wrt.write_all(b"abcde").is_ok());
-        assert!(wrt.terminate().is_ok());
-        assert_eq!(memory_manager.total_amount(), 5u64);
-        let mut wrt2 = ram_directory.open_write(Path::new("/toto")).unwrap();
-        assert!(wrt2.write_all(b"abcdefghijkl").is_ok());
-        assert!(wrt2.terminate().is_ok());
-        assert_eq!(memory_manager.total_amount(), 17u64);
-        let source = ram_directory.open_read(Path::new("/titi")).unwrap();
-        let source_clone = source.clone();
-        assert_eq!(memory_manager.total_amount(), 17u64);
-        mem::drop(ram_directory);
-        assert_eq!(memory_manager.total_amount(), 5u64);
-        mem::drop(source);
-        assert_eq!(memory_manager.total_amount(), 5u64);
-        mem::drop(source_clone);
-        assert_eq!(memory_manager.total_amount(), 0u64);
-    }
 }

src/directory/read_only_source.rs

@@ -1,157 +0,0 @@
-use crate::common::HasLen;
-use stable_deref_trait::{CloneStableDeref, StableDeref};
-use std::ops::Deref;
-use std::sync::Arc;
-use crate::indexer::{Allocation, ResourceManager};
-
-pub type BoxedData = Box<dyn Deref<Target = [u8]> + Send + Sync + 'static>;
-
-/// Read object that represents files in tantivy.
-///
-/// These read objects are only in charge to deliver
-/// the data in the form of a constant read-only `&[u8]`.
-/// Whatever happens to the directory file, the data
-/// hold by this object should never be altered or destroyed.
-pub struct ReadOnlySource {
-    data: Arc<BoxedData>,
-    start: usize,
-    stop: usize,
-    allocation: Option<Arc<Allocation>>
-}
-
-unsafe impl StableDeref for ReadOnlySource {}
-unsafe impl CloneStableDeref for ReadOnlySource {}
-
-impl Deref for ReadOnlySource {
-    type Target = [u8];
-
-    fn deref(&self) -> &[u8] {
-        self.as_slice()
-    }
-}
-
-impl From<Arc<BoxedData>> for ReadOnlySource {
-    fn from(data: Arc<BoxedData>) -> Self {
-        let len = data.len();
-        ReadOnlySource {
-            data,
-            start: 0,
-            stop: len,
-            allocation: None
-        }
-    }
-}
-
-impl ReadOnlySource {
-
-    pub(crate) fn new<D>(data: D) -> ReadOnlySource
-    where
-        D: Deref<Target = [u8]> + Send + Sync + 'static,
-    {
-        let len = data.len();
-        ReadOnlySource {
-            data: Arc::new(Box::new(data)),
-            start: 0,
-            stop: len,
-            allocation: None
-        }
-    }
-
-    pub(crate) fn new_with_allocation<D>(data: D, memory_manager: &ResourceManager) -> ReadOnlySource
-        where
-            D: Deref<Target = [u8]> + Send + Sync + 'static,
-    {
-        let len = data.len();
-        ReadOnlySource {
-            data: Arc::new(Box::new(data)),
-            start: 0,
-            stop: len,
-            allocation: Some(Arc::new(memory_manager.allocate(len as u64)))
-        }
-    }
-
-
-    /// Creates an empty ReadOnlySource
-    pub fn empty() -> ReadOnlySource {
-        ReadOnlySource::new(&[][..])
-    }
-
-    /// Returns the data underlying the ReadOnlySource object.
-    pub fn as_slice(&self) -> &[u8] {
-        &self.data[self.start..self.stop]
-    }
-
-    /// Splits into 2 `ReadOnlySource`, at the offset given
-    /// as an argument.
-    pub fn split(self, addr: usize) -> (ReadOnlySource, ReadOnlySource) {
-        let left = self.slice(0, addr);
-        let right = self.slice_from(addr);
-        (left, right)
-    }
-
-    /// Splits into 2 `ReadOnlySource`, at the offset `end - right_len`.
-    pub fn split_from_end(self, right_len: usize) -> (ReadOnlySource, ReadOnlySource) {
-        let left_len = self.len() - right_len;
-        self.split(left_len)
-    }
-
-    /// Creates a ReadOnlySource that is just a
-    /// view over a slice of the data.
-    ///
-    /// Keep in mind that any living slice extends
-    /// the lifetime of the original ReadOnlySource,
-    ///
-    /// For instance, if `ReadOnlySource` wraps 500MB
-    /// worth of data in anonymous memory, and only a
-    /// 1KB slice is remaining, the whole `500MBs`
-    /// are retained in memory.
-    pub fn slice(&self, start: usize, stop: usize) -> ReadOnlySource {
-        assert!(
-            start <= stop,
-            "Requested negative slice [{}..{}]",
-            start,
-            stop
-        );
-        assert!(stop <= self.len());
-        ReadOnlySource {
-            data: self.data.clone(),
-            start: self.start + start,
-            stop: self.start + stop,
-            allocation: self.allocation.clone()
-        }
-    }
-
-    /// Like `.slice(...)` but enforcing only the `from`
-    /// boundary.
-    ///
-    /// Equivalent to `.slice(from_offset, self.len())`
-    pub fn slice_from(&self, from_offset: usize) -> ReadOnlySource {
-        self.slice(from_offset, self.len())
-    }
-
-    /// Like `.slice(...)` but enforcing only the `to`
-    /// boundary.
-    ///
-    /// Equivalent to `.slice(0, to_offset)`
-    pub fn slice_to(&self, to_offset: usize) -> ReadOnlySource {
-        self.slice(0, to_offset)
-    }
-}
-
-impl HasLen for ReadOnlySource {
-    fn len(&self) -> usize {
-        self.stop - self.start
-    }
-}
-
-impl Clone for ReadOnlySource {
-    fn clone(&self) -> Self {
-        self.slice_from(0)
-    }
-}
-
-impl From<Vec<u8>> for ReadOnlySource {
-    fn from(data: Vec<u8>) -> ReadOnlySource {
-        ReadOnlySource::new(data)
-    }
-}

src/directory/spilling_writer.rs

@@ -1,186 +0,0 @@
-use crate::common::MutableEnum;
-use crate::directory::{TerminatingWrite, WritePtr};
-use std::io::{self, Write};
-
-/// Represents the state of the `SpillingWriter`.
-enum SpillingState {
-    Buffer {
-        buffer: Vec<u8>,
-        capacity: usize,
-        write_factory: Box<dyn FnOnce() -> io::Result<WritePtr>>,
-    },
-    Spilled(WritePtr),
-}
-
-impl SpillingState {
-    fn new(
-        limit: usize,
-        write_factory: Box<dyn FnOnce() -> io::Result<WritePtr>>,
-    ) -> SpillingState {
-        SpillingState::Buffer {
-            buffer: Vec::with_capacity(limit),
-            capacity: limit,
-            write_factory,
-        }
-    }
-
-    // Change the state in such a way that it is ready to accept
-    // `extra_capacity` bytes.
-    //
-    fn reserve(self, extra_capacity: usize) -> io::Result<SpillingState> {
-        match self {
-            SpillingState::Buffer {
-                buffer,
-                capacity,
-                write_factory,
-            } => {
-                if capacity >= extra_capacity {
-                    Ok(SpillingState::Buffer {
-                        buffer,
-                        capacity: capacity - extra_capacity,
-                        write_factory,
-                    })
-                } else {
-                    let mut wrt = write_factory()?;
-                    wrt.write_all(&buffer[..])?;
-                    Ok(SpillingState::Spilled(wrt))
-                }
-            }
-            SpillingState::Spilled(wrt) => Ok(SpillingState::Spilled(wrt)),
-        }
-    }
-}
-
-/// The `SpillingWriter` is a writer that start by writing in a
-/// buffer.
-///
-/// Once a memory limit is reached, the spilling writer will
-/// call a given `WritePtr` factory and start spilling into it.
-///
-/// Spilling here includes:
-/// - writing all of the data that were written in the in-memory buffer so far
-/// - writing subsequent data as well.
-///
-/// Once entering "spilling" mode, the `SpillingWriter` stays in this mode.
-pub struct SpillingWriter {
-    state: MutableEnum<SpillingState>,
-}
-
-impl SpillingWriter {
-    //// Creates a new `Spilling Writer`.
-    pub fn new(
-        limit: usize,
-        write_factory: Box<dyn FnOnce() -> io::Result<WritePtr>>,
-    ) -> SpillingWriter {
-        let state = SpillingState::new(limit, write_factory);
-        SpillingWriter {
-            state: MutableEnum::wrap(state),
-        }
-    }
-
-    /// Finalizes the `SpillingWriter`.
-    ///
-    /// The `SpillingResult` object is an enum specific
-    /// to whether the `SpillingWriter` reached the spilling limit
-    /// (In that case, the buffer is returned).
-    ///
-    /// If the writer reached the spilling mode, the underlying `WritePtr`
-    /// is terminated and SpillingResult::Spilled is returned.
-    pub fn finalize(self) -> io::Result<SpillingResult> {
-        match self.state.into() {
-            SpillingState::Spilled(wrt) => {
-                wrt.terminate()?;
-                Ok(SpillingResult::Spilled)
-            }
-            SpillingState::Buffer { buffer, .. } => Ok(SpillingResult::Buffer(buffer)),
-        }
-    }
-}
-
-/// enum used as the result of `.finalize()`.
-pub enum SpillingResult {
-    Spilled,
-    Buffer(Vec<u8>),
-}
-
-impl io::Write for SpillingWriter {
-    fn write(&mut self, payload: &[u8]) -> io::Result<usize> {
-        self.write_all(payload)?;
-        Ok(payload.len())
-    }
-
-    fn flush(&mut self) -> io::Result<()> {
-        if let SpillingState::Spilled(wrt) = &mut *self.state {
-            wrt.flush()?;
-        }
-        Ok(())
-    }
-
-    fn write_all(&mut self, payload: &[u8]) -> io::Result<()> {
-        self.state.map_mutate(|mut state| {
-            state = state.reserve(payload.len())?;
-            match &mut state {
-                SpillingState::Buffer { buffer, .. } => {
-                    buffer.extend_from_slice(payload);
-                }
-                SpillingState::Spilled(wrt) => {
-                    wrt.write_all(payload)?;
-                }
-            }
-            Ok(state)
-        })
-    }
-}
-
-#[cfg(test)]
-mod tests {
-    use super::SpillingWriter;
-    use crate::directory::spilling_writer::SpillingResult;
-    use crate::directory::RAMDirectory;
-    use crate::Directory;
-    use std::io::{self, Write};
-    use std::path::Path;
-
-    #[test]
-    fn test_no_spilling() {
-        let ram_directory = RAMDirectory::create();
-        let mut ram_directory_clone = ram_directory.clone();
-        let path = Path::new("test");
-        let write_factory = Box::new(move || {
-            ram_directory_clone
-                .open_write(path)
-                .map_err(|err| io::Error::new(io::ErrorKind::Other, err))
-        });
-        let mut spilling_wrt = SpillingWriter::new(10, write_factory);
-        assert!(spilling_wrt.write_all(b"abcd").is_ok());
-        if let SpillingResult::Buffer(buf) = spilling_wrt.finalize().unwrap() {
-            assert_eq!(buf, b"abcd")
-        } else {
-            panic!("spill writer should not have spilled");
-        }
-        assert!(!ram_directory.exists(path));
-    }
-
-    #[test]
-    fn test_spilling() {
-        let ram_directory = RAMDirectory::create();
-        let mut ram_directory_clone = ram_directory.clone();
-        let path = Path::new("test");
-        let write_factory = Box::new(move || {
-            ram_directory_clone
-                .open_write(path)
-                .map_err(|err| io::Error::new(io::ErrorKind::Other, err))
-        });
-        let mut spilling_wrt = SpillingWriter::new(10, write_factory);
-        assert!(spilling_wrt.write_all(b"abcd").is_ok());
-        assert!(spilling_wrt.write_all(b"efghijklmnop").is_ok());
-        if let SpillingResult::Spilled = spilling_wrt.finalize().unwrap() {
-        } else {
-            panic!("spill writer should have spilled");
-        }
-        assert_eq!(
-            ram_directory.atomic_read(path).unwrap(),
-            b"abcdefghijklmnop"
-        );
-    }
-}

src/directory/tests.rs

@@ -20,45 +20,47 @@ mod mmap_directory_tests {
     }
 
     #[test]
-    fn test_simple() {
-        let mut directory = make_directory();
-        super::test_simple(&mut directory);
+    fn test_simple() -> crate::Result<()> {
+        let directory = make_directory();
+        super::test_simple(&directory)
     }
 
     #[test]
     fn test_write_create_the_file() {
-        let mut directory = make_directory();
-        super::test_write_create_the_file(&mut directory);
+        let directory = make_directory();
+        super::test_write_create_the_file(&directory);
     }
 
     #[test]
-    fn test_rewrite_forbidden() {
-        let mut directory = make_directory();
-        super::test_rewrite_forbidden(&mut directory);
+    fn test_rewrite_forbidden() -> crate::Result<()> {
+        let directory = make_directory();
+        super::test_rewrite_forbidden(&directory)?;
+        Ok(())
     }
 
     #[test]
-    fn test_directory_delete() {
-        let mut directory = make_directory();
-        super::test_directory_delete(&mut directory);
+    fn test_directory_delete() -> crate::Result<()> {
+        let directory = make_directory();
+        super::test_directory_delete(&directory)?;
+        Ok(())
     }
 
     #[test]
     fn test_lock_non_blocking() {
-        let mut directory = make_directory();
-        super::test_lock_non_blocking(&mut directory);
+        let directory = make_directory();
+        super::test_lock_non_blocking(&directory);
     }
 
     #[test]
     fn test_lock_blocking() {
-        let mut directory = make_directory();
-        super::test_lock_blocking(&mut directory);
+        let directory = make_directory();
+        super::test_lock_blocking(&directory);
     }
 
     #[test]
     fn test_watch() {
-        let mut directory = make_directory();
-        super::test_watch(&mut directory);
+        let directory = make_directory();
+        super::test_watch(&directory);
     }
 }
 
@@ -72,45 +74,47 @@ mod ram_directory_tests {
     }
 
     #[test]
-    fn test_simple() {
-        let mut directory = make_directory();
-        super::test_simple(&mut directory);
+    fn test_simple() -> crate::Result<()> {
+        let directory = make_directory();
+        super::test_simple(&directory)
     }
 
     #[test]
     fn test_write_create_the_file() {
-        let mut directory = make_directory();
-        super::test_write_create_the_file(&mut directory);
+        let directory = make_directory();
+        super::test_write_create_the_file(&directory);
     }
 
     #[test]
-    fn test_rewrite_forbidden() {
-        let mut directory = make_directory();
-        super::test_rewrite_forbidden(&mut directory);
+    fn test_rewrite_forbidden() -> crate::Result<()> {
+        let directory = make_directory();
+        super::test_rewrite_forbidden(&directory)?;
+        Ok(())
     }
 
     #[test]
-    fn test_directory_delete() {
-        let mut directory = make_directory();
-        super::test_directory_delete(&mut directory);
+    fn test_directory_delete() -> crate::Result<()> {
+        let directory = make_directory();
+        super::test_directory_delete(&directory)?;
+        Ok(())
     }
 
     #[test]
     fn test_lock_non_blocking() {
-        let mut directory = make_directory();
-        super::test_lock_non_blocking(&mut directory);
+        let directory = make_directory();
+        super::test_lock_non_blocking(&directory);
     }
 
     #[test]
     fn test_lock_blocking() {
-        let mut directory = make_directory();
-        super::test_lock_blocking(&mut directory);
+        let directory = make_directory();
+        super::test_lock_blocking(&directory);
     }
 
     #[test]
     fn test_watch() {
-        let mut directory = make_directory();
-        super::test_watch(&mut directory);
+        let directory = make_directory();
+        super::test_watch(&directory);
     }
 }
 
@@ -118,68 +122,61 @@ mod ram_directory_tests {
 #[should_panic]
 fn ram_directory_panics_if_flush_forgotten() {
     let test_path: &'static Path = Path::new("some_path_for_test");
-    let mut ram_directory = RAMDirectory::create();
+    let ram_directory = RAMDirectory::create();
     let mut write_file = ram_directory.open_write(test_path).unwrap();
     assert!(write_file.write_all(&[4]).is_ok());
 }
 
-fn test_simple(directory: &mut dyn Directory) {
+fn test_simple(directory: &dyn Directory) -> crate::Result<()> {
     let test_path: &'static Path = Path::new("some_path_for_test");
-    {
-        let mut write_file = directory.open_write(test_path).unwrap();
-        assert!(directory.exists(test_path));
-        write_file.write_all(&[4]).unwrap();
-        write_file.write_all(&[3]).unwrap();
-        write_file.write_all(&[7, 3, 5]).unwrap();
-        write_file.flush().unwrap();
-    }
-    {
-        let read_file = directory.open_read(test_path).unwrap();
-        let data: &[u8] = &*read_file;
-        assert_eq!(data, &[4u8, 3u8, 7u8, 3u8, 5u8]);
-    }
+    let mut write_file = directory.open_write(test_path)?;
+    assert!(directory.exists(test_path).unwrap());
+    write_file.write_all(&[4])?;
+    write_file.write_all(&[3])?;
+    write_file.write_all(&[7, 3, 5])?;
+    write_file.flush()?;
+    let read_file = directory.open_read(test_path)?.read_bytes()?;
+    assert_eq!(read_file.as_slice(), &[4u8, 3u8, 7u8, 3u8, 5u8]);
+    mem::drop(read_file);
     assert!(directory.delete(test_path).is_ok());
-    assert!(!directory.exists(test_path));
+    assert!(!directory.exists(test_path).unwrap());
+    Ok(())
 }
 
-fn test_rewrite_forbidden(directory: &mut dyn Directory) {
+fn test_rewrite_forbidden(directory: &dyn Directory) -> crate::Result<()> {
     let test_path: &'static Path = Path::new("some_path_for_test");
-    {
-        directory.open_write(test_path).unwrap();
-        assert!(directory.exists(test_path));
-    }
-    {
-        assert!(directory.open_write(test_path).is_err());
-    }
+    directory.open_write(test_path)?;
+    assert!(directory.exists(test_path).unwrap());
+    assert!(directory.open_write(test_path).is_err());
     assert!(directory.delete(test_path).is_ok());
+    Ok(())
 }
 
-fn test_write_create_the_file(directory: &mut dyn Directory) {
+fn test_write_create_the_file(directory: &dyn Directory) {
     let test_path: &'static Path = Path::new("some_path_for_test");
     {
         assert!(directory.open_read(test_path).is_err());
         let _w = directory.open_write(test_path).unwrap();
-        assert!(directory.exists(test_path));
+        assert!(directory.exists(test_path).unwrap());
         assert!(directory.open_read(test_path).is_ok());
         assert!(directory.delete(test_path).is_ok());
     }
 }
 
-fn test_directory_delete(directory: &mut dyn Directory) {
+fn test_directory_delete(directory: &dyn Directory) -> crate::Result<()> {
     let test_path: &'static Path = Path::new("some_path_for_test");
     assert!(directory.open_read(test_path).is_err());
-    let mut write_file = directory.open_write(&test_path).unwrap();
-    write_file.write_all(&[1, 2, 3, 4]).unwrap();
-    write_file.flush().unwrap();
+    let mut write_file = directory.open_write(&test_path)?;
+    write_file.write_all(&[1, 2, 3, 4])?;
+    write_file.flush()?;
     {
-        let read_handle = directory.open_read(&test_path).unwrap();
-        assert_eq!(&*read_handle, &[1u8, 2u8, 3u8, 4u8]);
+        let read_handle = directory.open_read(&test_path)?.read_bytes()?;
+        assert_eq!(read_handle.as_slice(), &[1u8, 2u8, 3u8, 4u8]);
         // Mapped files can't be deleted on Windows
         if !cfg!(windows) {
             assert!(directory.delete(&test_path).is_ok());
-            assert_eq!(&*read_handle, &[1u8, 2u8, 3u8, 4u8]);
+            assert_eq!(read_handle.as_slice(), &[1u8, 2u8, 3u8, 4u8]);
         }
-
         assert!(directory.delete(Path::new("SomeOtherPath")).is_err());
     }
 
@@ -189,44 +186,40 @@ fn test_directory_delete(directory: &mut dyn Directory) {
 
     assert!(directory.open_read(&test_path).is_err());
     assert!(directory.delete(&test_path).is_err());
+    Ok(())
 }
 
-fn test_watch(directory: &mut dyn Directory) {
-    let num_progress: Arc<AtomicUsize> = Default::default();
+fn test_watch(directory: &dyn Directory) {
     let counter: Arc<AtomicUsize> = Default::default();
-    let counter_clone = counter.clone();
-    let (sender, receiver) = crossbeam::channel::unbounded();
-    let watch_callback = Box::new(move || {
-        counter_clone.fetch_add(1, SeqCst);
-    });
-    // This callback is used to synchronize watching in our unit test.
-    // We bind it to a variable because the callback is removed when that
-    // handle is dropped.
-    let watch_handle = directory.watch(watch_callback).unwrap();
-    let _progress_listener = directory
-        .watch(Box::new(move || {
-            let val = num_progress.fetch_add(1, SeqCst);
-            let _ = sender.send(val);
+    let (tx, rx) = crossbeam::channel::unbounded();
+    let timeout = Duration::from_millis(500);
+
+    let handle = directory
+        .watch(WatchCallback::new(move || {
+            let val = counter.fetch_add(1, SeqCst);
+            tx.send(val + 1).unwrap();
         }))
         .unwrap();
 
-    for i in 0..10 {
-        assert_eq!(i, counter.load(SeqCst));
-        assert!(directory
-            .atomic_write(Path::new("meta.json"), b"random_test_data_2")
-            .is_ok());
-        assert_eq!(receiver.recv_timeout(Duration::from_millis(500)), Ok(i));
-        assert_eq!(i + 1, counter.load(SeqCst));
-    }
-    mem::drop(watch_handle);
     assert!(directory
-        .atomic_write(Path::new("meta.json"), b"random_test_data")
+        .atomic_write(Path::new("meta.json"), b"foo")
         .is_ok());
-    assert!(receiver.recv_timeout(Duration::from_millis(500)).is_ok());
-    assert_eq!(10, counter.load(SeqCst));
+    assert_eq!(rx.recv_timeout(timeout), Ok(1));
+
+    assert!(directory
+        .atomic_write(Path::new("meta.json"), b"bar")
+        .is_ok());
+    assert_eq!(rx.recv_timeout(timeout), Ok(2));
+
+    mem::drop(handle);
+
+    assert!(directory
+        .atomic_write(Path::new("meta.json"), b"qux")
+        .is_ok());
+    assert!(rx.recv_timeout(timeout).is_err());
 }
 
-fn test_lock_non_blocking(directory: &mut dyn Directory) {
+fn test_lock_non_blocking(directory: &dyn Directory) {
     {
         let lock_a_res = directory.acquire_lock(&Lock {
             filepath: PathBuf::from("a.lock"),
@@ -251,7 +244,7 @@ fn test_lock_non_blocking(directory: &mut dyn Directory) {
     assert!(lock_a_res.is_ok());
 }
 
-fn test_lock_blocking(directory: &mut dyn Directory) {
+fn test_lock_blocking(directory: &dyn Directory) {
     let lock_a_res = directory.acquire_lock(&Lock {
         filepath: PathBuf::from("a.lock"),
         is_blocking: true,

src/directory/watch_event_router.rs

@@ -4,8 +4,20 @@ use std::sync::Arc;
 use std::sync::RwLock;
 use std::sync::Weak;
 
-/// Type alias for callbacks registered when watching files of a `Directory`.
-pub type WatchCallback = Box<dyn Fn() -> () + Sync + Send>;
+/// Cloneable wrapper for callbacks registered when watching files of a `Directory`.
+#[derive(Clone)]
+pub struct WatchCallback(Arc<dyn Fn() + Sync + Send>);
+
+impl WatchCallback {
+    /// Wraps a `Fn()` to create a WatchCallback.
+    pub fn new<F: Fn() + Sync + Send + 'static>(op: F) -> Self {
+        WatchCallback(Arc::new(op))
+    }
+
+    fn call(&self) {
+        self.0()
+    }
+}
 
 /// Helper struct to implement the watch method in `Directory` implementations.
 ///
@@ -29,10 +41,17 @@ impl WatchHandle {
     pub fn new(watch_callback: Arc<WatchCallback>) -> WatchHandle {
         WatchHandle(watch_callback)
     }
+
+    /// Returns an empty watch handle.
+    ///
+    /// This function is only useful when implementing a readonly directory.
+    pub fn empty() -> WatchHandle {
+        WatchHandle::new(Arc::new(WatchCallback::new(|| {})))
+    }
 }
 
 impl WatchCallbackList {
-    /// Suscribes a new callback and returns a handle that controls the lifetime of the callback.
+    /// Subscribes a new callback and returns a handle that controls the lifetime of the callback.
     pub fn subscribe(&self, watch_callback: WatchCallback) -> WatchHandle {
         let watch_callback_arc = Arc::new(watch_callback);
         let watch_callback_weak = Arc::downgrade(&watch_callback_arc);
@@ -40,13 +59,13 @@ impl WatchCallbackList {
         WatchHandle::new(watch_callback_arc)
     }
 
-    fn list_callback(&self) -> Vec<Arc<WatchCallback>> {
-        let mut callbacks = vec![];
+    fn list_callback(&self) -> Vec<WatchCallback> {
+        let mut callbacks: Vec<WatchCallback> = vec![];
         let mut router_wlock = self.router.write().unwrap();
         let mut i = 0;
         while i < router_wlock.len() {
             if let Some(watch) = router_wlock[i].upgrade() {
-                callbacks.push(watch);
+                callbacks.push(watch.as_ref().clone());
                 i += 1;
             } else {
                 router_wlock.swap_remove(i);
@@ -68,7 +87,7 @@ impl WatchCallbackList {
             .name("watch-callbacks".to_string())
             .spawn(move || {
                 for callback in callbacks {
-                    callback();
+                    callback.call();
                 }
                 let _ = sender.send(());
             });
@@ -84,7 +103,7 @@ impl WatchCallbackList {
 
 #[cfg(test)]
 mod tests {
-    use crate::directory::WatchCallbackList;
+    use crate::directory::{WatchCallback, WatchCallbackList};
     use futures::executor::block_on;
     use std::mem;
     use std::sync::atomic::{AtomicUsize, Ordering};
@@ -95,7 +114,7 @@ mod tests {
         let watch_event_router = WatchCallbackList::default();
         let counter: Arc<AtomicUsize> = Default::default();
         let counter_clone = counter.clone();
-        let inc_callback = Box::new(move || {
+        let inc_callback = WatchCallback::new(move || {
             counter_clone.fetch_add(1, Ordering::SeqCst);
         });
         block_on(watch_event_router.broadcast());
@@ -123,7 +142,7 @@ mod tests {
         let counter: Arc<AtomicUsize> = Default::default();
         let inc_callback = |inc: usize| {
             let counter_clone = counter.clone();
-            Box::new(move || {
+            WatchCallback::new(move || {
                 counter_clone.fetch_add(inc, Ordering::SeqCst);
             })
         };
@@ -151,7 +170,7 @@ mod tests {
         let watch_event_router = WatchCallbackList::default();
         let counter: Arc<AtomicUsize> = Default::default();
         let counter_clone = counter.clone();
-        let inc_callback = Box::new(move || {
+        let inc_callback = WatchCallback::new(move || {
             counter_clone.fetch_add(1, Ordering::SeqCst);
         });
         let handle_a = watch_event_router.subscribe(inc_callback);

src/docset.rs

@@ -1,58 +1,48 @@
-use crate::common::BitSet;
 use crate::fastfield::DeleteBitSet;
 use crate::DocId;
 use std::borrow::Borrow;
 use std::borrow::BorrowMut;
-use std::cmp::Ordering;
 
-/// Expresses the outcome of a call to `DocSet`'s `.skip_next(...)`.
-#[derive(PartialEq, Eq, Debug)]
-pub enum SkipResult {
-    /// target was in the docset
-    Reached,
-    /// target was not in the docset, skipping stopped as a greater element was found
-    OverStep,
-    /// the docset was entirely consumed without finding the target, nor any
-    /// element greater than the target.
-    End,
-}
+/// Sentinel value returned when a DocSet has been entirely consumed.
+///
+/// This is not u32::MAX as one would have expected, due to the lack of SSE2 instructions
+/// to compare [u32; 4].
+pub const TERMINATED: DocId = std::i32::MAX as u32;
 
 /// Represents an iterable set of sorted doc ids.
-pub trait DocSet {
+pub trait DocSet: Send {
     /// Goes to the next element.
-    /// `.advance(...)` needs to be called a first time to point to the correct
-    /// element.
-    fn advance(&mut self) -> bool;
+    ///
+    /// The DocId of the next element is returned.
+    /// In other words we should always have :
+    /// ```ignore
+    /// let doc = docset.advance();
+    /// assert_eq!(doc, docset.doc());
+    /// ```
+    ///
+    /// If we reached the end of the DocSet, TERMINATED should be returned.
+    ///
+    /// Calling `.advance()` on a terminated DocSet should be supported, and TERMINATED should
+    /// be returned.
+    /// TODO Test existing docsets.
+    fn advance(&mut self) -> DocId;
 
-    /// After skipping, position the iterator in such a way that `.doc()`
-    /// will return a value greater than or equal to target.
+    /// Advances the DocSet forward until reaching the target, or going to the
+    /// lowest DocId greater than the target.
     ///
-    /// SkipResult expresses whether the `target value` was reached, overstepped,
-    /// or if the `DocSet` was entirely consumed without finding any value
-    /// greater or equal to the `target`.
+    /// If the end of the DocSet is reached, TERMINATED is returned.
     ///
-    /// WARNING: Calling skip always advances the docset.
-    /// More specifically, if the docset is already positionned on the target
-    /// skipping will advance to the next position and return SkipResult::Overstep.
+    /// Calling `.seek(target)` on a terminated DocSet is legal. Implementation
+    /// of DocSet should support it.
     ///
-    /// If `.skip_next()` oversteps, then the docset must be positionned correctly
-    /// on an existing document. In other words, `.doc()` should return the first document
-    /// greater than `DocId`.
-    fn skip_next(&mut self, target: DocId) -> SkipResult {
-        if !self.advance() {
-            return SkipResult::End;
-        }
-        loop {
-            match self.doc().cmp(&target) {
-                Ordering::Less => {
-                    if !self.advance() {
-                        return SkipResult::End;
-                    }
-                }
-                Ordering::Equal => return SkipResult::Reached,
-                Ordering::Greater => return SkipResult::OverStep,
-            }
+    /// Calling `seek(TERMINATED)` is also legal and is the normal way to consume a DocSet.
+    fn seek(&mut self, target: DocId) -> DocId {
+        let mut doc = self.doc();
+        debug_assert!(doc <= target);
+        while doc < target {
+            doc = self.advance();
         }
+        doc
     }
 
     /// Fills a given mutable buffer with the next doc ids from the
@@ -71,38 +61,38 @@ pub trait DocSet {
     /// use case where batching. The normal way to
     /// go through the `DocId`'s is to call `.advance()`.
     fn fill_buffer(&mut self, buffer: &mut [DocId]) -> usize {
+        if self.doc() == TERMINATED {
+            return 0;
+        }
         for (i, buffer_val) in buffer.iter_mut().enumerate() {
-            if self.advance() {
-                *buffer_val = self.doc();
-            } else {
-                return i;
+            *buffer_val = self.doc();
+            if self.advance() == TERMINATED {
+                return i + 1;
             }
         }
         buffer.len()
     }
 
     /// Returns the current document
+    /// Right after creating a new DocSet, the docset points to the first document.
+    ///
+    /// If the DocSet is empty, .doc() should return `TERMINATED`.
     fn doc(&self) -> DocId;
 
     /// Returns a best-effort hint of the
     /// length of the docset.
     fn size_hint(&self) -> u32;
 
-    /// Appends all docs to a `bitset`.
-    fn append_to_bitset(&mut self, bitset: &mut BitSet) {
-        while self.advance() {
-            bitset.insert(self.doc());
-        }
-    }
-
     /// Returns the number documents matching.
     /// Calling this method consumes the `DocSet`.
     fn count(&mut self, delete_bitset: &DeleteBitSet) -> u32 {
         let mut count = 0u32;
-        while self.advance() {
-            if !delete_bitset.is_deleted(self.doc()) {
+        let mut doc = self.doc();
+        while doc != TERMINATED {
+            if !delete_bitset.is_deleted(doc) {
                 count += 1u32;
             }
+            doc = self.advance();
         }
         count
     }
@@ -114,22 +104,50 @@ pub trait DocSet {
     /// given by `count()`.
     fn count_including_deleted(&mut self) -> u32 {
         let mut count = 0u32;
-        while self.advance() {
+        let mut doc = self.doc();
+        while doc != TERMINATED {
             count += 1u32;
+            doc = self.advance();
         }
         count
     }
 }
 
+impl<'a> DocSet for &'a mut dyn DocSet {
+    fn advance(&mut self) -> u32 {
+        (**self).advance()
+    }
+
+    fn seek(&mut self, target: DocId) -> DocId {
+        (**self).seek(target)
+    }
+
+    fn doc(&self) -> u32 {
+        (**self).doc()
+    }
+
+    fn size_hint(&self) -> u32 {
+        (**self).size_hint()
+    }
+
+    fn count(&mut self, delete_bitset: &DeleteBitSet) -> u32 {
+        (**self).count(delete_bitset)
+    }
+
+    fn count_including_deleted(&mut self) -> u32 {
+        (**self).count_including_deleted()
+    }
+}
+
 impl<TDocSet: DocSet + ?Sized> DocSet for Box<TDocSet> {
-    fn advance(&mut self) -> bool {
+    fn advance(&mut self) -> DocId {
         let unboxed: &mut TDocSet = self.borrow_mut();
         unboxed.advance()
     }
 
-    fn skip_next(&mut self, target: DocId) -> SkipResult {
+    fn seek(&mut self, target: DocId) -> DocId {
         let unboxed: &mut TDocSet = self.borrow_mut();
-        unboxed.skip_next(target)
+        unboxed.seek(target)
     }
 
     fn doc(&self) -> DocId {
@@ -151,9 +169,4 @@ impl<TDocSet: DocSet + ?Sized> DocSet for Box<TDocSet> {
         let unboxed: &mut TDocSet = self.borrow_mut();
         unboxed.count_including_deleted()
     }
-
-    fn append_to_bitset(&mut self, bitset: &mut BitSet) {
-        let unboxed: &mut TDocSet = self.borrow_mut();
-        unboxed.append_to_bitset(bitset);
-    }
 }

src/error.rs

@@ -2,22 +2,27 @@
 
 use std::io;
 
-use crate::directory::error::{IOError, OpenDirectoryError, OpenReadError, OpenWriteError};
 use crate::directory::error::{Incompatibility, LockError};
 use crate::fastfield::FastFieldNotAvailableError;
 use crate::query;
-use crate::schema;
-use serde_json;
+use crate::{
+    directory::error::{OpenDirectoryError, OpenReadError, OpenWriteError},
+    schema,
+};
 use std::fmt;
 use std::path::PathBuf;
 use std::sync::PoisonError;
 
+/// Represents a `DataCorruption` error.
+///
+/// When facing data corruption, tantivy  actually panic or return this error.
 pub struct DataCorruption {
     filepath: Option<PathBuf>,
     comment: String,
 }
 
 impl DataCorruption {
+    /// Creates a `DataCorruption` Error.
     pub fn new(filepath: PathBuf, comment: String) -> DataCorruption {
         DataCorruption {
             filepath: Some(filepath),
@@ -25,10 +30,11 @@ impl DataCorruption {
         }
     }
 
-    pub fn comment_only(comment: String) -> DataCorruption {
+    /// Creates a `DataCorruption` Error, when the filepath is irrelevant.
+    pub fn comment_only<TStr: ToString>(comment: TStr) -> DataCorruption {
         DataCorruption {
             filepath: None,
-            comment,
+            comment: comment.to_string(),
         }
     }
 }
@@ -44,44 +50,47 @@ impl fmt::Debug for DataCorruption {
     }
 }
 
-/// The library's failure based error enum
-#[derive(Debug, Fail)]
+/// The library's error enum
+#[derive(Debug, Error)]
 pub enum TantivyError {
-    /// Path does not exist.
-    #[fail(display = "Path does not exist: '{:?}'", _0)]
-    PathDoesNotExist(PathBuf),
-    /// File already exists, this is a problem when we try to write into a new file.
-    #[fail(display = "File already exists: '{:?}'", _0)]
-    FileAlreadyExists(PathBuf),
+    /// Failed to open the directory.
+    #[error("Failed to open the directory: '{0:?}'")]
+    OpenDirectoryError(#[from] OpenDirectoryError),
+    /// Failed to open a file for read.
+    #[error("Failed to open file for read: '{0:?}'")]
+    OpenReadError(#[from] OpenReadError),
+    /// Failed to open a file for write.
+    #[error("Failed to open file for write: '{0:?}'")]
+    OpenWriteError(#[from] OpenWriteError),
     /// Index already exists in this directory
-    #[fail(display = "Index already exists")]
+    #[error("Index already exists")]
     IndexAlreadyExists,
     /// Failed to acquire file lock
-    #[fail(display = "Failed to acquire Lockfile: {:?}. {:?}", _0, _1)]
+    #[error("Failed to acquire Lockfile: {0:?}. {1:?}")]
     LockFailure(LockError, Option<String>),
     /// IO Error.
-    #[fail(display = "An IO error occurred: '{}'", _0)]
-    IOError(#[cause] IOError),
+    #[error("An IO error occurred: '{0}'")]
+    IOError(#[from] io::Error),
     /// Data corruption.
-    #[fail(display = "{:?}", _0)]
+    #[error("Data corrupted: '{0:?}'")]
     DataCorruption(DataCorruption),
     /// A thread holding the locked panicked and poisoned the lock.
-    #[fail(display = "A thread holding the locked panicked and poisoned the lock")]
+    #[error("A thread holding the locked panicked and poisoned the lock")]
     Poisoned,
     /// Invalid argument was passed by the user.
-    #[fail(display = "An invalid argument was passed: '{}'", _0)]
+    #[error("An invalid argument was passed: '{0}'")]
     InvalidArgument(String),
     /// An Error happened in one of the thread.
-    #[fail(display = "An error occurred in a thread: '{}'", _0)]
+    #[error("An error occurred in a thread: '{0}'")]
     ErrorInThread(String),
     /// An Error appeared related to the schema.
-    #[fail(display = "Schema error: '{}'", _0)]
+    #[error("Schema error: '{0}'")]
     SchemaError(String),
     /// System error. (e.g.: We failed spawning a new thread)
-    #[fail(display = "System error.'{}'", _0)]
+    #[error("System error.'{0}'")]
     SystemError(String),
     /// Index incompatible with current version of tantivy
-    #[fail(display = "{:?}", _0)]
+    #[error("{0:?}")]
     IncompatibleIndex(Incompatibility),
 }
 
@@ -90,31 +99,17 @@ impl From<DataCorruption> for TantivyError {
         TantivyError::DataCorruption(data_corruption)
     }
 }
-
 impl From<FastFieldNotAvailableError> for TantivyError {
     fn from(fastfield_error: FastFieldNotAvailableError) -> TantivyError {
         TantivyError::SchemaError(format!("{}", fastfield_error))
     }
 }
-
 impl From<LockError> for TantivyError {
     fn from(lock_error: LockError) -> TantivyError {
         TantivyError::LockFailure(lock_error, None)
     }
 }
 
-impl From<IOError> for TantivyError {
-    fn from(io_error: IOError) -> TantivyError {
-        TantivyError::IOError(io_error)
-    }
-}
-
-impl From<io::Error> for TantivyError {
-    fn from(io_error: io::Error) -> TantivyError {
-        TantivyError::IOError(io_error.into())
-    }
-}
-
 impl From<query::QueryParserError> for TantivyError {
     fn from(parsing_error: query::QueryParserError) -> TantivyError {
         TantivyError::InvalidArgument(format!("Query is invalid. {:?}", parsing_error))
@@ -127,15 +122,9 @@ impl<Guard> From<PoisonError<Guard>> for TantivyError {
     }
 }
 
-impl From<OpenReadError> for TantivyError {
-    fn from(error: OpenReadError) -> TantivyError {
-        match error {
-            OpenReadError::FileDoesNotExist(filepath) => TantivyError::PathDoesNotExist(filepath),
-            OpenReadError::IOError(io_error) => TantivyError::IOError(io_error),
-            OpenReadError::IncompatibleIndex(incompatibility) => {
-                TantivyError::IncompatibleIndex(incompatibility)
-            }
-        }
+impl From<chrono::ParseError> for TantivyError {
+    fn from(err: chrono::ParseError) -> TantivyError {
+        TantivyError::InvalidArgument(err.to_string())
     }
 }
 
@@ -145,35 +134,9 @@ impl From<schema::DocParsingError> for TantivyError {
     }
 }
 
-impl From<OpenWriteError> for TantivyError {
-    fn from(error: OpenWriteError) -> TantivyError {
-        match error {
-            OpenWriteError::FileAlreadyExists(filepath) => {
-                TantivyError::FileAlreadyExists(filepath)
-            }
-            OpenWriteError::IOError(io_error) => TantivyError::IOError(io_error),
-        }
-    }
-}
-
-impl From<OpenDirectoryError> for TantivyError {
-    fn from(error: OpenDirectoryError) -> TantivyError {
-        match error {
-            OpenDirectoryError::DoesNotExist(directory_path) => {
-                TantivyError::PathDoesNotExist(directory_path)
-            }
-            OpenDirectoryError::NotADirectory(directory_path) => {
-                TantivyError::InvalidArgument(format!("{:?} is not a directory", directory_path))
-            }
-            OpenDirectoryError::IoError(err) => TantivyError::IOError(IOError::from(err)),
-        }
-    }
-}
-
 impl From<serde_json::Error> for TantivyError {
     fn from(error: serde_json::Error) -> TantivyError {
-        let io_err = io::Error::from(error);
-        TantivyError::IOError(io_err.into())
+        TantivyError::IOError(error.into())
     }
 }
 

src/fastfield/bytes/mod.rs

@@ -6,31 +6,114 @@ pub use self::writer::BytesFastFieldWriter;
 
 #[cfg(test)]
 mod tests {
-    use crate::schema::Schema;
-    use crate::Index;
+    use crate::schema::{BytesOptions, IndexRecordOption, Schema, Value};
+    use crate::{query::TermQuery, schema::FAST, schema::INDEXED, schema::STORED};
+    use crate::{DocAddress, DocSet, Index, Searcher, Term};
+    use std::ops::Deref;
 
     #[test]
-    fn test_bytes() {
+    fn test_bytes() -> crate::Result<()> {
         let mut schema_builder = Schema::builder();
-        let field = schema_builder.add_bytes_field("bytesfield");
+        let bytes_field = schema_builder.add_bytes_field("bytesfield", FAST);
         let schema = schema_builder.build();
         let index = Index::create_in_ram(schema);
-        let mut index_writer = index.writer_with_num_threads(1, 3_000_000).unwrap();
-        index_writer.add_document(doc!(field=>vec![0u8, 1, 2, 3]));
-        index_writer.add_document(doc!(field=>vec![]));
-        index_writer.add_document(doc!(field=>vec![255u8]));
-        index_writer.add_document(doc!(field=>vec![1u8, 3, 5, 7, 9]));
-        index_writer.add_document(doc!(field=>vec![0u8; 1000]));
-        assert!(index_writer.commit().is_ok());
-        let searcher = index.reader().unwrap().searcher();
+        let mut index_writer = index.writer_for_tests()?;
+        index_writer.add_document(doc!(bytes_field=>vec![0u8, 1, 2, 3]));
+        index_writer.add_document(doc!(bytes_field=>vec![]));
+        index_writer.add_document(doc!(bytes_field=>vec![255u8]));
+        index_writer.add_document(doc!(bytes_field=>vec![1u8, 3, 5, 7, 9]));
+        index_writer.add_document(doc!(bytes_field=>vec![0u8; 1000]));
+        index_writer.commit()?;
+        let searcher = index.reader()?.searcher();
         let segment_reader = searcher.segment_reader(0);
-        let bytes_reader = segment_reader.fast_fields().bytes(field).unwrap();
-
+        let bytes_reader = segment_reader.fast_fields().bytes(bytes_field).unwrap();
         assert_eq!(bytes_reader.get_bytes(0), &[0u8, 1, 2, 3]);
         assert!(bytes_reader.get_bytes(1).is_empty());
         assert_eq!(bytes_reader.get_bytes(2), &[255u8]);
         assert_eq!(bytes_reader.get_bytes(3), &[1u8, 3, 5, 7, 9]);
         let long = vec![0u8; 1000];
         assert_eq!(bytes_reader.get_bytes(4), long.as_slice());
+        Ok(())
+    }
+
+    fn create_index_for_test<T: Into<BytesOptions>>(
+        byte_options: T,
+    ) -> crate::Result<impl Deref<Target = Searcher>> {
+        let mut schema_builder = Schema::builder();
+        let field = schema_builder.add_bytes_field("string_bytes", byte_options.into());
+        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!(
+                field => b"tantivy".as_ref(),
+                field => b"lucene".as_ref()
+        ));
+        index_writer.commit()?;
+        Ok(index.reader()?.searcher())
+    }
+
+    #[test]
+    fn test_stored_bytes() -> crate::Result<()> {
+        let searcher = create_index_for_test(STORED)?;
+        assert_eq!(searcher.num_docs(), 1);
+        let retrieved_doc = searcher.doc(DocAddress::new(0u32, 0u32))?;
+        let field = searcher.schema().get_field("string_bytes").unwrap();
+        let values: Vec<&Value> = retrieved_doc.get_all(field).collect();
+        assert_eq!(values.len(), 2);
+        let values_bytes: Vec<&[u8]> = values
+            .into_iter()
+            .flat_map(|value| value.bytes_value())
+            .collect();
+        assert_eq!(values_bytes, &[&b"tantivy"[..], &b"lucene"[..]]);
+        Ok(())
+    }
+
+    #[test]
+    fn test_non_stored_bytes() -> crate::Result<()> {
+        let searcher = create_index_for_test(INDEXED)?;
+        assert_eq!(searcher.num_docs(), 1);
+        let retrieved_doc = searcher.doc(DocAddress::new(0u32, 0u32))?;
+        let field = searcher.schema().get_field("string_bytes").unwrap();
+        assert!(retrieved_doc.get_first(field).is_none());
+        Ok(())
+    }
+
+    #[test]
+    fn test_index_bytes() -> crate::Result<()> {
+        let searcher = create_index_for_test(INDEXED)?;
+        assert_eq!(searcher.num_docs(), 1);
+        let field = searcher.schema().get_field("string_bytes").unwrap();
+        let term = Term::from_field_bytes(field, b"lucene".as_ref());
+        let term_query = TermQuery::new(term, IndexRecordOption::Basic);
+        let term_weight = term_query.specialized_weight(&searcher, true)?;
+        let term_scorer = term_weight.specialized_scorer(searcher.segment_reader(0), 1.0)?;
+        assert_eq!(term_scorer.doc(), 0u32);
+        Ok(())
+    }
+
+    #[test]
+    fn test_non_index_bytes() -> crate::Result<()> {
+        let searcher = create_index_for_test(STORED)?;
+        assert_eq!(searcher.num_docs(), 1);
+        let field = searcher.schema().get_field("string_bytes").unwrap();
+        let term = Term::from_field_bytes(field, b"lucene".as_ref());
+        let term_query = TermQuery::new(term, IndexRecordOption::Basic);
+        let term_weight_err = term_query.specialized_weight(&searcher, false);
+        assert!(matches!(
+            term_weight_err,
+            Err(crate::TantivyError::SchemaError(_))
+        ));
+        Ok(())
+    }
+
+    #[test]
+    fn test_fast_bytes_multivalue_value() -> crate::Result<()> {
+        let searcher = create_index_for_test(FAST)?;
+        assert_eq!(searcher.num_docs(), 1);
+        let fast_fields = searcher.segment_reader(0u32).fast_fields();
+        let field = searcher.schema().get_field("string_bytes").unwrap();
+        let fast_field_reader = fast_fields.bytes(field).unwrap();
+        assert_eq!(fast_field_reader.get_bytes(0u32), b"tantivy");
+        Ok(())
     }
 }

src/fastfield/bytes/reader.rs

@@ -1,6 +1,5 @@
-use owning_ref::OwningRef;
-
-use crate::directory::ReadOnlySource;
+use crate::directory::FileSlice;
+use crate::directory::OwnedBytes;
 use crate::fastfield::FastFieldReader;
 use crate::DocId;
 
@@ -17,16 +16,16 @@ use crate::DocId;
 #[derive(Clone)]
 pub struct BytesFastFieldReader {
     idx_reader: FastFieldReader<u64>,
-    values: OwningRef<ReadOnlySource, [u8]>,
+    values: OwnedBytes,
 }
 
 impl BytesFastFieldReader {
     pub(crate) fn open(
         idx_reader: FastFieldReader<u64>,
-        values_source: ReadOnlySource,
-    ) -> BytesFastFieldReader {
-        let values = OwningRef::new(values_source).map(|source| &source[..]);
-        BytesFastFieldReader { idx_reader, values }
+        values_file: FileSlice,
+    ) -> crate::Result<BytesFastFieldReader> {
+        let values = values_file.read_bytes()?;
+        Ok(BytesFastFieldReader { idx_reader, values })
     }
 
     fn range(&self, doc: DocId) -> (usize, usize) {
@@ -38,7 +37,7 @@ impl BytesFastFieldReader {
     /// Returns the bytes associated to the given `doc`
     pub fn get_bytes(&self, doc: DocId) -> &[u8] {
         let (start, stop) = self.range(doc);
-        &self.values[start..stop]
+        &self.values.as_slice()[start..stop]
     }
 
     /// Returns the overall number of bytes in this bytes fast field.

src/fastfield/bytes/writer.rs

@@ -49,16 +49,10 @@ impl BytesFastFieldWriter {
     /// matching field values present in the document.
     pub fn add_document(&mut self, doc: &Document) {
         self.next_doc();
-        for field_value in doc.field_values() {
-            if field_value.field() == self.field {
-                if let Value::Bytes(ref bytes) = *field_value.value() {
-                    self.vals.extend_from_slice(bytes);
-                } else {
-                    panic!(
-                        "Bytes field contained non-Bytes Value!. Field {:?} = {:?}",
-                        self.field, field_value
-                    );
-                }
+        for field_value in doc.get_all(self.field) {
+            if let Value::Bytes(ref bytes) = field_value {
+                self.vals.extend_from_slice(bytes);
+                return;
             }
         }
     }
@@ -76,21 +70,18 @@ impl BytesFastFieldWriter {
 
     /// Serializes the fast field values by pushing them to the `FastFieldSerializer`.
     pub fn serialize(&self, serializer: &mut FastFieldSerializer) -> io::Result<()> {
-        {
-            // writing the offset index
-            let mut doc_index_serializer =
-                serializer.new_u64_fast_field_with_idx(self.field, 0, self.vals.len() as u64, 0)?;
-            for &offset in &self.doc_index {
-                doc_index_serializer.add_val(offset)?;
-            }
-            doc_index_serializer.add_val(self.vals.len() as u64)?;
-            doc_index_serializer.close_field()?;
-        }
-        {
-            // writing the values themselves
-            let mut value_serializer = serializer.new_bytes_fast_field_with_idx(self.field, 1)?;
-            value_serializer.write_all(&self.vals)?;
+        // writing the offset index
+        let mut doc_index_serializer =
+            serializer.new_u64_fast_field_with_idx(self.field, 0, self.vals.len() as u64, 0)?;
+        for &offset in &self.doc_index {
+            doc_index_serializer.add_val(offset)?;
         }
+        doc_index_serializer.add_val(self.vals.len() as u64)?;
+        doc_index_serializer.close_field()?;
+        // writing the values themselves
+        serializer
+            .new_bytes_fast_field_with_idx(self.field, 1)
+            .write_all(&self.vals)?;
         Ok(())
     }
 }

src/fastfield/delete.rs

@@ -1,5 +1,6 @@
 use crate::common::{BitSet, HasLen};
-use crate::directory::ReadOnlySource;
+use crate::directory::FileSlice;
+use crate::directory::OwnedBytes;
 use crate::directory::WritePtr;
 use crate::space_usage::ByteCount;
 use crate::DocId;
@@ -9,6 +10,8 @@ use std::io::Write;
 /// Write a delete `BitSet`
 ///
 /// where `delete_bitset` is the set of deleted `DocId`.
+/// Warning: this function does not call terminate. The caller is in charge of
+/// closing the writer properly.
 pub fn write_delete_bitset(
     delete_bitset: &BitSet,
     max_doc: u32,
@@ -37,22 +40,41 @@ pub fn write_delete_bitset(
 /// Set of deleted `DocId`s.
 #[derive(Clone)]
 pub struct DeleteBitSet {
-    data: ReadOnlySource,
+    data: OwnedBytes,
     len: usize,
 }
 
 impl DeleteBitSet {
-    /// Opens a delete bitset given its data source.
-    pub fn open(data: ReadOnlySource) -> DeleteBitSet {
-        let num_deleted: usize = data
+    #[cfg(test)]
+    pub(crate) fn for_test(docs: &[DocId], max_doc: u32) -> DeleteBitSet {
+        use crate::directory::{Directory, RAMDirectory, TerminatingWrite};
+        use std::path::Path;
+        assert!(docs.iter().all(|&doc| doc < max_doc));
+        let mut bitset = BitSet::with_max_value(max_doc);
+        for &doc in docs {
+            bitset.insert(doc);
+        }
+        let directory = RAMDirectory::create();
+        let path = Path::new("dummydeletebitset");
+        let mut wrt = directory.open_write(path).unwrap();
+        write_delete_bitset(&bitset, max_doc, &mut wrt).unwrap();
+        wrt.terminate().unwrap();
+        let file = directory.open_read(path).unwrap();
+        Self::open(file).unwrap()
+    }
+
+    /// Opens a delete bitset given its file.
+    pub fn open(file: FileSlice) -> crate::Result<DeleteBitSet> {
+        let bytes = file.read_bytes()?;
+        let num_deleted: usize = bytes
             .as_slice()
             .iter()
             .map(|b| b.count_ones() as usize)
             .sum();
-        DeleteBitSet {
-            data,
+        Ok(DeleteBitSet {
+            data: bytes,
             len: num_deleted,
-        }
+        })
     }
 
     /// Returns true iff the document is still "alive". In other words, if it has not been deleted.
@@ -64,7 +86,7 @@ impl DeleteBitSet {
     #[inline(always)]
     pub fn is_deleted(&self, doc: DocId) -> bool {
         let byte_offset = doc / 8u32;
-        let b: u8 = (*self.data)[byte_offset as usize];
+        let b: u8 = self.data.as_slice()[byte_offset as usize];
         let shift = (doc & 7u32) as u8;
         b & (1u8 << shift) != 0
     }
@@ -83,42 +105,35 @@ impl HasLen for DeleteBitSet {
 
 #[cfg(test)]
 mod tests {
-    use super::*;
-    use crate::directory::*;
-    use std::path::PathBuf;
+    use super::DeleteBitSet;
+    use crate::common::HasLen;
 
-    fn test_delete_bitset_helper(bitset: &BitSet, max_doc: u32) {
-        let test_path = PathBuf::from("test");
-        let mut directory = RAMDirectory::default();
-        {
-            let mut writer = directory.open_write(&*test_path).unwrap();
-            write_delete_bitset(bitset, max_doc, &mut writer).unwrap();
-            writer.terminate().unwrap();
+    #[test]
+    fn test_delete_bitset_empty() {
+        let delete_bitset = DeleteBitSet::for_test(&[], 10);
+        for doc in 0..10 {
+            assert_eq!(delete_bitset.is_deleted(doc), !delete_bitset.is_alive(doc));
         }
-        let source = directory.open_read(&test_path).unwrap();
-        let delete_bitset = DeleteBitSet::open(source);
-        for doc in 0..max_doc {
-            assert_eq!(bitset.contains(doc), delete_bitset.is_deleted(doc as DocId));
-        }
-        assert_eq!(delete_bitset.len(), bitset.len());
+        assert_eq!(delete_bitset.len(), 0);
     }
 
     #[test]
     fn test_delete_bitset() {
-        {
-            let mut bitset = BitSet::with_max_value(10);
-            bitset.insert(1);
-            bitset.insert(9);
-            test_delete_bitset_helper(&bitset, 10);
-        }
-        {
-            let mut bitset = BitSet::with_max_value(8);
-            bitset.insert(1);
-            bitset.insert(2);
-            bitset.insert(3);
-            bitset.insert(5);
-            bitset.insert(7);
-            test_delete_bitset_helper(&bitset, 8);
+        let delete_bitset = DeleteBitSet::for_test(&[1, 9], 10);
+        assert!(delete_bitset.is_alive(0));
+        assert!(delete_bitset.is_deleted(1));
+        assert!(delete_bitset.is_alive(2));
+        assert!(delete_bitset.is_alive(3));
+        assert!(delete_bitset.is_alive(4));
+        assert!(delete_bitset.is_alive(5));
+        assert!(delete_bitset.is_alive(6));
+        assert!(delete_bitset.is_alive(6));
+        assert!(delete_bitset.is_alive(7));
+        assert!(delete_bitset.is_alive(8));
+        assert!(delete_bitset.is_deleted(9));
+        for doc in 0..10 {
+            assert_eq!(delete_bitset.is_deleted(doc), !delete_bitset.is_alive(doc));
         }
+        assert_eq!(delete_bitset.len(), 2);
     }
 }

src/fastfield/error.rs

@@ -4,8 +4,8 @@ use std::result;
 /// `FastFieldNotAvailableError` is returned when the
 /// user requested for a fast field reader, and the field was not
 /// defined in the schema as a fast field.
-#[derive(Debug, Fail)]
-#[fail(display = "Fast field not available: '{:?}'", field_name)]
+#[derive(Debug, Error)]
+#[error("Fast field not available: '{field_name:?}'")]
 pub struct FastFieldNotAvailableError {
     field_name: String,
 }

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,18 +63,166 @@ 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(())
     }
 
     /// Return the list of facet ordinals associated to a document.
-    pub fn facet_ords(&mut self, doc: DocId, output: &mut Vec<u64>) {
+    pub fn facet_ords(&self, doc: DocId, output: &mut Vec<u64>) {
         self.term_ords.get_vals(doc, output);
     }
 }
+
+#[cfg(test)]
+mod tests {
+    use crate::Index;
+    use crate::{
+        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::new(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::new(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::new(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::new(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", 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.add_document(Document::default());
+        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]);
+        facet_reader.facet_ords(1u32, &mut facet_ords);
+        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", 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(Document::default());
+        index_writer.add_document(Document::default());
+        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());
+        facet_reader.facet_ords(1u32, &mut facet_ords);
+        assert!(facet_ords.is_empty());
+        Ok(())
+    }
+}

src/fastfield/mod.rs

@@ -28,16 +28,19 @@ 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;
 pub use self::writer::{FastFieldsWriter, IntFastFieldWriter};
-use crate::chrono::{NaiveDateTime, Utc};
 use crate::common;
 use crate::schema::Cardinality;
 use crate::schema::FieldType;
 use crate::schema::Value;
+use crate::{
+    chrono::{NaiveDateTime, Utc},
+    schema::Type,
+};
 
 mod bytes;
 mod delete;
@@ -50,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.
@@ -76,6 +79,9 @@ pub trait FastValue: Clone + Copy + Send + Sync + PartialOrd {
     fn make_zero() -> Self {
         Self::from_u64(0i64.to_u64())
     }
+
+    /// Returns the `schema::Type` for this FastValue.
+    fn to_type() -> Type;
 }
 
 impl FastValue for u64 {
@@ -90,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,
         }
     }
@@ -98,6 +104,10 @@ impl FastValue for u64 {
     fn as_u64(&self) -> u64 {
         *self
     }
+
+    fn to_type() -> Type {
+        Type::U64
+    }
 }
 
 impl FastValue for i64 {
@@ -119,6 +129,10 @@ impl FastValue for i64 {
     fn as_u64(&self) -> u64 {
         *self as u64
     }
+
+    fn to_type() -> Type {
+        Type::I64
+    }
 }
 
 impl FastValue for f64 {
@@ -140,6 +154,10 @@ impl FastValue for f64 {
     fn as_u64(&self) -> u64 {
         self.to_bits()
     }
+
+    fn to_type() -> Type {
+        Type::F64
+    }
 }
 
 impl FastValue for crate::DateTime {
@@ -162,6 +180,10 @@ impl FastValue for crate::DateTime {
     fn as_u64(&self) -> u64 {
         self.timestamp().as_u64()
     }
+
+    fn to_type() -> Type {
+        Type::Date
+    }
 }
 
 fn value_to_u64(value: &Value) -> u64 {
@@ -187,6 +209,7 @@ mod tests {
     use crate::schema::FAST;
     use crate::schema::{Document, IntOptions};
     use crate::{Index, SegmentId, SegmentReader};
+    use common::HasLen;
     use once_cell::sync::Lazy;
     use rand::prelude::SliceRandom;
     use rand::rngs::StdRng;
@@ -217,9 +240,9 @@ mod tests {
     }
 
     #[test]
-    fn test_intfastfield_small() {
+    fn test_intfastfield_small() -> crate::Result<()> {
         let path = Path::new("test");
-        let mut directory: RAMDirectory = RAMDirectory::create();
+        let directory: RAMDirectory = RAMDirectory::create();
         {
             let write: WritePtr = directory.open_write(Path::new("test")).unwrap();
             let mut serializer = FastFieldSerializer::from_write(write).unwrap();
@@ -232,27 +255,24 @@ mod tests {
                 .unwrap();
             serializer.close().unwrap();
         }
-        let source = directory.open_read(&path).unwrap();
-        {
-            assert_eq!(source.len(), 36 as usize);
-        }
-        {
-            let composite_file = CompositeFile::open(&source).unwrap();
-            let field_source = composite_file.open_read(*FIELD).unwrap();
-            let fast_field_reader = FastFieldReader::<u64>::open(field_source);
-            assert_eq!(fast_field_reader.get(0), 13u64);
-            assert_eq!(fast_field_reader.get(1), 14u64);
-            assert_eq!(fast_field_reader.get(2), 2u64);
-        }
+        let file = directory.open_read(&path).unwrap();
+        assert_eq!(file.len(), 36 as usize);
+        let composite_file = CompositeFile::open(&file)?;
+        let file = composite_file.open_read(*FIELD).unwrap();
+        let fast_field_reader = FastFieldReader::<u64>::open(file)?;
+        assert_eq!(fast_field_reader.get(0), 13u64);
+        assert_eq!(fast_field_reader.get(1), 14u64);
+        assert_eq!(fast_field_reader.get(2), 2u64);
+        Ok(())
     }
 
     #[test]
-    fn test_intfastfield_large() {
+    fn test_intfastfield_large() -> crate::Result<()> {
         let path = Path::new("test");
-        let mut directory: RAMDirectory = RAMDirectory::create();
+        let directory: RAMDirectory = RAMDirectory::create();
         {
-            let write: WritePtr = directory.open_write(Path::new("test")).unwrap();
-            let mut serializer = FastFieldSerializer::from_write(write).unwrap();
+            let write: WritePtr = directory.open_write(Path::new("test"))?;
+            let mut serializer = FastFieldSerializer::from_write(write)?;
             let mut fast_field_writers = FastFieldsWriter::from_schema(&SCHEMA);
             fast_field_writers.add_document(&doc!(*FIELD=>4u64));
             fast_field_writers.add_document(&doc!(*FIELD=>14_082_001u64));
@@ -263,19 +283,15 @@ mod tests {
             fast_field_writers.add_document(&doc!(*FIELD=>1_002u64));
             fast_field_writers.add_document(&doc!(*FIELD=>1_501u64));
             fast_field_writers.add_document(&doc!(*FIELD=>215u64));
-            fast_field_writers
-                .serialize(&mut serializer, &HashMap::new())
-                .unwrap();
-            serializer.close().unwrap();
+            fast_field_writers.serialize(&mut serializer, &HashMap::new())?;
+            serializer.close()?;
         }
-        let source = directory.open_read(&path).unwrap();
+        let file = directory.open_read(&path)?;
+        assert_eq!(file.len(), 61 as usize);
         {
-            assert_eq!(source.len(), 61 as usize);
-        }
-        {
-            let fast_fields_composite = CompositeFile::open(&source).unwrap();
+            let fast_fields_composite = CompositeFile::open(&file)?;
             let data = fast_fields_composite.open_read(*FIELD).unwrap();
-            let fast_field_reader = FastFieldReader::<u64>::open(data);
+            let fast_field_reader = FastFieldReader::<u64>::open(data)?;
             assert_eq!(fast_field_reader.get(0), 4u64);
             assert_eq!(fast_field_reader.get(1), 14_082_001u64);
             assert_eq!(fast_field_reader.get(2), 3_052u64);
@@ -286,12 +302,13 @@ mod tests {
             assert_eq!(fast_field_reader.get(7), 1_501u64);
             assert_eq!(fast_field_reader.get(8), 215u64);
         }
+        Ok(())
     }
 
     #[test]
-    fn test_intfastfield_null_amplitude() {
+    fn test_intfastfield_null_amplitude() -> crate::Result<()> {
         let path = Path::new("test");
-        let mut directory: RAMDirectory = RAMDirectory::create();
+        let directory: RAMDirectory = RAMDirectory::create();
 
         {
             let write: WritePtr = directory.open_write(Path::new("test")).unwrap();
@@ -305,24 +322,23 @@ mod tests {
                 .unwrap();
             serializer.close().unwrap();
         }
-        let source = directory.open_read(&path).unwrap();
+        let file = directory.open_read(&path).unwrap();
+        assert_eq!(file.len(), 34 as usize);
         {
-            assert_eq!(source.len(), 34 as usize);
-        }
-        {
-            let fast_fields_composite = CompositeFile::open(&source).unwrap();
+            let fast_fields_composite = CompositeFile::open(&file).unwrap();
             let data = fast_fields_composite.open_read(*FIELD).unwrap();
-            let fast_field_reader = FastFieldReader::<u64>::open(data);
+            let fast_field_reader = FastFieldReader::<u64>::open(data)?;
             for doc in 0..10_000 {
                 assert_eq!(fast_field_reader.get(doc), 100_000u64);
             }
         }
+        Ok(())
     }
 
     #[test]
-    fn test_intfastfield_large_numbers() {
+    fn test_intfastfield_large_numbers() -> crate::Result<()> {
         let path = Path::new("test");
-        let mut directory: RAMDirectory = RAMDirectory::create();
+        let directory: RAMDirectory = RAMDirectory::create();
 
         {
             let write: WritePtr = directory.open_write(Path::new("test")).unwrap();
@@ -338,14 +354,12 @@ mod tests {
                 .unwrap();
             serializer.close().unwrap();
         }
-        let source = directory.open_read(&path).unwrap();
+        let file = directory.open_read(&path).unwrap();
+        assert_eq!(file.len(), 80042 as usize);
         {
-            assert_eq!(source.len(), 80042 as usize);
-        }
-        {
-            let fast_fields_composite = CompositeFile::open(&source).unwrap();
+            let fast_fields_composite = CompositeFile::open(&file)?;
             let data = fast_fields_composite.open_read(*FIELD).unwrap();
-            let fast_field_reader = FastFieldReader::<u64>::open(data);
+            let fast_field_reader = FastFieldReader::<u64>::open(data)?;
             assert_eq!(fast_field_reader.get(0), 0u64);
             for doc in 1..10_001 {
                 assert_eq!(
@@ -354,12 +368,13 @@ mod tests {
                 );
             }
         }
+        Ok(())
     }
 
     #[test]
-    fn test_signed_intfastfield() {
+    fn test_signed_intfastfield() -> crate::Result<()> {
         let path = Path::new("test");
-        let mut directory: RAMDirectory = RAMDirectory::create();
+        let directory: RAMDirectory = RAMDirectory::create();
         let mut schema_builder = Schema::builder();
 
         let i64_field = schema_builder.add_i64_field("field", FAST);
@@ -378,14 +393,12 @@ mod tests {
                 .unwrap();
             serializer.close().unwrap();
         }
-        let source = directory.open_read(&path).unwrap();
+        let file = directory.open_read(&path).unwrap();
+        assert_eq!(file.len(), 17709 as usize);
         {
-            assert_eq!(source.len(), 17709 as usize);
-        }
-        {
-            let fast_fields_composite = CompositeFile::open(&source).unwrap();
+            let fast_fields_composite = CompositeFile::open(&file)?;
             let data = fast_fields_composite.open_read(i64_field).unwrap();
-            let fast_field_reader = FastFieldReader::<i64>::open(data);
+            let fast_field_reader = FastFieldReader::<i64>::open(data)?;
 
             assert_eq!(fast_field_reader.min_value(), -100i64);
             assert_eq!(fast_field_reader.max_value(), 9_999i64);
@@ -398,12 +411,13 @@ mod tests {
                 assert_eq!(buffer[i], -100i64 + 53i64 + i as i64);
             }
         }
+        Ok(())
     }
 
     #[test]
-    fn test_signed_intfastfield_default_val() {
+    fn test_signed_intfastfield_default_val() -> crate::Result<()> {
         let path = Path::new("test");
-        let mut directory: RAMDirectory = RAMDirectory::create();
+        let directory: RAMDirectory = RAMDirectory::create();
         let mut schema_builder = Schema::builder();
         let i64_field = schema_builder.add_i64_field("field", FAST);
         let schema = schema_builder.build();
@@ -420,13 +434,14 @@ mod tests {
             serializer.close().unwrap();
         }
 
-        let source = directory.open_read(&path).unwrap();
+        let file = directory.open_read(&path).unwrap();
         {
-            let fast_fields_composite = CompositeFile::open(&source).unwrap();
+            let fast_fields_composite = CompositeFile::open(&file).unwrap();
             let data = fast_fields_composite.open_read(i64_field).unwrap();
-            let fast_field_reader = FastFieldReader::<i64>::open(data);
+            let fast_field_reader = FastFieldReader::<i64>::open(data)?;
             assert_eq!(fast_field_reader.get(0u32), 0i64);
         }
+        Ok(())
     }
 
     // Warning: this generates the same permutation at each call
@@ -437,28 +452,26 @@ mod tests {
     }
 
     #[test]
-    fn test_intfastfield_permutation() {
+    fn test_intfastfield_permutation() -> crate::Result<()> {
         let path = Path::new("test");
         let permutation = generate_permutation();
         let n = permutation.len();
-        let mut directory = RAMDirectory::create();
+        let directory = RAMDirectory::create();
         {
-            let write: WritePtr = directory.open_write(Path::new("test")).unwrap();
-            let mut serializer = FastFieldSerializer::from_write(write).unwrap();
+            let write: WritePtr = directory.open_write(Path::new("test"))?;
+            let mut serializer = FastFieldSerializer::from_write(write)?;
             let mut fast_field_writers = FastFieldsWriter::from_schema(&SCHEMA);
             for &x in &permutation {
                 fast_field_writers.add_document(&doc!(*FIELD=>x));
             }
-            fast_field_writers
-                .serialize(&mut serializer, &HashMap::new())
-                .unwrap();
-            serializer.close().unwrap();
+            fast_field_writers.serialize(&mut serializer, &HashMap::new())?;
+            serializer.close()?;
         }
-        let source = directory.open_read(&path).unwrap();
+        let file = directory.open_read(&path)?;
         {
-            let fast_fields_composite = CompositeFile::open(&source).unwrap();
+            let fast_fields_composite = CompositeFile::open(&file)?;
             let data = fast_fields_composite.open_read(*FIELD).unwrap();
-            let fast_field_reader = FastFieldReader::<u64>::open(data);
+            let fast_field_reader = FastFieldReader::<u64>::open(data)?;
 
             let mut a = 0u64;
             for _ in 0..n {
@@ -466,6 +479,7 @@ mod tests {
                 a = fast_field_reader.get(a as u32);
             }
         }
+        Ok(())
     }
 
     #[test]
@@ -474,7 +488,7 @@ mod tests {
         let date_field = 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, 3_000_000).unwrap();
+        let mut index_writer = index.writer_for_tests().unwrap();
         index_writer.set_merge_policy(Box::new(NoMergePolicy));
         index_writer.add_document(doc!(date_field =>crate::chrono::prelude::Utc::now()));
         index_writer.commit().unwrap();
@@ -511,7 +525,7 @@ mod tests {
         );
         let schema = schema_builder.build();
         let index = Index::create_in_ram(schema);
-        let mut index_writer = index.writer_with_num_threads(1, 3_000_000).unwrap();
+        let mut index_writer = index.writer_for_tests().unwrap();
         index_writer.set_merge_policy(Box::new(NoMergePolicy));
         index_writer.add_document(doc!(
             date_field => crate::DateTime::from_u64(1i64.to_u64()),
@@ -598,7 +612,7 @@ mod bench {
     fn bench_intfastfield_linear_fflookup(b: &mut Bencher) {
         let path = Path::new("test");
         let permutation = generate_permutation();
-        let mut directory: RAMDirectory = RAMDirectory::create();
+        let directory: RAMDirectory = RAMDirectory::create();
         {
             let write: WritePtr = directory.open_write(Path::new("test")).unwrap();
             let mut serializer = FastFieldSerializer::from_write(write).unwrap();
@@ -611,11 +625,11 @@ mod bench {
                 .unwrap();
             serializer.close().unwrap();
         }
-        let source = directory.open_read(&path).unwrap();
+        let file = directory.open_read(&path).unwrap();
         {
-            let fast_fields_composite = CompositeFile::open(&source).unwrap();
+            let fast_fields_composite = CompositeFile::open(&file).unwrap();
             let data = fast_fields_composite.open_read(*FIELD).unwrap();
-            let fast_field_reader = FastFieldReader::<u64>::open(data);
+            let fast_field_reader = FastFieldReader::<u64>::open(data).unwrap();
 
             b.iter(|| {
                 let n = test::black_box(7000u32);
@@ -632,7 +646,7 @@ mod bench {
     fn bench_intfastfield_fflookup(b: &mut Bencher) {
         let path = Path::new("test");
         let permutation = generate_permutation();
-        let mut directory: RAMDirectory = RAMDirectory::create();
+        let directory: RAMDirectory = RAMDirectory::create();
         {
             let write: WritePtr = directory.open_write(Path::new("test")).unwrap();
             let mut serializer = FastFieldSerializer::from_write(write).unwrap();
@@ -645,11 +659,11 @@ mod bench {
                 .unwrap();
             serializer.close().unwrap();
         }
-        let source = directory.open_read(&path).unwrap();
+        let file = directory.open_read(&path).unwrap();
         {
-            let fast_fields_composite = CompositeFile::open(&source).unwrap();
+            let fast_fields_composite = CompositeFile::open(&file).unwrap();
             let data = fast_fields_composite.open_read(*FIELD).unwrap();
-            let fast_field_reader = FastFieldReader::<u64>::open(data);
+            let fast_field_reader = FastFieldReader::<u64>::open(data).unwrap();
 
             b.iter(|| {
                 let n = test::black_box(1000u32);

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;
 
@@ -25,7 +26,7 @@ mod tests {
         );
         let schema = schema_builder.build();
         let index = Index::create_in_ram(schema);
-        let mut index_writer = index.writer_with_num_threads(1, 3_000_000).unwrap();
+        let mut index_writer = index.writer_for_tests().unwrap();
         index_writer.add_document(doc!(field=>1u64, field=>3u64));
         index_writer.add_document(doc!());
         index_writer.add_document(doc!(field=>4u64));
@@ -64,7 +65,7 @@ mod tests {
             schema_builder.add_i64_field("time_stamp_i", IntOptions::default().set_stored());
         let schema = schema_builder.build();
         let index = Index::create_in_ram(schema);
-        let mut index_writer = index.writer_with_num_threads(1, 3_000_000).unwrap();
+        let mut index_writer = index.writer_for_tests().unwrap();
         let first_time_stamp = chrono::Utc::now();
         index_writer.add_document(
             doc!(date_field=>first_time_stamp, date_field=>first_time_stamp, time_i=>1i64),
@@ -100,6 +101,7 @@ mod tests {
                         .get_first(date_field)
                         .expect("cannot find value")
                         .date_value()
+                        .unwrap()
                         .timestamp(),
                     first_time_stamp.timestamp()
                 );
@@ -108,7 +110,7 @@ mod tests {
                         .get_first(time_i)
                         .expect("cannot find value")
                         .i64_value(),
-                    1i64
+                    Some(1i64)
                 );
             }
         }
@@ -131,6 +133,7 @@ mod tests {
                         .get_first(date_field)
                         .expect("cannot find value")
                         .date_value()
+                        .unwrap()
                         .timestamp(),
                     two_secs_ahead.timestamp()
                 );
@@ -139,42 +142,55 @@ mod tests {
                         .get_first(time_i)
                         .expect("cannot find value")
                         .i64_value(),
-                    3i64
+                    Some(3i64)
                 );
             }
         }
 
-        // TODO: support Date range queries
-        //        {
-        //            let parser = QueryParser::for_index(&index, vec![date_field]);
-        //            let range_q = format!("\"{}\"..\"{}\"",
-        //                                  (first_time_stamp + Duration::seconds(1)).to_rfc3339(),
-        //                                  (first_time_stamp + Duration::seconds(3)).to_rfc3339()
-        //            );
-        //            let query = parser.parse_query(&range_q)
-        //                .expect("could not parse query");
-        //            let results = searcher.search(&query, &TopDocs::with_limit(5))
-        //                .expect("could not query index");
-        //
-        //
-        //            assert_eq!(results.len(), 2);
-        //            for (i, doc_pair) in results.iter().enumerate() {
-        //                let retrieved_doc = searcher.doc(doc_pair.1).expect("cannot fetch doc");
-        //                let offset_sec = match i {
-        //                    0 => 1,
-        //                    1 => 3,
-        //                    _ => panic!("should not have more than 2 docs")
-        //                };
-        //                let time_i_val = match i {
-        //                    0 => 2,
-        //                    1 => 3,
-        //                    _ => panic!("should not have more than 2 docs")
-        //                };
-        //                assert_eq!(retrieved_doc.get_first(date_field).expect("cannot find value").date_value().timestamp(),
-        //                           (first_time_stamp + Duration::seconds(offset_sec)).timestamp());
-        //                assert_eq!(retrieved_doc.get_first(time_i).expect("cannot find value").i64_value(), time_i_val);
-        //            }
-        //        }
+        {
+            let parser = QueryParser::for_index(&index, vec![date_field]);
+            let range_q = format!(
+                "[{} TO {}]",
+                (first_time_stamp + Duration::seconds(1)).to_rfc3339(),
+                (first_time_stamp + Duration::seconds(3)).to_rfc3339()
+            );
+            let query = parser.parse_query(&range_q).expect("could not parse query");
+            let results = searcher
+                .search(&query, &TopDocs::with_limit(5))
+                .expect("could not query index");
+
+            assert_eq!(results.len(), 2);
+            for (i, doc_pair) in results.iter().enumerate() {
+                let retrieved_doc = searcher.doc(doc_pair.1).expect("cannot fetch doc");
+                let offset_sec = match i {
+                    0 => 1,
+                    1 => 2,
+                    _ => panic!("should not have more than 2 docs"),
+                };
+                let time_i_val = match i {
+                    0 => 2,
+                    1 => 3,
+                    _ => panic!("should not have more than 2 docs"),
+                };
+                assert_eq!(
+                    retrieved_doc
+                        .get_first(date_field)
+                        .expect("cannot find value")
+                        .date_value()
+                        .expect("value not of Date type")
+                        .timestamp(),
+                    (first_time_stamp + Duration::seconds(offset_sec)).timestamp()
+                );
+                assert_eq!(
+                    retrieved_doc
+                        .get_first(time_i)
+                        .expect("cannot find value")
+                        .i64_value()
+                        .expect("value not of i64 type"),
+                    time_i_val
+                );
+            }
+        }
     }
 
     #[test]
@@ -186,7 +202,7 @@ mod tests {
         );
         let schema = schema_builder.build();
         let index = Index::create_in_ram(schema);
-        let mut index_writer = index.writer_with_num_threads(1, 3_000_000).unwrap();
+        let mut index_writer = index.writer_for_tests().unwrap();
         index_writer.add_document(doc!(field=> 1i64, field => 3i64));
         index_writer.add_document(doc!());
         index_writer.add_document(doc!(field=> -4i64));
@@ -197,31 +213,23 @@ mod tests {
         let segment_reader = searcher.segment_reader(0);
         let mut vals = Vec::new();
         let multi_value_reader = segment_reader.fast_fields().i64s(field).unwrap();
-        {
-            multi_value_reader.get_vals(2, &mut vals);
-            assert_eq!(&vals, &[-4i64]);
-        }
-        {
-            multi_value_reader.get_vals(0, &mut vals);
-            assert_eq!(&vals, &[1i64, 3i64]);
-        }
-        {
-            multi_value_reader.get_vals(1, &mut vals);
-            assert!(vals.is_empty());
-        }
-        {
-            multi_value_reader.get_vals(3, &mut vals);
-            assert_eq!(&vals, &[-5i64, -20i64, 1i64]);
-        }
+        multi_value_reader.get_vals(2, &mut vals);
+        assert_eq!(&vals, &[-4i64]);
+        multi_value_reader.get_vals(0, &mut vals);
+        assert_eq!(&vals, &[1i64, 3i64]);
+        multi_value_reader.get_vals(1, &mut vals);
+        assert!(vals.is_empty());
+        multi_value_reader.get_vals(3, &mut vals);
+        assert_eq!(&vals, &[-5i64, -20i64, 1i64]);
     }
     #[test]
     #[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_with_num_threads(1, 3_000_000).unwrap();
+        let mut index_writer = index.writer_for_tests().unwrap();
         for i in 0..100_000 {
             index_writer.add_document(doc!(field=> Facet::from(format!("/lang/{}", i).as_str())));
         }

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,16 +60,16 @@ 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
-            .writer_with_num_threads(1, 30_000_000)
+            .writer_for_tests()
             .expect("Failed to create index writer.");
         index_writer.add_document(doc!(
             facet_field => Facet::from("/category/cat2"),

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,25 +126,22 @@ 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);
-                        doc_vals.sort();
+                        doc_vals.sort_unstable();
                         for &val in &doc_vals {
                             value_serializer.add_val(val)?;
                         }

src/fastfield/reader.rs

@@ -3,13 +3,12 @@ use crate::common::bitpacker::BitUnpacker;
 use crate::common::compute_num_bits;
 use crate::common::BinarySerializable;
 use crate::common::CompositeFile;
-use crate::directory::ReadOnlySource;
+use crate::directory::FileSlice;
 use crate::directory::{Directory, RAMDirectory, WritePtr};
 use crate::fastfield::{FastFieldSerializer, FastFieldsWriter};
 use crate::schema::Schema;
 use crate::schema::FAST;
 use crate::DocId;
-use owning_ref::OwningRef;
 use std::collections::HashMap;
 use std::marker::PhantomData;
 use std::path::Path;
@@ -20,43 +19,27 @@ use std::path::Path;
 /// fast field is required.
 #[derive(Clone)]
 pub struct FastFieldReader<Item: FastValue> {
-    bit_unpacker: BitUnpacker<OwningRef<ReadOnlySource, [u8]>>,
+    bit_unpacker: BitUnpacker,
     min_value_u64: u64,
     max_value_u64: u64,
     _phantom: PhantomData<Item>,
 }
 
 impl<Item: FastValue> FastFieldReader<Item> {
-    /// Opens a fast field given a source.
-    pub fn open(data: ReadOnlySource) -> Self {
-        let min_value: u64;
-        let amplitude: u64;
-        {
-            let mut cursor = data.as_slice();
-            min_value =
-                u64::deserialize(&mut cursor).expect("Failed to read the min_value of fast field.");
-            amplitude =
-                u64::deserialize(&mut cursor).expect("Failed to read the amplitude of fast field.");
-        }
+    /// Opens a fast field given a file.
+    pub fn open(file: FileSlice) -> crate::Result<Self> {
+        let mut bytes = file.read_bytes()?;
+        let min_value = u64::deserialize(&mut bytes)?;
+        let amplitude = u64::deserialize(&mut bytes)?;
         let max_value = min_value + amplitude;
         let num_bits = compute_num_bits(amplitude);
-        let owning_ref = OwningRef::new(data).map(|data| &data[16..]);
-        let bit_unpacker = BitUnpacker::new(owning_ref, num_bits);
-        FastFieldReader {
+        let bit_unpacker = BitUnpacker::new(bytes, num_bits);
+        Ok(FastFieldReader {
             min_value_u64: min_value,
             max_value_u64: max_value,
             bit_unpacker,
             _phantom: PhantomData,
-        }
-    }
-
-    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.
@@ -135,7 +118,7 @@ impl<Item: FastValue> From<Vec<Item>> for FastFieldReader<Item> {
         let field = schema_builder.add_u64_field("field", FAST);
         let schema = schema_builder.build();
         let path = Path::new("__dummy__");
-        let mut directory: RAMDirectory = RAMDirectory::create();
+        let directory: RAMDirectory = RAMDirectory::create();
         {
             let write: WritePtr = directory
                 .open_write(path)
@@ -157,12 +140,11 @@ impl<Item: FastValue> From<Vec<Item>> for FastFieldReader<Item> {
             serializer.close().unwrap();
         }
 
-        let source = directory.open_read(path).expect("Failed to open the file");
-        let composite_file =
-            CompositeFile::open(&source).expect("Failed to read the composite file");
-        let field_source = composite_file
+        let file = directory.open_read(path).expect("Failed to open the file");
+        let composite_file = CompositeFile::open(&file).expect("Failed to read the composite file");
+        let field_file = composite_file
             .open_read(field)
             .expect("File component not found");
-        FastFieldReader::open(field_source)
+        FastFieldReader::open(field_file).unwrap()
     }
 }

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,227 +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 field_type == &FieldType::Bytes {
-                let idx_reader = fast_fields_composite
-                    .open_read_with_idx(field, 0)
-                    .ok_or_else(|| FastFieldNotAvailableError::new(field_entry))
-                    .map(FastFieldReader::open)?;
-                let data = fast_fields_composite
-                    .open_read_with_idx(field, 1)
-                    .ok_or_else(|| FastFieldNotAvailableError::new(field_entry))?;
-                fast_field_readers
-                    .fast_bytes
-                    .insert(field, BytesFastFieldReader::open(idx_reader, data));
-            } 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 => {
-                                    fast_field_readers.fast_field_i64.insert(
-                                        field,
-                                        FastFieldReader::open(fast_field_data.clone()),
-                                    );
-                                }
-                                FastType::F64 => {
-                                    fast_field_readers.fast_field_f64.insert(
-                                        field,
-                                        FastFieldReader::open(fast_field_data.clone()),
-                                    );
-                                }
-                                FastType::Date => {
-                                    fast_field_readers.fast_field_date.insert(
-                                        field,
-                                        FastFieldReader::open(fast_field_data.clone()),
-                                    );
-                                }
-                            }
-                        } 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>,
 }
 
@@ -33,7 +33,7 @@ impl FastFieldsWriter {
         let mut bytes_value_writers = Vec::new();
 
         for (field, field_entry) in schema.fields() {
-            match *field_entry.field_type() {
+            match field_entry.field_type() {
                 FieldType::I64(ref int_options)
                 | FieldType::U64(ref int_options)
                 | FieldType::F64(ref int_options)
@@ -46,19 +46,21 @@ 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 => {
-                    let fast_field_writer = BytesFastFieldWriter::new(field);
-                    bytes_value_writers.push(fast_field_writer);
+                FieldType::Bytes(bytes_option) => {
+                    if bytes_option.is_fast() {
+                        let fast_field_writer = BytesFastFieldWriter::new(field);
+                        bytes_value_writers.push(fast_field_writer);
+                    }
                 }
                 _ => {}
             }
@@ -85,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()
@@ -126,6 +128,7 @@ impl FastFieldsWriter {
         for field_writer in &self.single_value_writers {
             field_writer.serialize(serializer)?;
         }
+
         for field_writer in &self.multi_values_writers {
             let field = field_writer.field();
             field_writer.serialize(serializer, mapping.get(&field))?;

src/fieldnorm/mod.rs

@@ -21,7 +21,7 @@ mod reader;
 mod serializer;
 mod writer;
 
-pub use self::reader::FieldNormReader;
+pub use self::reader::{FieldNormReader, FieldNormReaders};
 pub use self::serializer::FieldNormsSerializer;
 pub use self::writer::FieldNormsWriter;
 

src/fieldnorm/reader.rs

@@ -1,6 +1,47 @@
 use super::{fieldnorm_to_id, id_to_fieldnorm};
-use crate::directory::ReadOnlySource;
+use crate::common::CompositeFile;
+use crate::directory::FileSlice;
+use crate::directory::OwnedBytes;
+use crate::schema::Field;
+use crate::space_usage::PerFieldSpaceUsage;
 use crate::DocId;
+use std::sync::Arc;
+
+/// Reader for the fieldnorm (for each document, the number of tokens indexed in the
+/// field) of all indexed fields in the index.
+///
+/// Each fieldnorm is approximately compressed over one byte. We refer to this byte as
+/// `fieldnorm_id`.
+/// The mapping from `fieldnorm` to `fieldnorm_id` is given by monotonic.
+#[derive(Clone)]
+pub struct FieldNormReaders {
+    data: Arc<CompositeFile>,
+}
+
+impl FieldNormReaders {
+    /// Creates a field norm reader.
+    pub fn open(file: FileSlice) -> crate::Result<FieldNormReaders> {
+        let data = CompositeFile::open(&file)?;
+        Ok(FieldNormReaders {
+            data: Arc::new(data),
+        })
+    }
+
+    /// Returns the FieldNormReader for a specific field.
+    pub fn get_field(&self, field: Field) -> crate::Result<Option<FieldNormReader>> {
+        if let Some(file) = self.data.open_read(field) {
+            let fieldnorm_reader = FieldNormReader::open(file)?;
+            Ok(Some(fieldnorm_reader))
+        } else {
+            Ok(None)
+        }
+    }
+
+    /// Return a break down of the space usage per field.
+    pub fn space_usage(&self) -> PerFieldSpaceUsage {
+        self.data.space_usage()
+    }
+}
 
 /// Reads the fieldnorm associated to a document.
 /// The fieldnorm represents the length associated to
@@ -19,14 +60,57 @@ use crate::DocId;
 /// Apart from compression, this scale also makes it possible to
 /// precompute computationally expensive functions of the fieldnorm
 /// in a very short array.
-pub struct FieldNormReader {
-    data: ReadOnlySource,
+#[derive(Clone)]
+pub struct FieldNormReader(ReaderImplEnum);
+
+impl From<ReaderImplEnum> for FieldNormReader {
+    fn from(reader_enum: ReaderImplEnum) -> FieldNormReader {
+        FieldNormReader(reader_enum)
+    }
+}
+
+#[derive(Clone)]
+enum ReaderImplEnum {
+    FromData(OwnedBytes),
+    Const {
+        num_docs: u32,
+        fieldnorm_id: u8,
+        fieldnorm: u32,
+    },
 }
 
 impl FieldNormReader {
-    /// Opens a field norm reader given its data source.
-    pub fn open(data: ReadOnlySource) -> Self {
-        FieldNormReader { data }
+    /// Creates a `FieldNormReader` with a constant fieldnorm.
+    ///
+    /// The fieldnorm will be subjected to compression as if it was coming
+    /// from an array-backed fieldnorm reader.
+    pub fn constant(num_docs: u32, fieldnorm: u32) -> FieldNormReader {
+        let fieldnorm_id = fieldnorm_to_id(fieldnorm);
+        let fieldnorm = id_to_fieldnorm(fieldnorm_id);
+        ReaderImplEnum::Const {
+            num_docs,
+            fieldnorm_id,
+            fieldnorm,
+        }
+        .into()
+    }
+
+    /// Opens a field norm reader given its file.
+    pub fn open(fieldnorm_file: FileSlice) -> crate::Result<Self> {
+        let data = fieldnorm_file.read_bytes()?;
+        Ok(FieldNormReader::new(data))
+    }
+
+    fn new(data: OwnedBytes) -> Self {
+        ReaderImplEnum::FromData(data).into()
+    }
+
+    /// Returns the number of documents in this segment.
+    pub fn num_docs(&self) -> u32 {
+        match &self.0 {
+            ReaderImplEnum::FromData(data) => data.len() as u32,
+            ReaderImplEnum::Const { num_docs, .. } => *num_docs,
+        }
     }
 
     /// Returns the `fieldnorm` associated to a doc id.
@@ -39,15 +123,25 @@ impl FieldNormReader {
     /// The fieldnorm is effectively decoded from the
     /// `fieldnorm_id` by doing a simple table lookup.
     pub fn fieldnorm(&self, doc_id: DocId) -> u32 {
-        let fieldnorm_id = self.fieldnorm_id(doc_id);
-        id_to_fieldnorm(fieldnorm_id)
+        match &self.0 {
+            ReaderImplEnum::FromData(data) => {
+                let fieldnorm_id = data.as_slice()[doc_id as usize];
+                id_to_fieldnorm(fieldnorm_id)
+            }
+            ReaderImplEnum::Const { fieldnorm, .. } => *fieldnorm,
+        }
     }
 
     /// Returns the `fieldnorm_id` associated to a document.
     #[inline(always)]
     pub fn fieldnorm_id(&self, doc_id: DocId) -> u8 {
-        let fielnorms_data = self.data.as_slice();
-        fielnorms_data[doc_id as usize]
+        match &self.0 {
+            ReaderImplEnum::FromData(data) => {
+                let fieldnorm_id = data.as_slice()[doc_id as usize];
+                fieldnorm_id
+            }
+            ReaderImplEnum::Const { fieldnorm_id, .. } => *fieldnorm_id,
+        }
     }
 
     /// Converts a `fieldnorm_id` into a fieldnorm.
@@ -62,18 +156,48 @@ impl FieldNormReader {
     pub fn fieldnorm_to_id(fieldnorm: u32) -> u8 {
         fieldnorm_to_id(fieldnorm)
     }
+
+    #[cfg(test)]
+    pub fn for_test(field_norms: &[u32]) -> FieldNormReader {
+        let field_norms_id = field_norms
+            .iter()
+            .cloned()
+            .map(FieldNormReader::fieldnorm_to_id)
+            .collect::<Vec<u8>>();
+        let field_norms_data = OwnedBytes::new(field_norms_id);
+        FieldNormReader::new(field_norms_data)
+    }
 }
 
 #[cfg(test)]
-impl From<Vec<u32>> for FieldNormReader {
-    fn from(field_norms: Vec<u32>) -> FieldNormReader {
-        let field_norms_id = field_norms
-            .into_iter()
-            .map(FieldNormReader::fieldnorm_to_id)
-            .collect::<Vec<u8>>();
-        let field_norms_data = ReadOnlySource::from(field_norms_id);
-        FieldNormReader {
-            data: field_norms_data,
-        }
+mod tests {
+    use crate::fieldnorm::FieldNormReader;
+
+    #[test]
+    fn test_from_fieldnorms_array() {
+        let fieldnorms = &[1, 2, 3, 4, 1_000_000];
+        let fieldnorm_reader = FieldNormReader::for_test(fieldnorms);
+        assert_eq!(fieldnorm_reader.num_docs(), 5);
+        assert_eq!(fieldnorm_reader.fieldnorm(0), 1);
+        assert_eq!(fieldnorm_reader.fieldnorm(1), 2);
+        assert_eq!(fieldnorm_reader.fieldnorm(2), 3);
+        assert_eq!(fieldnorm_reader.fieldnorm(3), 4);
+        assert_eq!(fieldnorm_reader.fieldnorm(4), 983_064);
+    }
+
+    #[test]
+    fn test_const_fieldnorm_reader_small_fieldnorm_id() {
+        let fieldnorm_reader = FieldNormReader::constant(1_000_000u32, 10u32);
+        assert_eq!(fieldnorm_reader.num_docs(), 1_000_000u32);
+        assert_eq!(fieldnorm_reader.fieldnorm(0u32), 10u32);
+        assert_eq!(fieldnorm_reader.fieldnorm_id(0u32), 10u8);
+    }
+
+    #[test]
+    fn test_const_fieldnorm_reader_large_fieldnorm_id() {
+        let fieldnorm_reader = FieldNormReader::constant(1_000_000u32, 300u32);
+        assert_eq!(fieldnorm_reader.num_docs(), 1_000_000u32);
+        assert_eq!(fieldnorm_reader.fieldnorm(0u32), 280u32);
+        assert_eq!(fieldnorm_reader.fieldnorm_id(0u32), 72u8);
     }
 }

src/fieldnorm/writer.rs

@@ -4,7 +4,7 @@ use super::fieldnorm_to_id;
 use super::FieldNormsSerializer;
 use crate::schema::Field;
 use crate::schema::Schema;
-use std::io;
+use std::{io, iter};
 
 /// The `FieldNormsWriter` is in charge of tracking the fieldnorm byte
 /// of each document for each field with field norms.
@@ -44,7 +44,9 @@ impl FieldNormsWriter {
             .unwrap_or(0);
         FieldNormsWriter {
             fields,
-            fieldnorms_buffer: (0..max_field).map(|_| Vec::new()).collect::<Vec<_>>(),
+            fieldnorms_buffer: iter::repeat_with(Vec::new)
+                .take(max_field)
+                .collect::<Vec<_>>(),
         }
     }
 
@@ -78,11 +80,12 @@ impl FieldNormsWriter {
     }
 
     /// Serialize the seen fieldnorm values to the serializer for all fields.
-    pub fn serialize(&self, fieldnorms_serializer: &mut FieldNormsSerializer) -> io::Result<()> {
+    pub fn serialize(&self, mut fieldnorms_serializer: FieldNormsSerializer) -> io::Result<()> {
         for &field in self.fields.iter() {
             let fieldnorm_values: &[u8] = &self.fieldnorms_buffer[field.field_id() as usize][..];
             fieldnorms_serializer.serialize_field(field, fieldnorm_values)?;
         }
+        fieldnorms_serializer.close()?;
         Ok(())
     }
 }

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/delete_queue.rs

@@ -53,7 +53,7 @@ impl DeleteQueue {
             return block;
         }
         let block = Arc::new(Block {
-            operations: Arc::default(),
+            operations: Arc::new([]),
             next: NextBlock::from(self.clone()),
         });
         wlock.last_block = Arc::downgrade(&block);
@@ -108,7 +108,7 @@ impl DeleteQueue {
         let delete_operations = mem::replace(&mut self_wlock.writer, vec![]);
 
         let new_block = Arc::new(Block {
-            operations: Arc::new(delete_operations.into_boxed_slice()),
+            operations: Arc::from(delete_operations.into_boxed_slice()),
             next: NextBlock::from(self.clone()),
         });
 
@@ -167,7 +167,7 @@ impl NextBlock {
 }
 
 struct Block {
-    operations: Arc<Box<[DeleteOperation]>>,
+    operations: Arc<[DeleteOperation]>,
     next: NextBlock,
 }
 

src/indexer/index_writer.rs

@@ -8,26 +8,22 @@ use crate::core::SegmentComponent;
 use crate::core::SegmentId;
 use crate::core::SegmentMeta;
 use crate::core::SegmentReader;
+use crate::directory::TerminatingWrite;
 use crate::directory::{DirectoryLock, GarbageCollectionResult};
-use crate::directory::{TerminatingWrite, WatchCallbackList};
-use crate::docset::DocSet;
+use crate::docset::{DocSet, TERMINATED};
 use crate::error::TantivyError;
 use crate::fastfield::write_delete_bitset;
 use crate::indexer::delete_queue::{DeleteCursor, DeleteQueue};
 use crate::indexer::doc_opstamp_mapping::DocToOpstampMapping;
 use crate::indexer::operation::DeleteOperation;
-use crate::indexer::segment_manager::SegmentRegisters;
-use crate::indexer::segment_register::SegmentRegister;
 use crate::indexer::stamper::Stamper;
-use crate::indexer::{SegmentEntry, ResourceManager};
+use crate::indexer::MergePolicy;
+use crate::indexer::SegmentEntry;
 use crate::indexer::SegmentWriter;
-use crate::indexer::{IndexWriterConfig, MergePolicy};
-use crate::reader::NRTReader;
 use crate::schema::Document;
 use crate::schema::IndexRecordOption;
 use crate::schema::Term;
-use crate::tokenizer::TokenizerManager;
-use crate::{IndexReader, Opstamp};
+use crate::Opstamp;
 use crossbeam::channel;
 use futures::executor::block_on;
 use futures::future::Future;
@@ -35,10 +31,18 @@ use smallvec::smallvec;
 use smallvec::SmallVec;
 use std::mem;
 use std::ops::Range;
-use std::sync::{Arc, RwLock};
+use std::sync::Arc;
 use std::thread;
 use std::thread::JoinHandle;
 
+// Size of the margin for the heap. A segment is closed when the remaining memory
+// in the heap goes below MARGIN_IN_BYTES.
+pub const MARGIN_IN_BYTES: usize = 1_000_000;
+
+// We impose the memory per thread to be at least 3 MB.
+pub const HEAP_SIZE_MIN: usize = ((MARGIN_IN_BYTES as u32) * 3u32) as usize;
+pub const HEAP_SIZE_MAX: usize = u32::max_value() as usize - MARGIN_IN_BYTES;
+
 // Add document will block if the number of docs waiting in the queue to be indexed
 // reaches `PIPELINE_MAX_SIZE_IN_DOCS`
 const PIPELINE_MAX_SIZE_IN_DOCS: usize = 10_000;
@@ -65,9 +69,8 @@ pub struct IndexWriter {
     _directory_lock: Option<DirectoryLock>,
 
     index: Index,
-    config: IndexWriterConfig,
 
-    segment_registers: Arc<RwLock<SegmentRegisters>>,
+    heap_size_in_bytes_per_thread: usize,
 
     workers_join_handle: Vec<JoinHandle<crate::Result<()>>>,
 
@@ -77,14 +80,13 @@ pub struct IndexWriter {
     segment_updater: SegmentUpdater,
 
     worker_id: usize,
+
+    num_threads: usize,
+
     delete_queue: DeleteQueue,
 
     stamper: Stamper,
     committed_opstamp: Opstamp,
-
-    on_commit: WatchCallbackList,
-
-    memory_manager: ResourceManager,
 }
 
 fn compute_deleted_bitset(
@@ -106,19 +108,19 @@ fn compute_deleted_bitset(
         // Limit doc helps identify the first document
         // that may be affected by the delete operation.
         let limit_doc = doc_opstamps.compute_doc_limit(delete_op.opstamp);
-        let inverted_index = segment_reader.inverted_index(delete_op.term.field());
+        let inverted_index = segment_reader.inverted_index(delete_op.term.field())?;
         if let Some(mut docset) =
-            inverted_index.read_postings(&delete_op.term, IndexRecordOption::Basic)
+            inverted_index.read_postings(&delete_op.term, IndexRecordOption::Basic)?
         {
-            while docset.advance() {
-                let deleted_doc = docset.doc();
+            let mut deleted_doc = docset.doc();
+            while deleted_doc != TERMINATED {
                 if deleted_doc < limit_doc {
                     delete_bitset.insert(deleted_doc);
                     might_have_changed = true;
                 }
+                deleted_doc = docset.advance();
             }
         }
-
         delete_cursor.advance();
     }
     Ok(might_have_changed)
@@ -131,6 +133,7 @@ fn compute_deleted_bitset(
 /// For instance, there was no delete operation between the state of the `segment_entry` and
 /// the `target_opstamp`, `segment_entry` is not updated.
 pub(crate) fn advance_deletes(
+    mut segment: Segment,
     segment_entry: &mut SegmentEntry,
     target_opstamp: Opstamp,
 ) -> crate::Result<()> {
@@ -139,33 +142,25 @@ pub(crate) fn advance_deletes(
         return Ok(());
     }
 
-    let delete_bitset_opt = segment_entry.take_delete_bitset();
-
-    // We avoid directly advancing the `SegmentEntry` delete cursor, because
-    // we do not want to end up in an invalid state if the delete bitset
-    // serialization fails.
-    let mut delete_cursor = segment_entry.delete_cursor();
-
-    if delete_bitset_opt.is_none() && segment_entry.delete_cursor().get().is_none() {
+    if segment_entry.delete_bitset().is_none() && segment_entry.delete_cursor().get().is_none() {
         // There has been no `DeleteOperation` between the segment status and `target_opstamp`.
         return Ok(());
     }
 
-    // We open our current serialized segment to compute the new deleted bitset.
-    let segment = segment_entry.segment().clone();
     let segment_reader = SegmentReader::open(&segment)?;
 
     let max_doc = segment_reader.max_doc();
-
-    let mut delete_bitset: BitSet =
-        delete_bitset_opt.unwrap_or_else(|| BitSet::with_max_value(max_doc));
+    let mut delete_bitset: BitSet = match segment_entry.delete_bitset() {
+        Some(previous_delete_bitset) => (*previous_delete_bitset).clone(),
+        None => BitSet::with_max_value(max_doc),
+    };
 
     let num_deleted_docs_before = segment.meta().num_deleted_docs();
 
     compute_deleted_bitset(
         &mut delete_bitset,
         &segment_reader,
-        &mut delete_cursor,
+        segment_entry.delete_cursor(),
         &DocToOpstampMapping::None,
         target_opstamp,
     )?;
@@ -184,40 +179,32 @@ pub(crate) fn advance_deletes(
     let num_deleted_docs: u32 = delete_bitset.len() as u32;
     if num_deleted_docs > num_deleted_docs_before {
         // There are new deletes. We need to write a new delete file.
-        let mut delete_file = segment
-            .with_delete_meta(num_deleted_docs as u32, target_opstamp)
-            .open_write(SegmentComponent::DELETE)?;
+        segment = segment.with_delete_meta(num_deleted_docs as u32, target_opstamp);
+        let mut delete_file = segment.open_write(SegmentComponent::DELETE)?;
         write_delete_bitset(&delete_bitset, max_doc, &mut delete_file)?;
         delete_file.terminate()?;
-        segment_entry.reset_delete_meta(num_deleted_docs as u32, target_opstamp);
     }
 
-    // Regardless of whether we did end up having to write a new file or not
-    // we advance the `delete_cursor`. This is an optimisation. We want to ensure we do not
-    // check that a given deleted term does not match any of our docs more than once.
-    segment_entry.set_delete_cursor(delete_cursor);
+    segment_entry.set_meta(segment.meta().clone());
     Ok(())
 }
 
 fn index_documents(
-    config: IndexWriterConfig,
+    memory_budget: usize,
     segment: Segment,
     grouped_document_iterator: &mut dyn Iterator<Item = OperationGroup>,
     segment_updater: &mut SegmentUpdater,
-    tokenizers: &TokenizerManager,
     mut delete_cursor: DeleteCursor,
-    memory_manager: ResourceManager
 ) -> crate::Result<bool> {
     let schema = segment.schema();
 
-    let mut segment_writer = SegmentWriter::for_segment(
-        &config, segment, &schema, tokenizers, memory_manager)?;
+    let mut segment_writer = SegmentWriter::for_segment(memory_budget, segment.clone(), &schema)?;
     for document_group in grouped_document_iterator {
         for doc in document_group {
             segment_writer.add_document(doc, &schema)?;
         }
         let mem_usage = segment_writer.mem_usage();
-        if mem_usage >= config.heap_size_before_flushing() {
+        if mem_usage >= memory_budget - MARGIN_IN_BYTES {
             info!(
                 "Buffer limit reached, flushing segment with maxdoc={}.",
                 segment_writer.max_doc()
@@ -236,14 +223,24 @@ fn index_documents(
     // the worker thread.
     assert!(max_doc > 0);
 
-    let (segment, doc_opstamps): (Segment, Vec<Opstamp>) = segment_writer.finalize()?;
+    let doc_opstamps: Vec<Opstamp> = segment_writer.finalize()?;
+
+    let segment_with_max_doc = segment.with_max_doc(max_doc);
 
     let last_docstamp: Opstamp = *(doc_opstamps.last().unwrap());
 
-    let delete_bitset_opt =
-        apply_deletes(&segment, &mut delete_cursor, &doc_opstamps, last_docstamp)?;
+    let delete_bitset_opt = apply_deletes(
+        &segment_with_max_doc,
+        &mut delete_cursor,
+        &doc_opstamps,
+        last_docstamp,
+    )?;
 
-    let segment_entry = SegmentEntry::new(segment, delete_cursor, delete_bitset_opt);
+    let segment_entry = SegmentEntry::new(
+        segment_with_max_doc.meta().clone(),
+        delete_cursor,
+        delete_bitset_opt,
+    );
     block_on(segment_updater.schedule_add_segment(segment_entry))?;
     Ok(true)
 }
@@ -295,10 +292,21 @@ impl IndexWriter {
     /// If the heap size per thread is too small, panics.
     pub(crate) fn new(
         index: &Index,
-        mut config: IndexWriterConfig,
+        num_threads: usize,
+        heap_size_in_bytes_per_thread: usize,
         directory_lock: DirectoryLock,
     ) -> crate::Result<IndexWriter> {
-        config.validate()?;
+        if heap_size_in_bytes_per_thread < HEAP_SIZE_MIN {
+            let err_msg = format!(
+                "The heap size per thread needs to be at least {}.",
+                HEAP_SIZE_MIN
+            );
+            return Err(TantivyError::InvalidArgument(err_msg));
+        }
+        if heap_size_in_bytes_per_thread >= HEAP_SIZE_MAX {
+            let err_msg = format!("The heap size per thread cannot exceed {}", HEAP_SIZE_MAX);
+            return Err(TantivyError::InvalidArgument(err_msg));
+        }
         let (document_sender, document_receiver): (OperationSender, OperationReceiver) =
             channel::bounded(PIPELINE_MAX_SIZE_IN_DOCS);
 
@@ -306,26 +314,16 @@ impl IndexWriter {
 
         let current_opstamp = index.load_metas()?.opstamp;
 
-        let meta = index.load_metas()?;
-
         let stamper = Stamper::new(current_opstamp);
 
-        let commited_segments = SegmentRegister::new(
-            index.directory(),
-            &index.schema(),
-            meta.segments,
-            &delete_queue.cursor(),
-        );
-        let segment_registers = Arc::new(RwLock::new(SegmentRegisters::new(commited_segments)));
-
         let segment_updater =
-            SegmentUpdater::create(segment_registers.clone(), index.clone(), stamper.clone())?;
+            SegmentUpdater::create(index.clone(), stamper.clone(), &delete_queue.cursor())?;
 
         let mut index_writer = IndexWriter {
             _directory_lock: Some(directory_lock),
 
+            heap_size_in_bytes_per_thread,
             index: index.clone(),
-            config,
 
             operation_receiver: document_receiver,
             operation_sender: document_sender,
@@ -333,6 +331,7 @@ impl IndexWriter {
             segment_updater,
 
             workers_join_handle: vec![],
+            num_threads,
 
             delete_queue,
 
@@ -340,10 +339,6 @@ impl IndexWriter {
             stamper,
 
             worker_id: 0,
-            segment_registers,
-            on_commit: Default::default(),
-
-            memory_manager: Default::default()
         };
         index_writer.start_workers()?;
         Ok(index_writer)
@@ -351,7 +346,7 @@ impl IndexWriter {
 
     fn drop_sender(&mut self) {
         let (sender, _receiver) = channel::bounded(1);
-        mem::replace(&mut self.operation_sender, sender);
+        self.operation_sender = sender;
     }
 
     /// If there are some merging threads, blocks until they all finish their work and
@@ -371,11 +366,23 @@ impl IndexWriter {
                 })?;
         }
 
-        self
+        let result = self
             .segment_updater
-            .wait_merging_thread();
+            .wait_merging_thread()
+            .map_err(|_| TantivyError::ErrorInThread("Failed to join merging thread.".into()));
 
-        Ok(())
+        if let Err(ref e) = result {
+            error!("Some merging thread failed {:?}", e);
+        }
+
+        result
+    }
+
+    #[doc(hidden)]
+    pub fn add_segment(&self, segment_meta: SegmentMeta) -> crate::Result<()> {
+        let delete_cursor = self.delete_queue.cursor();
+        let segment_entry = SegmentEntry::new(segment_meta, delete_cursor, None);
+        block_on(self.segment_updater.schedule_add_segment(segment_entry))
     }
 
     /// Creates a new segment.
@@ -398,9 +405,8 @@ impl IndexWriter {
 
         let mut delete_cursor = self.delete_queue.cursor();
 
+        let mem_budget = self.heap_size_in_bytes_per_thread;
         let index = self.index.clone();
-        let config = self.config.clone();
-        let memory_manager = self.memory_manager.clone();
         let join_handle: JoinHandle<crate::Result<()>> = thread::Builder::new()
             .name(format!("thrd-tantivy-index{}", self.worker_id))
             .spawn(move || {
@@ -429,13 +435,11 @@ impl IndexWriter {
                     }
                     let segment = index.new_segment();
                     index_documents(
-                        config.clone(),
+                        mem_budget,
                         segment,
                         &mut document_iterator,
                         &mut segment_updater,
-                        index.tokenizers(),
                         delete_cursor.clone(),
-                        memory_manager.clone()
                     )?;
                 }
             })?;
@@ -445,7 +449,7 @@ impl IndexWriter {
     }
 
     /// Accessor to the merge policy.
-    pub fn get_merge_policy(&self) -> Arc<Box<dyn MergePolicy>> {
+    pub fn get_merge_policy(&self) -> Arc<dyn MergePolicy> {
         self.segment_updater.get_merge_policy()
     }
 
@@ -455,7 +459,7 @@ impl IndexWriter {
     }
 
     fn start_workers(&mut self) -> crate::Result<()> {
-        for _ in 0..self.config.max_indexing_threads {
+        for _ in 0..self.num_threads {
             self.add_indexing_worker()?;
         }
         Ok(())
@@ -532,6 +536,7 @@ impl IndexWriter {
     /// when no documents are remaining.
     ///
     /// Returns the former segment_ready channel.
+    #[allow(unused_must_use)]
     fn recreate_document_channel(&mut self) -> OperationReceiver {
         let (document_sender, document_receiver): (OperationSender, OperationReceiver) =
             channel::bounded(PIPELINE_MAX_SIZE_IN_DOCS);
@@ -560,14 +565,18 @@ impl IndexWriter {
             .take()
             .expect("The IndexWriter does not have any lock. This is a bug, please report.");
 
-        let new_index_writer: IndexWriter =
-            IndexWriter::new(&self.index, self.config.clone(), directory_lock)?;
+        let new_index_writer: IndexWriter = IndexWriter::new(
+            &self.index,
+            self.num_threads,
+            self.heap_size_in_bytes_per_thread,
+            directory_lock,
+        )?;
 
         // the current `self` is dropped right away because of this call.
         //
         // This will drop the document queue, and the thread
         // should terminate.
-        mem::replace(self, new_index_writer);
+        *self = new_index_writer;
 
         // Drains the document receiver pipeline :
         // Workers don't need to index the pending documents.
@@ -600,7 +609,7 @@ impl IndexWriter {
     /// It is also possible to add a payload to the `commit`
     /// using this API.
     /// See [`PreparedCommit::set_payload()`](PreparedCommit.html)
-    pub fn prepare_commit(&mut self, soft_commit: bool) -> crate::Result<PreparedCommit> {
+    pub fn prepare_commit(&mut self) -> crate::Result<PreparedCommit> {
         // Here, because we join all of the worker threads,
         // all of the segment update for this commit have been
         // sent.
@@ -628,7 +637,7 @@ impl IndexWriter {
         }
 
         let commit_opstamp = self.stamper.stamp();
-        let prepared_commit = PreparedCommit::new(self, commit_opstamp, soft_commit);
+        let prepared_commit = PreparedCommit::new(self, commit_opstamp);
         info!("Prepared commit {}", commit_opstamp);
         Ok(prepared_commit)
     }
@@ -648,25 +657,7 @@ impl IndexWriter {
     /// that made it in the commit.
     ///
     pub fn commit(&mut self) -> crate::Result<Opstamp> {
-        self.prepare_commit(false)?.commit()
-    }
-
-    pub fn soft_commit(&mut self) -> crate::Result<Opstamp> {
-        self.prepare_commit(true)?.commit()
-    }
-
-    pub(crate) fn trigger_commit(&self) -> impl Future<Output = ()> {
-        self.on_commit.broadcast()
-    }
-
-    pub fn reader(&self, num_searchers: usize) -> crate::Result<IndexReader> {
-        let nrt_reader = NRTReader::create(
-            num_searchers,
-            self.index.clone(),
-            self.segment_registers.clone(),
-            &self.on_commit,
-        )?;
-        Ok(IndexReader::NRT(nrt_reader))
+        self.prepare_commit()?.commit()
     }
 
     pub(crate) fn segment_updater(&self) -> &SegmentUpdater {
@@ -809,7 +800,7 @@ mod tests {
         let mut schema_builder = schema::Schema::builder();
         let text_field = schema_builder.add_text_field("text", schema::TEXT);
         let index = Index::create_in_ram(schema_builder.build());
-        let index_writer = index.writer_with_num_threads(1, 3_000_000).unwrap();
+        let index_writer = index.writer_for_tests().unwrap();
         let operations = vec![
             UserOperation::Add(doc!(text_field=>"a")),
             UserOperation::Add(doc!(text_field=>"b")),
@@ -824,7 +815,7 @@ mod tests {
         let text_field = schema_builder.add_text_field("text", schema::TEXT);
         let index = Index::create_in_ram(schema_builder.build());
 
-        let mut index_writer = index.writer_with_num_threads(1, 3_000_000).unwrap();
+        let mut index_writer = index.writer_for_tests().unwrap();
         index_writer.add_document(doc!(text_field => "hello1"));
         index_writer.add_document(doc!(text_field => "hello2"));
         assert!(index_writer.commit().is_ok());
@@ -873,7 +864,7 @@ mod tests {
             .reload_policy(ReloadPolicy::Manual)
             .try_into()
             .unwrap();
-        let mut index_writer = index.writer_with_num_threads(1, 3_000_000).unwrap();
+        let mut index_writer = index.writer_for_tests().unwrap();
         let a_term = Term::from_field_text(text_field, "a");
         let b_term = Term::from_field_text(text_field, "b");
         let operations = vec![
@@ -935,8 +926,8 @@ mod tests {
     fn test_lockfile_already_exists_error_msg() {
         let schema_builder = schema::Schema::builder();
         let index = Index::create_in_ram(schema_builder.build());
-        let _index_writer = index.writer_with_num_threads(1, 3_000_000).unwrap();
-        match index.writer_with_num_threads(1, 3_000_000) {
+        let _index_writer = index.writer_for_tests().unwrap();
+        match index.writer_for_tests() {
             Err(err) => {
                 let err_msg = err.to_string();
                 assert!(err_msg.contains("already an `IndexWriter`"));
@@ -988,7 +979,7 @@ mod tests {
         let num_docs_containing = |s: &str| {
             let searcher = reader.searcher();
             let term = Term::from_field_text(text_field, s);
-            searcher.doc_freq(&term)
+            searcher.doc_freq(&term).unwrap()
         };
 
         {
@@ -1024,7 +1015,7 @@ mod tests {
             .unwrap();
         let num_docs_containing = |s: &str| {
             let term_a = Term::from_field_text(text_field, s);
-            reader.searcher().doc_freq(&term_a)
+            reader.searcher().doc_freq(&term_a).unwrap()
         };
         {
             // writing the segment
@@ -1064,8 +1055,7 @@ mod tests {
                 index_writer.add_document(doc!(text_field => "a"));
             }
             {
-                let mut prepared_commit =
-                    index_writer.prepare_commit(false).expect("commit failed");
+                let mut prepared_commit = index_writer.prepare_commit().expect("commit failed");
                 prepared_commit.set_payload("first commit");
                 prepared_commit.commit().expect("commit failed");
             }
@@ -1098,8 +1088,7 @@ mod tests {
                 index_writer.add_document(doc!(text_field => "a"));
             }
             {
-                let mut prepared_commit =
-                    index_writer.prepare_commit(false).expect("commit failed");
+                let mut prepared_commit = index_writer.prepare_commit().expect("commit failed");
                 prepared_commit.set_payload("first commit");
                 prepared_commit.abort().expect("commit failed");
             }
@@ -1121,6 +1110,7 @@ mod tests {
                 .unwrap()
                 .searcher()
                 .doc_freq(&term_a)
+                .unwrap()
         };
         assert_eq!(num_docs_containing("a"), 0);
         assert_eq!(num_docs_containing("b"), 100);
@@ -1140,7 +1130,7 @@ mod tests {
             reader.reload().unwrap();
             let searcher = reader.searcher();
             let term = Term::from_field_text(text_field, s);
-            searcher.doc_freq(&term)
+            searcher.doc_freq(&term).unwrap()
         };
         let mut index_writer = index.writer_with_num_threads(4, 12_000_000).unwrap();
 
@@ -1191,7 +1181,15 @@ mod tests {
 
         // working with an empty index == no documents
         let term_b = Term::from_field_text(text_field, "b");
-        assert_eq!(index.reader().unwrap().searcher().doc_freq(&term_b), 0);
+        assert_eq!(
+            index
+                .reader()
+                .unwrap()
+                .searcher()
+                .doc_freq(&term_b)
+                .unwrap(),
+            0
+        );
     }
 
     #[test]
@@ -1211,7 +1209,15 @@ mod tests {
 
         let term_a = Term::from_field_text(text_field, "a");
         // expect the document with that term to be in the index
-        assert_eq!(index.reader().unwrap().searcher().doc_freq(&term_a), 1);
+        assert_eq!(
+            index
+                .reader()
+                .unwrap()
+                .searcher()
+                .doc_freq(&term_a)
+                .unwrap(),
+            1
+        );
     }
 
     #[test]
@@ -1237,7 +1243,15 @@ mod tests {
         // Find original docs in the index
         let term_a = Term::from_field_text(text_field, "a");
         // expect the document with that term to be in the index
-        assert_eq!(index.reader().unwrap().searcher().doc_freq(&term_a), 1);
+        assert_eq!(
+            index
+                .reader()
+                .unwrap()
+                .searcher()
+                .doc_freq(&term_a)
+                .unwrap(),
+            1
+        );
     }
 
     #[test]
@@ -1272,46 +1286,9 @@ mod tests {
         let idfield = schema_builder.add_text_field("id", STRING);
         schema_builder.add_text_field("optfield", STRING);
         let index = Index::create_in_ram(schema_builder.build());
-        let mut index_writer = index.writer_with_num_threads(1, 3_000_000).unwrap();
+        let mut index_writer = index.writer_for_tests().unwrap();
         index_writer.add_document(doc!(idfield=>"myid"));
         let commit = index_writer.commit();
         assert!(commit.is_ok());
     }
-
-    #[test]
-    fn test_index_writer_reader() {
-        let mut schema_builder = schema::Schema::builder();
-        let idfield = schema_builder.add_text_field("id", STRING);
-        schema_builder.add_text_field("optfield", STRING);
-        let index = Index::create_in_ram(schema_builder.build());
-        let mut index_writer = index.writer_with_num_threads(1, 3_000_000).unwrap();
-        index_writer.add_document(doc!(idfield=>"myid"));
-        assert!(index_writer.commit().is_ok());
-        let reader = index_writer.reader(2).unwrap();
-        let searcher = reader.searcher();
-        assert_eq!(searcher.num_docs(), 1u64);
-        index_writer.add_document(doc!(idfield=>"myid"));
-        assert!(index_writer.commit().is_ok());
-        assert_eq!(reader.searcher().num_docs(), 2u64);
-        assert_eq!(searcher.num_docs(), 1u64);
-    }
-
-    #[test]
-    fn test_index_writer_reader_soft_commit() {
-        let mut schema_builder = schema::Schema::builder();
-        let idfield = schema_builder.add_text_field("id", STRING);
-        schema_builder.add_text_field("optfield", STRING);
-        let index = Index::create_in_ram(schema_builder.build());
-        let mut index_writer = index.writer_with_num_threads(1, 3_000_000).unwrap();
-        index_writer.add_document(doc!(idfield=>"myid"));
-        assert!(index_writer.soft_commit().is_ok());
-        let nrt_reader = index_writer.reader(2).unwrap();
-        let normal_reader = index.reader_builder().try_into().unwrap();
-        assert_eq!(nrt_reader.searcher().num_docs(), 1u64);
-        assert_eq!(normal_reader.searcher().num_docs(), 0u64);
-        assert!(index_writer.commit().is_ok());
-        assert!(normal_reader.reload().is_ok());
-        assert_eq!(nrt_reader.searcher().num_docs(), 1u64);
-        assert_eq!(normal_reader.searcher().num_docs(), 1u64);
-    }
 }

src/indexer/index_writer_config.rs

@@ -1,133 +0,0 @@
-use serde::{Deserialize, Serialize};
-
-// Size of the margin for the heap. A segment is closed when the remaining memory
-// in the heap goes below MARGIN_IN_BYTES.
-const MARGIN_IN_BYTES: u64 = 1_000_000;
-
-// We impose the memory per thread to be at least 3 MB.
-const HEAP_SIZE_MIN: u64 = MARGIN_IN_BYTES * 3u64;
-const HEAP_SIZE_MAX: u64 = u32::max_value() as u64 - MARGIN_IN_BYTES;
-
-#[derive(Debug, Clone, Serialize, Deserialize)]
-pub struct IndexWriterConfig {
-    pub max_indexing_threads: usize,
-    pub max_merging_threads: usize,
-    pub memory_budget: u64,
-    pub store_flush_num_bytes: u64,
-    pub persist_low: u64,
-    pub persist_high: u64,
-}
-
-impl Default for IndexWriterConfig {
-    fn default() -> Self {
-        IndexWriterConfig {
-            max_indexing_threads: 1,
-            max_merging_threads: 3,
-            memory_budget: 50_000_000u64,
-            store_flush_num_bytes: 10_000_000u64,
-            persist_low: 10_000_000u64,
-            persist_high: 50_000_000u64
-        }
-    }
-}
-
-impl IndexWriterConfig {
-    #[cfg(test)]
-    pub fn for_test() -> IndexWriterConfig {
-        IndexWriterConfig {
-            max_indexing_threads: 1,
-            max_merging_threads: 5,
-            memory_budget: 4_000_000u64,
-            store_flush_num_bytes: 500_000u64,
-            persist_low: 2_000_000u64,
-            persist_high: 3_000_000u64,
-        }
-    }
-
-    // Ensures the `IndexWriterConfig` is correct.
-    //
-    // This method checks that the values in the `IndexWriterConfig`
-    // are valid. If it is not, it may mutate some of the values (like `max_num_threads`) to
-    // fit the contracts or return an error with an explicit error message.
-    //
-    // If called twice, the config is guaranteed to not be updated the second time.
-    pub fn validate(&mut self) -> crate::Result<()> {
-        if self.memory_budget < HEAP_SIZE_MIN {
-            let err_msg = format!(
-                "The heap size per thread needs to be at least {}.",
-                HEAP_SIZE_MIN
-            );
-            return Err(crate::TantivyError::InvalidArgument(err_msg));
-        }
-        let heap_size_in_bytes_per_thread = self.heap_size_in_byte_per_thread();
-        if heap_size_in_bytes_per_thread >= HEAP_SIZE_MAX {
-            let err_msg = format!("The heap size per thread cannot exceed {}", HEAP_SIZE_MAX);
-            return Err(crate::TantivyError::InvalidArgument(err_msg));
-        }
-        if heap_size_in_bytes_per_thread < HEAP_SIZE_MIN {
-            self.max_indexing_threads = (self.memory_budget / HEAP_SIZE_MIN) as usize;
-        }
-        Ok(())
-    }
-
-    pub fn heap_size_in_byte_per_thread(&self) -> u64 {
-        self.memory_budget / self.max_indexing_threads as u64
-    }
-
-    pub fn heap_size_before_flushing(&self) -> u64 {
-        self.heap_size_in_byte_per_thread() - MARGIN_IN_BYTES
-    }
-}
-
-#[cfg(test)]
-mod tests {
-    use crate::IndexWriterConfig;
-
-    #[test]
-    fn test_index_writer_config_simple() {
-        let mut index = IndexWriterConfig {
-            max_indexing_threads: 3,
-            memory_budget: super::HEAP_SIZE_MIN * 3,
-            ..Default::default()
-        };
-        assert!(index.validate().is_ok());
-        assert_eq!(index.max_indexing_threads, 3);
-        assert_eq!(index.heap_size_in_byte_per_thread(), super::HEAP_SIZE_MIN);
-    }
-
-    #[test]
-    fn test_index_writer_config_reduce_num_threads() {
-        let mut index = IndexWriterConfig {
-            max_indexing_threads: 3,
-            memory_budget: super::HEAP_SIZE_MIN,
-            ..Default::default()
-        };
-        assert!(index.validate().is_ok());
-        assert_eq!(index.max_indexing_threads, 1);
-        assert_eq!(index.heap_size_in_byte_per_thread(), super::HEAP_SIZE_MIN);
-    }
-
-    #[test]
-    fn test_index_writer_config_not_enough_memory() {
-        let mut index = IndexWriterConfig {
-            max_indexing_threads: 1,
-            memory_budget: super::HEAP_SIZE_MIN - 1,
-            ..Default::default()
-        };
-        assert!(
-            matches!(index.validate(), Err(crate::TantivyError::InvalidArgument(msg) ) if msg.contains("The heap size per thread needs to be at least"))
-        );
-    }
-
-    #[test]
-    fn test_index_writer_config_too_much_memory() {
-        let mut index = IndexWriterConfig {
-            max_indexing_threads: 1,
-            memory_budget: (u32::max_value() as u64) + 1,
-            ..Default::default()
-        };
-        assert!(
-            matches!(index.validate(), Err(crate::TantivyError::InvalidArgument(msg) ) if msg.contains("The heap size per thread cannot exceed"))
-        );
-    }
-}

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 {
@@ -54,10 +54,6 @@ impl LogMergePolicy {
 
 impl MergePolicy for LogMergePolicy {
     fn compute_merge_candidates(&self, segments: &[SegmentMeta]) -> Vec<MergeCandidate> {
-        if segments.is_empty() {
-            return Vec::new();
-        }
-
         let mut size_sorted_tuples = segments
             .iter()
             .map(SegmentMeta::num_docs)
@@ -67,27 +63,35 @@ impl MergePolicy for LogMergePolicy {
 
         size_sorted_tuples.sort_by(|x, y| y.1.cmp(&(x.1)));
 
+        if size_sorted_tuples.len() <= 1 {
+            return Vec::new();
+        }
+
         let size_sorted_log_tuples: Vec<_> = size_sorted_tuples
             .into_iter()
             .map(|(ind, num_docs)| (ind, f64::from(self.clip_min_size(num_docs)).log2()))
             .collect();
 
-        let (first_ind, first_score) = size_sorted_log_tuples[0];
-        let mut current_max_log_size = first_score;
-        let mut levels = vec![vec![first_ind]];
-        for &(ind, score) in (&size_sorted_log_tuples).iter().skip(1) {
-            if score < (current_max_log_size - self.level_log_size) {
-                current_max_log_size = score;
-                levels.push(Vec::new());
+        if let Some(&(first_ind, first_score)) = size_sorted_log_tuples.first() {
+            let mut current_max_log_size = first_score;
+            let mut levels = vec![vec![first_ind]];
+            for &(ind, score) in (&size_sorted_log_tuples).iter().skip(1) {
+                if score < (current_max_log_size - self.level_log_size) {
+                    current_max_log_size = score;
+                    levels.push(Vec::new());
+                }
+                levels.last_mut().unwrap().push(ind);
             }
-            levels.last_mut().unwrap().push(ind);
+            levels
+                .iter()
+                .filter(|level| level.len() >= self.min_merge_size)
+                .map(|ind_vec| {
+                    MergeCandidate(ind_vec.iter().map(|&ind| segments[ind].id()).collect())
+                })
+                .collect()
+        } else {
+            return vec![];
         }
-
-        levels
-            .iter()
-            .filter(|level| level.len() >= self.min_merge_size)
-            .map(|ind_vec| MergeCandidate(ind_vec.iter().map(|&ind| segments[ind].id()).collect()))
-            .collect()
     }
 }
 
@@ -179,6 +183,7 @@ mod tests {
         let result_list = test_merge_policy().compute_merge_candidates(&test_input);
         assert_eq!(result_list.len(), 2);
     }
+
     #[test]
     fn test_log_merge_policy_small_segments() {
         // segments under min_layer_size are merged together
@@ -194,6 +199,17 @@ mod tests {
         assert_eq!(result_list.len(), 1);
     }
 
+    #[test]
+    fn test_log_merge_policy_all_segments_too_large_to_merge() {
+        let eight_large_segments: Vec<SegmentMeta> =
+            std::iter::repeat_with(|| create_random_segment_meta(100_001))
+                .take(8)
+                .collect();
+        assert!(test_merge_policy()
+            .compute_merge_candidates(&eight_large_segments)
+            .is_empty());
+    }
+
     #[test]
     fn test_large_merge_segments() {
         let test_input = vec![

src/indexer/merge_operation.rs

@@ -1,22 +1,17 @@
-use crate::indexer::resource_manager::{Allocation, ResourceManager};
 use crate::Opstamp;
 use crate::SegmentId;
 use census::{Inventory, TrackedObject};
 use std::collections::HashSet;
-use std::fmt;
 use std::ops::Deref;
 
-#[derive(Default, Clone)]
-pub(crate) struct MergeOperationInventory {
-    inventory: Inventory<InnerMergeOperation>,
-    num_merge_watcher: ResourceManager,
-}
+#[derive(Default)]
+pub(crate) struct MergeOperationInventory(Inventory<InnerMergeOperation>);
 
 impl Deref for MergeOperationInventory {
     type Target = Inventory<InnerMergeOperation>;
 
     fn deref(&self) -> &Self::Target {
-        &self.inventory
+        &self.0
     }
 }
 
@@ -30,10 +25,6 @@ impl MergeOperationInventory {
         }
         segment_in_merge
     }
-
-    pub fn wait_until_empty(&self) {
-        let _ = self.num_merge_watcher.wait_until_in_range(0..1);
-    }
 }
 
 /// A `MergeOperation` has two roles.
@@ -56,17 +47,6 @@ pub struct MergeOperation {
 pub(crate) struct InnerMergeOperation {
     target_opstamp: Opstamp,
     segment_ids: Vec<SegmentId>,
-    _allocation: Allocation,
-}
-
-impl fmt::Debug for InnerMergeOperation {
-    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
-        write!(
-            f,
-            "MergeOp(target_opstamp={:?}, segment_ids={:?})",
-            self.target_opstamp, self.segment_ids
-        )
-    }
 }
 
 impl MergeOperation {
@@ -75,11 +55,9 @@ impl MergeOperation {
         target_opstamp: Opstamp,
         segment_ids: Vec<SegmentId>,
     ) -> MergeOperation {
-        let allocation = inventory.num_merge_watcher.allocate(1);
         let inner_merge_operation = InnerMergeOperation {
             target_opstamp,
             segment_ids,
-            _allocation: allocation,
         };
         MergeOperation {
             inner: inventory.track(inner_merge_operation),

src/indexer/mod.rs

@@ -2,14 +2,12 @@ pub mod delete_queue;
 
 mod doc_opstamp_mapping;
 pub mod index_writer;
-mod index_writer_config;
 mod log_merge_policy;
 mod merge_operation;
 pub mod merge_policy;
 pub mod merger;
 pub mod operation;
 mod prepared_commit;
-mod resource_manager;
 mod segment_entry;
 mod segment_manager;
 mod segment_register;
@@ -18,25 +16,23 @@ pub mod segment_updater;
 mod segment_writer;
 mod stamper;
 
-pub(crate) use self::resource_manager::{Allocation, ResourceManager};
-pub(crate) use self::merge_operation::MergeOperationInventory;
 pub use self::index_writer::IndexWriter;
-pub use self::index_writer_config::IndexWriterConfig;
 pub use self::log_merge_policy::LogMergePolicy;
 pub use self::merge_operation::MergeOperation;
 pub use self::merge_policy::{MergeCandidate, MergePolicy, NoMergePolicy};
 pub use self::prepared_commit::PreparedCommit;
 pub use self::segment_entry::SegmentEntry;
 pub use self::segment_manager::SegmentManager;
-pub(crate) use self::segment_manager::SegmentRegisters;
 pub use self::segment_serializer::SegmentSerializer;
+pub use self::segment_updater::merge_segments;
 pub use self::segment_writer::SegmentWriter;
 
 /// Alias for the default merge policy, which is the `LogMergePolicy`.
 pub type DefaultMergePolicy = LogMergePolicy;
 
+#[cfg(feature = "mmap")]
 #[cfg(test)]
-mod tests {
+mod tests_mmap {
     use crate::schema::{self, Schema};
     use crate::{Index, Term};
 
@@ -45,7 +41,7 @@ mod tests {
         let mut schema_builder = Schema::builder();
         let text_field = schema_builder.add_text_field("text", schema::TEXT);
         let index = Index::create_from_tempdir(schema_builder.build()).unwrap();
-        let mut index_writer = index.writer_with_num_threads(1, 3_000_000).unwrap();
+        let mut index_writer = index.writer_for_tests().unwrap();
         // there must be one deleted document in the segment
         index_writer.add_document(doc!(text_field=>"b"));
         index_writer.delete_term(Term::from_field_text(text_field, "b"));

src/indexer/operation.rs

@@ -9,6 +9,15 @@ pub struct DeleteOperation {
     pub term: Term,
 }
 
+impl Default for DeleteOperation {
+    fn default() -> Self {
+        DeleteOperation {
+            opstamp: 0u64,
+            term: Term::new(),
+        }
+    }
+}
+
 /// Timestamped Add operation.
 #[derive(Eq, PartialEq, Debug)]
 pub struct AddOperation {

src/indexer/prepared_commit.rs

@@ -7,20 +7,14 @@ pub struct PreparedCommit<'a> {
     index_writer: &'a mut IndexWriter,
     payload: Option<String>,
     opstamp: Opstamp,
-    soft_commit: bool,
 }
 
 impl<'a> PreparedCommit<'a> {
-    pub(crate) fn new(
-        index_writer: &'a mut IndexWriter,
-        opstamp: Opstamp,
-        soft_commit: bool,
-    ) -> PreparedCommit<'_> {
+    pub(crate) fn new(index_writer: &'a mut IndexWriter, opstamp: Opstamp) -> PreparedCommit<'_> {
         PreparedCommit {
             index_writer,
             payload: None,
             opstamp,
-            soft_commit,
         }
     }
 
@@ -38,12 +32,11 @@ impl<'a> PreparedCommit<'a> {
 
     pub fn commit(self) -> crate::Result<Opstamp> {
         info!("committing {}", self.opstamp);
-        block_on(self.index_writer.segment_updater().schedule_commit(
-            self.opstamp,
-            self.payload,
-            self.soft_commit,
-        ))?;
-        block_on(self.index_writer.trigger_commit());
+        let _ = block_on(
+            self.index_writer
+                .segment_updater()
+                .schedule_commit(self.opstamp, self.payload),
+        );
         Ok(self.opstamp)
     }
 }

src/indexer/resource_manager.rs

@@ -1,213 +0,0 @@
-use std::ops::RangeBounds;
-use std::sync::{Arc, Condvar, Mutex, MutexGuard, RwLock};
-
-struct LockedData {
-    count: u64,
-    enabled: bool
-}
-
-impl Default for LockedData {
-    fn default() -> Self {
-        LockedData {
-            count: 0u64,
-            enabled: true
-        }
-    }
-}
-
-#[derive(Default)]
-struct Inner {
-    resource_level: Mutex<LockedData>,
-    convdvar: Condvar,
-}
-
-
-/// The resource manager makes it possible to track the amount of level of a given resource.
-/// There is no magic here : it is to the description of the user to declare how much
-/// of the resource is being held.
-///
-/// Allocation of a resource is bound to the lifetime of a `Allocation` instance.
-///
-/// ```rust
-/// let resource_manager = ResourceManager::default();
-///
-/// ```
-///
-/// In tantivy, this is used to check the number of merging thread and the number of memory
-/// used by the volatile segments.
-///
-#[derive(Clone, Default)]
-pub struct ResourceManager {
-    inner: Arc<Inner>,
-}
-
-impl ResourceManager {
-    /// Return the total amount of reousrce allocated
-    pub fn total_amount(&self) -> u64 {
-        self.lock().count
-    }
-
-    fn lock(&self) -> MutexGuard<LockedData> {
-        self.inner
-            .resource_level
-            .lock()
-            .expect("Failed to obtain lock for ReservedMemory. This should never happen.")
-    }
-
-    fn record_delta(&self, delta: i64) {
-        if delta == 0i64 {
-            return;
-        }
-        let mut lock = self.lock();
-        let new_val = lock.count as i64 + delta;
-        lock.count = new_val as u64;
-        self.inner.convdvar.notify_all();
-    }
-
-    /// Records a new allocation.
-    ///
-    /// The returned allocate object is used to automatically release the allocated resource
-    /// on drop.
-    pub fn allocate(&self, amount: u64) -> Allocation {
-        self.record_delta(amount as i64);
-        Allocation {
-            resource_manager: self.clone(),
-            amount: RwLock::new(amount),
-        }
-    }
-
-    /// Stops the resource manager.
-    ///
-    /// If any thread is waiting via `.wait_until_in_range(...)`, the method will stop
-    /// being blocking and will return an error.
-    pub fn terminate(&self) {
-        self.lock().enabled = false;
-        self.inner.convdvar.notify_all();
-    }
-
-    /// Blocks the current thread until the resource level reaches the given range,
-    /// in a cpu-efficient way.
-    ///
-    /// This method does not necessarily wakes up the current thread at every transition
-    /// into the targetted range, but any durable entry in the range will be detected.
-    pub fn wait_until_in_range<R: RangeBounds<u64>>(&self, range: R) -> Result<u64, u64> {
-        let mut levels = self.lock();
-        if !levels.enabled {
-            return Err(levels.count)
-        }
-        while !range.contains(&levels.count) {
-           levels = self.inner.convdvar.wait(levels).unwrap();
-            if !levels.enabled {
-                return Err(levels.count)
-            }
-        }
-        Ok(levels.count)
-    }
-}
-
-pub struct Allocation {
-    resource_manager: ResourceManager,
-    amount: RwLock<u64>,
-}
-
-impl Allocation {
-    pub fn amount(&self) -> u64 {
-        *self.amount.read().unwrap()
-    }
-
-    pub fn modify(&self, new_amount: u64) {
-        let mut wlock = self.amount.write().unwrap();
-        let delta = new_amount as i64 - *wlock as i64;
-        *wlock = new_amount;
-        self.resource_manager.record_delta(delta);
-    }
-}
-
-impl Drop for Allocation {
-    fn drop(&mut self) {
-        let amount = self.amount();
-        self.resource_manager.record_delta(-(amount as i64))
-    }
-}
-
-#[cfg(test)]
-mod tests {
-    use super::ResourceManager;
-    use futures::channel::oneshot;
-    use futures::executor::block_on;
-    use std::{mem, thread};
-
-    #[test]
-    fn test_simple_allocation() {
-        let memory = ResourceManager::default();
-        assert_eq!(memory.total_amount(), 0u64);
-        let _allocation = memory.allocate(10u64);
-        assert_eq!(memory.total_amount(), 10u64);
-    }
-
-    #[test]
-    fn test_multiple_allocation() {
-        let memory = ResourceManager::default();
-        assert_eq!(memory.total_amount(), 0u64);
-        let _allocation = memory.allocate(10u64);
-        let _allocation_2 = memory.allocate(11u64);
-        assert_eq!(memory.total_amount(), 21u64);
-    }
-
-    #[test]
-    fn test_release_on_drop() {
-        let memory = ResourceManager::default();
-        assert_eq!(memory.total_amount(), 0u64);
-        let allocation = memory.allocate(10u64);
-        let allocation_2 = memory.allocate(11u64);
-        assert_eq!(memory.total_amount(), 21u64);
-        mem::drop(allocation);
-        assert_eq!(memory.total_amount(), 11u64);
-        mem::drop(allocation_2);
-        assert_eq!(memory.total_amount(), 0u64);
-    }
-
-    #[test]
-    fn test_wait_until() {
-        let memory = ResourceManager::default();
-        let (send, recv) = oneshot::channel::<()>();
-        let memory_clone = memory.clone();
-        thread::spawn(move || {
-            let _allocation1 = memory_clone.allocate(2u64);
-            let _allocation2 = memory_clone.allocate(3u64);
-            let _allocation3 = memory_clone.allocate(4u64);
-            std::mem::drop(_allocation3);
-            assert!(block_on(recv).is_ok());
-        });
-        assert_eq!(memory.wait_until_in_range(5u64..8u64), Ok(5u64));
-        assert!(send.send(()).is_ok());
-    }
-
-    #[test]
-    fn test_modify_amount() {
-        let memory = ResourceManager::default();
-        let alloc = memory.allocate(2u64);
-        assert_eq!(memory.total_amount(), 2u64);
-        assert_eq!(alloc.amount(), 2u64);
-        let alloc2 = memory.allocate(3u64);
-        assert_eq!(memory.total_amount(), 2u64 + 3u64);
-        assert_eq!(alloc2.amount(), 3u64);
-        alloc.modify(14u64);
-        assert_eq!(alloc.amount(), 14u64);
-        assert_eq!(memory.total_amount(), 14u64 + 3u64)
-    }
-    
-    #[test]
-    fn test_stop_resource_manager() {
-        let resource_manager = ResourceManager::default();
-        let resource_manager_clone = resource_manager.clone();
-        let (sender, recv) = oneshot::channel();
-        let join_handle = thread::spawn(move || {
-            assert!(sender.send(()).is_ok());
-            resource_manager_clone.wait_until_in_range(10..20)
-        });
-        let _ = block_on(recv);
-        resource_manager.terminate();
-        assert_eq!(join_handle.join().unwrap(), Err(0u64));
-    }
-}

src/indexer/segment_entry.rs

@@ -1,9 +1,7 @@
 use crate::common::BitSet;
 use crate::core::SegmentId;
 use crate::core::SegmentMeta;
-use crate::directory::ManagedDirectory;
 use crate::indexer::delete_queue::DeleteCursor;
-use crate::{Opstamp, Segment};
 use std::fmt;
 
 /// A segment entry describes the state of
@@ -21,7 +19,7 @@ use std::fmt;
 /// in the .del file or in the `delete_bitset`.
 #[derive(Clone)]
 pub struct SegmentEntry {
-    segment: Segment,
+    meta: SegmentMeta,
     delete_bitset: Option<BitSet>,
     delete_cursor: DeleteCursor,
 }
@@ -29,67 +27,47 @@ pub struct SegmentEntry {
 impl SegmentEntry {
     /// Create a new `SegmentEntry`
     pub fn new(
-        segment: Segment,
+        segment_meta: SegmentMeta,
         delete_cursor: DeleteCursor,
         delete_bitset: Option<BitSet>,
     ) -> SegmentEntry {
         SegmentEntry {
-            segment,
+            meta: segment_meta,
             delete_bitset,
             delete_cursor,
         }
     }
 
-    pub fn persist(&mut self, dest_directory: ManagedDirectory) -> crate::Result<()> {
-        // TODO take in account delete bitset?
-        self.segment.persist(dest_directory)?;
-        Ok(())
-    }
-
-    pub fn set_delete_cursor(&mut self, delete_cursor: DeleteCursor) {
-        self.delete_cursor = delete_cursor;
-    }
-
-    /// `Takes` (as in Option::take) the delete bitset of a segment entry.
-    /// `DocId` in this bitset are flagged as deleted.
-    pub fn take_delete_bitset(&mut self) -> Option<BitSet> {
-        self.delete_bitset.take()
-    }
-
-    /// Reset the delete information in this segment.
+    /// Return a reference to the segment entry deleted bitset.
     ///
-    /// The `SegmentEntry` segment's `SegmentMeta` gets updated, and
-    /// any delete bitset is drop and set to None.
-    pub fn reset_delete_meta(&mut self, num_deleted_docs: u32, target_opstamp: Opstamp) {
-        self.segment = self
-            .segment
-            .clone()
-            .with_delete_meta(num_deleted_docs, target_opstamp);
-        self.delete_bitset = None;
+    /// `DocId` in this bitset are flagged as deleted.
+    pub fn delete_bitset(&self) -> Option<&BitSet> {
+        self.delete_bitset.as_ref()
+    }
+
+    /// Set the `SegmentMeta` for this segment.
+    pub fn set_meta(&mut self, segment_meta: SegmentMeta) {
+        self.meta = segment_meta;
     }
 
     /// Return a reference to the segment_entry's delete cursor
-    pub fn delete_cursor(&mut self) -> DeleteCursor {
-        self.delete_cursor.clone()
+    pub fn delete_cursor(&mut self) -> &mut DeleteCursor {
+        &mut self.delete_cursor
     }
 
     /// Returns the segment id.
     pub fn segment_id(&self) -> SegmentId {
-        self.meta().id()
+        self.meta.id()
     }
 
-    /// Returns the `segment` associated to the `SegmentEntry`.
-    pub fn segment(&self) -> &Segment {
-        &self.segment
-    }
     /// Accessor to the `SegmentMeta`
     pub fn meta(&self) -> &SegmentMeta {
-        self.segment.meta()
+        &self.meta
     }
 }
 
 impl fmt::Debug for SegmentEntry {
     fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
-        write!(formatter, "SegmentEntry({:?})", self.meta())
+        write!(formatter, "SegmentEntry({:?})", self.meta)
     }
 }

src/indexer/segment_manager.rs

@@ -2,15 +2,15 @@ use super::segment_register::SegmentRegister;
 use crate::core::SegmentId;
 use crate::core::SegmentMeta;
 use crate::error::TantivyError;
-use crate::indexer::{SegmentEntry, MergeOperationInventory, MergeCandidate, MergeOperation};
-use crate::{Segment, Opstamp};
+use crate::indexer::delete_queue::DeleteCursor;
+use crate::indexer::SegmentEntry;
 use std::collections::hash_set::HashSet;
 use std::fmt::{self, Debug, Formatter};
-use std::sync::{Arc, RwLock};
+use std::sync::RwLock;
 use std::sync::{RwLockReadGuard, RwLockWriteGuard};
 
 #[derive(Default)]
-pub(crate) struct SegmentRegisters {
+struct SegmentRegisters {
     uncommitted: SegmentRegister,
     committed: SegmentRegister,
 }
@@ -22,17 +22,6 @@ pub(crate) enum SegmentsStatus {
 }
 
 impl SegmentRegisters {
-    pub fn new(committed: SegmentRegister) -> SegmentRegisters {
-        SegmentRegisters {
-            uncommitted: Default::default(),
-            committed,
-        }
-    }
-
-    pub fn committed_segment(&self) -> Vec<Segment> {
-        self.committed.segments()
-    }
-
     /// Check if all the segments are committed or uncommited.
     ///
     /// If some segment is missing or segments are in a different state (this should not happen
@@ -55,8 +44,7 @@ impl SegmentRegisters {
 /// changes (merges especially)
 #[derive(Default)]
 pub struct SegmentManager {
-    registers: Arc<RwLock<SegmentRegisters>>,
-    merge_operations: MergeOperationInventory,
+    registers: RwLock<SegmentRegisters>,
 }
 
 impl Debug for SegmentManager {
@@ -70,28 +58,34 @@ impl Debug for SegmentManager {
     }
 }
 
+pub fn get_mergeable_segments(
+    in_merge_segment_ids: &HashSet<SegmentId>,
+    segment_manager: &SegmentManager,
+) -> (Vec<SegmentMeta>, Vec<SegmentMeta>) {
+    let registers_lock = segment_manager.read();
+    (
+        registers_lock
+            .committed
+            .get_mergeable_segments(in_merge_segment_ids),
+        registers_lock
+            .uncommitted
+            .get_mergeable_segments(in_merge_segment_ids),
+    )
+}
 
 impl SegmentManager {
-    pub(crate) fn new(registers: Arc<RwLock<SegmentRegisters>>) -> SegmentManager {
+    pub fn from_segments(
+        segment_metas: Vec<SegmentMeta>,
+        delete_cursor: &DeleteCursor,
+    ) -> SegmentManager {
         SegmentManager {
-            registers,
-            merge_operations: Default::default()
+            registers: RwLock::new(SegmentRegisters {
+                uncommitted: SegmentRegister::default(),
+                committed: SegmentRegister::new(segment_metas, delete_cursor),
+            }),
         }
     }
 
-    pub fn new_merge_operation(&self, opstamp: Opstamp, merge_candidate: MergeCandidate) -> MergeOperation {
-        MergeOperation::new(
-            &self.merge_operations,
-            opstamp,
-            merge_candidate.0
-
-        )
-    }
-
-    pub fn wait_merging_thread(&self) {
-        self.merge_operations.wait_until_empty()
-    }
-
     /// Returns all of the segment entries (committed or uncommitted)
     pub fn segment_entries(&self) -> Vec<SegmentEntry> {
         let registers_lock = self.read();
@@ -100,34 +94,6 @@ impl SegmentManager {
         segment_entries
     }
 
-    /// Returns the segments that are currently not in merge.
-    ///
-    /// They are split over two `Vec`. The committed segments on one hand
-    /// and the uncommitted ones on the other hand.
-    ///
-    /// This method is useful when searching for merge candidate or segments
-    /// to persists.
-    pub fn segments_not_in_merge(&self) -> (Vec<SegmentMeta>, Vec<SegmentMeta>) {
-        let in_merge_segment_ids: HashSet<SegmentId> = self.merge_operations.segment_in_merge();
-        let registers_lock = self.read();
-        (
-            registers_lock
-                .committed
-                .get_mergeable_segments(&in_merge_segment_ids),
-            registers_lock
-                .uncommitted
-                .get_mergeable_segments(&in_merge_segment_ids),
-        )
-    }
-
-    pub fn largest_segment_not_in_merge(&self) -> Option<SegmentMeta> {
-        let (committed, uncommitted) = self.segments_not_in_merge();
-        let mut segments = vec![];
-        segments.extend(committed);
-        segments.extend(uncommitted);
-        None
-    }
-
     // Lock poisoning should never happen :
     // The lock is acquired and released within this class,
     // and the operations cannot panic.

src/indexer/segment_register.rs

@@ -1,10 +1,7 @@
 use crate::core::SegmentId;
 use crate::core::SegmentMeta;
-use crate::directory::ManagedDirectory;
 use crate::indexer::delete_queue::DeleteCursor;
 use crate::indexer::segment_entry::SegmentEntry;
-use crate::schema::Schema;
-use crate::Segment;
 use std::collections::HashMap;
 use std::collections::HashSet;
 use std::fmt::{self, Debug, Formatter};
@@ -49,13 +46,6 @@ impl SegmentRegister {
             .collect()
     }
 
-    pub fn segments(&self) -> Vec<Segment> {
-        self.segment_states
-            .values()
-            .map(|segment_entry| segment_entry.segment().clone())
-            .collect()
-    }
-
     pub fn segment_entries(&self) -> Vec<SegmentEntry> {
         self.segment_states.values().cloned().collect()
     }
@@ -89,17 +79,11 @@ impl SegmentRegister {
         self.segment_states.get(segment_id).cloned()
     }
 
-    pub fn new(
-        directory: &ManagedDirectory,
-        schema: &Schema,
-        segment_metas: Vec<SegmentMeta>,
-        delete_cursor: &DeleteCursor,
-    ) -> SegmentRegister {
+    pub fn new(segment_metas: Vec<SegmentMeta>, delete_cursor: &DeleteCursor) -> SegmentRegister {
         let mut segment_states = HashMap::new();
         for segment_meta in segment_metas {
             let segment_id = segment_meta.id();
-            let segment = Segment::new_persisted(segment_meta, directory.clone(), schema.clone());
-            let segment_entry = SegmentEntry::new(segment, delete_cursor.clone(), None);
+            let segment_entry = SegmentEntry::new(segment_meta, delete_cursor.clone(), None);
             segment_states.insert(segment_id, segment_entry);
         }
         SegmentRegister { segment_states }
@@ -111,7 +95,6 @@ mod tests {
     use super::*;
     use crate::core::{SegmentId, SegmentMetaInventory};
     use crate::indexer::delete_queue::*;
-    use crate::indexer::ResourceManager;
 
     fn segment_ids(segment_register: &SegmentRegister) -> Vec<SegmentId> {
         segment_register
@@ -125,34 +108,28 @@ mod tests {
     fn test_segment_register() {
         let inventory = SegmentMetaInventory::default();
         let delete_queue = DeleteQueue::new();
-        let schema = Schema::builder().build();
 
         let mut segment_register = SegmentRegister::default();
         let segment_id_a = SegmentId::generate_random();
         let segment_id_b = SegmentId::generate_random();
         let segment_id_merged = SegmentId::generate_random();
 
-        let memory_manager = ResourceManager::default();
-
         {
-            let meta = inventory.new_segment_meta(segment_id_a, 0u32);
-            let segment = Segment::new_volatile(meta, schema.clone(), memory_manager.clone());
-            let segment_entry = SegmentEntry::new(segment, delete_queue.cursor(), None);
+            let segment_meta = inventory.new_segment_meta(segment_id_a, 0u32);
+            let segment_entry = SegmentEntry::new(segment_meta, delete_queue.cursor(), None);
             segment_register.add_segment_entry(segment_entry);
         }
         assert_eq!(segment_ids(&segment_register), vec![segment_id_a]);
         {
-            let meta = inventory.new_segment_meta(segment_id_b, 0u32);
-            let segment = Segment::new_volatile(meta, schema.clone(), memory_manager.clone());
-            let segment_entry = SegmentEntry::new(segment, delete_queue.cursor(), None);
+            let segment_meta = inventory.new_segment_meta(segment_id_b, 0u32);
+            let segment_entry = SegmentEntry::new(segment_meta, delete_queue.cursor(), None);
             segment_register.add_segment_entry(segment_entry);
         }
         segment_register.remove_segment(&segment_id_a);
         segment_register.remove_segment(&segment_id_b);
         {
             let segment_meta_merged = inventory.new_segment_meta(segment_id_merged, 0u32);
-            let segment_merged = Segment::new_volatile(segment_meta_merged, schema.clone(), memory_manager.clone());
-            let segment_entry = SegmentEntry::new(segment_merged, delete_queue.cursor(), None);
+            let segment_entry = SegmentEntry::new(segment_meta_merged, delete_queue.cursor(), None);
             segment_register.add_segment_entry(segment_entry);
         }
         assert_eq!(segment_ids(&segment_register), vec![segment_id_merged]);

src/indexer/segment_serializer.rs

@@ -3,32 +3,43 @@ use crate::core::SegmentComponent;
 use crate::fastfield::FastFieldSerializer;
 use crate::fieldnorm::FieldNormsSerializer;
 use crate::postings::InvertedIndexSerializer;
+use crate::store::StoreWriter;
 
 /// Segment serializer is in charge of laying out on disk
 /// the data accumulated and sorted by the `SegmentWriter`.
 pub struct SegmentSerializer {
+    segment: Segment,
+    store_writer: StoreWriter,
     fast_field_serializer: FastFieldSerializer,
-    fieldnorms_serializer: FieldNormsSerializer,
+    fieldnorms_serializer: Option<FieldNormsSerializer>,
     postings_serializer: InvertedIndexSerializer,
 }
 
 impl SegmentSerializer {
     /// Creates a new `SegmentSerializer`.
-    pub fn for_segment(segment: &mut Segment) -> crate::Result<SegmentSerializer> {
+    pub fn for_segment(mut segment: Segment) -> crate::Result<SegmentSerializer> {
+        let store_write = segment.open_write(SegmentComponent::STORE)?;
+
         let fast_field_write = segment.open_write(SegmentComponent::FASTFIELDS)?;
         let fast_field_serializer = FastFieldSerializer::from_write(fast_field_write)?;
 
         let fieldnorms_write = segment.open_write(SegmentComponent::FIELDNORMS)?;
         let fieldnorms_serializer = FieldNormsSerializer::from_write(fieldnorms_write)?;
 
-        let postings_serializer = InvertedIndexSerializer::open(segment)?;
+        let postings_serializer = InvertedIndexSerializer::open(&mut segment)?;
         Ok(SegmentSerializer {
+            segment,
+            store_writer: StoreWriter::new(store_write),
             fast_field_serializer,
-            fieldnorms_serializer,
+            fieldnorms_serializer: Some(fieldnorms_serializer),
             postings_serializer,
         })
     }
 
+    pub fn segment(&self) -> &Segment {
+        &self.segment
+    }
+
     /// Accessor to the `PostingsSerializer`.
     pub fn get_postings_serializer(&mut self) -> &mut InvertedIndexSerializer {
         &mut self.postings_serializer
@@ -39,16 +50,26 @@ impl SegmentSerializer {
         &mut self.fast_field_serializer
     }
 
-    /// Accessor to the field norm serializer.
-    pub fn get_fieldnorms_serializer(&mut self) -> &mut FieldNormsSerializer {
-        &mut self.fieldnorms_serializer
+    /// Extract the field norm serializer.
+    ///
+    /// Note the fieldnorms serializer can only be extracted once.
+    pub fn extract_fieldnorms_serializer(&mut self) -> Option<FieldNormsSerializer> {
+        self.fieldnorms_serializer.take()
+    }
+
+    /// Accessor to the `StoreWriter`.
+    pub fn get_store_writer(&mut self) -> &mut StoreWriter {
+        &mut self.store_writer
     }
 
     /// Finalize the segment serialization.
-    pub fn close(self) -> crate::Result<()> {
+    pub fn close(mut self) -> crate::Result<()> {
+        if let Some(fieldnorms_serializer) = self.extract_fieldnorms_serializer() {
+            fieldnorms_serializer.close()?;
+        }
         self.fast_field_serializer.close()?;
         self.postings_serializer.close()?;
-        self.fieldnorms_serializer.close()?;
+        self.store_writer.close()?;
         Ok(())
     }
 }

src/indexer/segment_updater.rs

@@ -1,4 +1,4 @@
-use super::segment_manager::SegmentManager;
+use super::segment_manager::{get_mergeable_segments, SegmentManager};
 use crate::core::Index;
 use crate::core::IndexMeta;
 use crate::core::Segment;
@@ -7,21 +7,22 @@ use crate::core::SegmentMeta;
 use crate::core::SerializableSegment;
 use crate::core::META_FILEPATH;
 use crate::directory::{Directory, DirectoryClone, GarbageCollectionResult};
+use crate::indexer::delete_queue::DeleteCursor;
 use crate::indexer::index_writer::advance_deletes;
+use crate::indexer::merge_operation::MergeOperationInventory;
 use crate::indexer::merger::IndexMerger;
-use crate::indexer::segment_manager::{SegmentRegisters, SegmentsStatus};
+use crate::indexer::segment_manager::SegmentsStatus;
 use crate::indexer::stamper::Stamper;
 use crate::indexer::SegmentEntry;
 use crate::indexer::SegmentSerializer;
 use crate::indexer::{DefaultMergePolicy, MergePolicy};
 use crate::indexer::{MergeCandidate, MergeOperation};
 use crate::schema::Schema;
-use crate::{Opstamp, SegmentComponent};
+use crate::Opstamp;
 use futures::channel::oneshot;
 use futures::executor::{ThreadPool, ThreadPoolBuilder};
 use futures::future::Future;
 use futures::future::TryFutureExt;
-use serde_json;
 use std::borrow::BorrowMut;
 use std::collections::HashSet;
 use std::io::Write;
@@ -42,7 +43,7 @@ const NUM_MERGE_THREADS: usize = 4;
 /// and flushed.
 ///
 /// This method is not part of tantivy's public API
-pub fn save_new_metas(schema: Schema, directory: &mut dyn Directory) -> crate::Result<()> {
+pub fn save_new_metas(schema: Schema, directory: &dyn Directory) -> crate::Result<()> {
     save_metas(
         &IndexMeta {
             segments: Vec::new(),
@@ -63,7 +64,7 @@ pub fn save_new_metas(schema: Schema, directory: &mut dyn Directory) -> crate::R
 /// and flushed.
 ///
 /// This method is not part of tantivy's public API
-fn save_metas(metas: &IndexMeta, directory: &mut dyn Directory) -> crate::Result<()> {
+fn save_metas(metas: &IndexMeta, directory: &dyn Directory) -> crate::Result<()> {
     info!("save metas");
     let mut buffer = serde_json::to_vec_pretty(metas)?;
     // Just adding a new line at the end of the buffer.
@@ -111,36 +112,108 @@ fn merge(
     target_opstamp: Opstamp,
 ) -> crate::Result<SegmentEntry> {
     // first we need to apply deletes to our segment.
-    let mut merged_segment = index.new_segment();
+    let merged_segment = index.new_segment();
 
-    // First we apply all of the delet to the merged segment, up to the target opstamp.
+    // First we apply all of the delete to the merged segment, up to the target opstamp.
     for segment_entry in &mut segment_entries {
-        advance_deletes(segment_entry, target_opstamp)?;
+        let segment = index.segment(segment_entry.meta().clone());
+        advance_deletes(segment, segment_entry, target_opstamp)?;
     }
 
-    let delete_cursor = segment_entries[0].delete_cursor();
+    let delete_cursor = segment_entries[0].delete_cursor().clone();
 
     let segments: Vec<Segment> = segment_entries
         .iter()
-        .map(|segment_entry| segment_entry.segment().clone())
+        .map(|segment_entry| index.segment(segment_entry.meta().clone()))
         .collect();
 
     // An IndexMerger is like a "view" of our merged segments.
     let merger: IndexMerger = IndexMerger::open(index.schema(), &segments[..])?;
 
     // ... we just serialize this index merger in our new segment to merge the two segments.
-    let segment_serializer = SegmentSerializer::for_segment(&mut merged_segment)?;
+    let segment_serializer = SegmentSerializer::for_segment(merged_segment.clone())?;
 
-    let store_wrt = merged_segment.open_write(SegmentComponent::STORE)?;
-    merger.write_storable_fields(store_wrt)?;
+    let num_docs = merger.write(segment_serializer)?;
 
-    let max_doc = merger.write(segment_serializer)?;
+    let merged_segment_id = merged_segment.id();
 
-    Ok(SegmentEntry::new(
-        merged_segment.with_max_doc(max_doc),
-        delete_cursor,
-        None,
-    ))
+    let segment_meta = index.new_segment_meta(merged_segment_id, num_docs);
+    Ok(SegmentEntry::new(segment_meta, delete_cursor, None))
+}
+
+/// Advanced: Merges a list of segments from different indices in a new index.
+///
+/// Returns `TantivyError` if the the indices list is empty or their
+/// schemas don't match.
+///
+/// `output_directory`: is assumed to be empty.
+///
+/// # Warning
+/// This function does NOT check or take the `IndexWriter` is running. It is not
+/// meant to work if you have an IndexWriter running for the origin indices, or
+/// the destination Index.
+#[doc(hidden)]
+pub fn merge_segments<Dir: Directory>(
+    indices: &[Index],
+    output_directory: Dir,
+) -> crate::Result<Index> {
+    if indices.is_empty() {
+        // If there are no indices to merge, there is no need to do anything.
+        return Err(crate::TantivyError::InvalidArgument(
+            "No indices given to marge".to_string(),
+        ));
+    }
+
+    let target_schema = indices[0].schema();
+
+    // let's check that all of the indices have the same schema
+    if indices
+        .iter()
+        .skip(1)
+        .any(|index| index.schema() != target_schema)
+    {
+        return Err(crate::TantivyError::InvalidArgument(
+            "Attempt to merge different schema indices".to_string(),
+        ));
+    }
+
+    let mut segments: Vec<Segment> = Vec::new();
+    for index in indices {
+        segments.extend(index.searchable_segments()?);
+    }
+
+    let mut merged_index = Index::create(output_directory, target_schema.clone())?;
+    let merged_segment = merged_index.new_segment();
+    let merged_segment_id = merged_segment.id();
+    let merger: IndexMerger = IndexMerger::open(merged_index.schema(), &segments[..])?;
+    let segment_serializer = SegmentSerializer::for_segment(merged_segment)?;
+    let num_docs = merger.write(segment_serializer)?;
+
+    let segment_meta = merged_index.new_segment_meta(merged_segment_id, num_docs);
+
+    let stats = format!(
+        "Segments Merge: [{}]",
+        segments
+            .iter()
+            .fold(String::new(), |sum, current| format!(
+                "{}{} ",
+                sum,
+                current.meta().id().uuid_string()
+            ))
+            .trim_end()
+    );
+
+    let index_meta = IndexMeta {
+        segments: vec![segment_meta],
+        schema: target_schema,
+        opstamp: 0u64,
+        payload: Some(stats),
+    };
+
+    // save the meta.json
+    save_metas(&index_meta, merged_index.directory_mut())?;
+
+    Ok(merged_index)
 }
 
 pub(crate) struct InnerSegmentUpdater {
@@ -156,18 +229,20 @@ pub(crate) struct InnerSegmentUpdater {
 
     index: Index,
     segment_manager: SegmentManager,
-    merge_policy: RwLock<Arc<Box<dyn MergePolicy>>>,
+    merge_policy: RwLock<Arc<dyn MergePolicy>>,
     killed: AtomicBool,
     stamper: Stamper,
+    merge_operations: MergeOperationInventory,
 }
 
 impl SegmentUpdater {
     pub fn create(
-        segment_registers: Arc<RwLock<SegmentRegisters>>,
         index: Index,
         stamper: Stamper,
+        delete_cursor: &DeleteCursor,
     ) -> crate::Result<SegmentUpdater> {
-        let segment_manager = SegmentManager::new(segment_registers);
+        let segments = index.searchable_segment_metas()?;
+        let segment_manager = SegmentManager::from_segments(segments, delete_cursor);
         let pool = ThreadPoolBuilder::new()
             .name_prefix("segment_updater")
             .pool_size(1)
@@ -193,18 +268,19 @@ impl SegmentUpdater {
             merge_thread_pool,
             index,
             segment_manager,
-            merge_policy: RwLock::new(Arc::new(Box::new(DefaultMergePolicy::default()))),
+            merge_policy: RwLock::new(Arc::new(DefaultMergePolicy::default())),
             killed: AtomicBool::new(false),
             stamper,
+            merge_operations: Default::default(),
         })))
     }
 
-    pub fn get_merge_policy(&self) -> Arc<Box<dyn MergePolicy>> {
+    pub fn get_merge_policy(&self) -> Arc<dyn MergePolicy> {
         self.merge_policy.read().unwrap().clone()
     }
 
     pub fn set_merge_policy(&self, merge_policy: Box<dyn MergePolicy>) {
-        let arc_merge_policy = Arc::new(merge_policy);
+        let arc_merge_policy = Arc::from(merge_policy);
         *self.merge_policy.write().unwrap() = arc_merge_policy;
     }
 
@@ -261,7 +337,8 @@ impl SegmentUpdater {
     fn purge_deletes(&self, target_opstamp: Opstamp) -> crate::Result<Vec<SegmentEntry>> {
         let mut segment_entries = self.segment_manager.segment_entries();
         for segment_entry in &mut segment_entries {
-            advance_deletes(segment_entry, target_opstamp)?;
+            let segment = self.index.segment(segment_entry.meta().clone());
+            advance_deletes(segment, segment_entry, target_opstamp)?;
         }
         Ok(segment_entries)
     }
@@ -329,21 +406,12 @@ impl SegmentUpdater {
         &self,
         opstamp: Opstamp,
         payload: Option<String>,
-        soft_commit: bool,
     ) -> impl Future<Output = crate::Result<()>> {
         let segment_updater: SegmentUpdater = self.clone();
-        let directory = self.index.directory().clone();
         self.schedule_future(async move {
-            let mut segment_entries = segment_updater.purge_deletes(opstamp)?;
-            if !soft_commit {
-                for segment_entry in &mut segment_entries {
-                    segment_entry.persist(directory.clone())?;
-                }
-            }
+            let segment_entries = segment_updater.purge_deletes(opstamp)?;
             segment_updater.segment_manager.commit(segment_entries);
-            if !soft_commit {
-                segment_updater.save_metas(opstamp, payload)?;
-            }
+            segment_updater.save_metas(opstamp, payload)?;
             let _ = garbage_collect_files(segment_updater.clone()).await;
             segment_updater.consider_merge_options().await;
             Ok(())
@@ -360,7 +428,7 @@ impl SegmentUpdater {
 
     pub(crate) fn make_merge_operation(&self, segment_ids: &[SegmentId]) -> MergeOperation {
         let commit_opstamp = self.load_metas().opstamp;
-        self.segment_manager.new_merge_operation(commit_opstamp, MergeCandidate(segment_ids.to_vec()))
+        MergeOperation::new(&self.merge_operations, commit_opstamp, segment_ids.to_vec())
     }
 
     // Starts a merge operation. This function will block until the merge operation is effectively
@@ -434,8 +502,9 @@ impl SegmentUpdater {
     }
 
     async fn consider_merge_options(&self) {
+        let merge_segment_ids: HashSet<SegmentId> = self.merge_operations.segment_in_merge();
         let (committed_segments, uncommitted_segments) =
-            self.segment_manager.segments_not_in_merge();
+            get_mergeable_segments(&merge_segment_ids, &self.segment_manager);
 
         // Committed segments cannot be merged with uncommitted_segments.
         // We therefore consider merges using these two sets of segments independently.
@@ -446,7 +515,7 @@ impl SegmentUpdater {
             .compute_merge_candidates(&uncommitted_segments)
             .into_iter()
             .map(|merge_candidate| {
-                self.segment_manager.new_merge_operation(current_opstamp, merge_candidate)
+                MergeOperation::new(&self.merge_operations, current_opstamp, merge_candidate.0)
             })
             .collect();
 
@@ -455,10 +524,9 @@ impl SegmentUpdater {
             .compute_merge_candidates(&committed_segments)
             .into_iter()
             .map(|merge_candidate: MergeCandidate| {
-                self.segment_manager.new_merge_operation(commit_opstamp, merge_candidate)
-            })
-            .collect::<Vec<_>>();
-        merge_candidates.extend(committed_merge_candidates.into_iter());
+                MergeOperation::new(&self.merge_operations, commit_opstamp, merge_candidate.0)
+            });
+        merge_candidates.extend(committed_merge_candidates);
 
         for merge_operation in merge_candidates {
             if let Err(err) = self.start_merge(merge_operation) {
@@ -480,17 +548,21 @@ impl SegmentUpdater {
         let end_merge_future = self.schedule_future(async move {
             info!("End merge {:?}", after_merge_segment_entry.meta());
             {
-                let mut delete_cursor = after_merge_segment_entry.delete_cursor();
+                let mut delete_cursor = after_merge_segment_entry.delete_cursor().clone();
                 if let Some(delete_operation) = delete_cursor.get() {
                     let committed_opstamp = segment_updater.load_metas().opstamp;
                     if delete_operation.opstamp < committed_opstamp {
-                        if let Err(e) =
-                            advance_deletes(&mut after_merge_segment_entry, committed_opstamp)
-                        {
+                        let index = &segment_updater.index;
+                        let segment = index.segment(after_merge_segment_entry.meta().clone());
+                        if let Err(advance_deletes_err) = advance_deletes(
+                            segment,
+                            &mut after_merge_segment_entry,
+                            committed_opstamp,
+                        ) {
                             error!(
                                 "Merge of {:?} was cancelled (advancing deletes failed): {:?}",
                                 merge_operation.segment_ids(),
-                                e
+                                advance_deletes_err
                             );
                             if cfg!(test) {
                                 panic!("Merge failed.");
@@ -498,7 +570,7 @@ impl SegmentUpdater {
                             // ... cancel merge
                             // `merge_operations` are tracked. As it is dropped, the
                             // the segment_ids will be available again for merge.
-                            return Err(e);
+                            return Err(advance_deletes_err);
                         }
                     }
                 }
@@ -524,7 +596,7 @@ impl SegmentUpdater {
     ///
     /// Upon termination of the current merging threads,
     /// merge opportunity may appear.
-    //
+    ///
     /// We keep waiting until the merge policy judges that
     /// no opportunity is available.
     ///
@@ -535,189 +607,209 @@ impl SegmentUpdater {
     ///
     /// Obsolete files will eventually be cleaned up
     /// by the directory garbage collector.
-    pub fn wait_merging_thread(&self) {
-        self.segment_manager.wait_merging_thread()
+    pub fn wait_merging_thread(&self) -> crate::Result<()> {
+        self.merge_operations.wait_until_empty();
+        Ok(())
     }
 }
 
 #[cfg(test)]
 mod tests {
-
+    use super::merge_segments;
+    use crate::directory::RAMDirectory;
     use crate::indexer::merge_policy::tests::MergeWheneverPossible;
     use crate::schema::*;
-    use crate::{Index, SegmentId};
-    use futures::executor::block_on;
+    use crate::Index;
 
     #[test]
-    fn test_delete_during_merge() {
+    fn test_delete_during_merge() -> crate::Result<()> {
         let mut schema_builder = Schema::builder();
         let text_field = schema_builder.add_text_field("text", TEXT);
-        let schema = schema_builder.build();
-
-        let index = Index::create_in_ram(schema);
+        let index = Index::create_in_ram(schema_builder.build());
 
         // writing the segment
-        let mut index_writer = index.writer_with_num_threads(1, 3_000_000).unwrap();
+        let mut index_writer = index.writer_for_tests()?;
         index_writer.set_merge_policy(Box::new(MergeWheneverPossible));
 
-        {
-            for _ in 0..100 {
-                index_writer.add_document(doc!(text_field=>"a"));
-                index_writer.add_document(doc!(text_field=>"b"));
-            }
-            assert!(index_writer.commit().is_ok());
+        for _ in 0..100 {
+            index_writer.add_document(doc!(text_field=>"a"));
+            index_writer.add_document(doc!(text_field=>"b"));
         }
+        index_writer.commit()?;
 
-        {
-            for _ in 0..100 {
-                index_writer.add_document(doc!(text_field=>"c"));
-                index_writer.add_document(doc!(text_field=>"d"));
-            }
-            assert!(index_writer.commit().is_ok());
+        for _ in 0..100 {
+            index_writer.add_document(doc!(text_field=>"c"));
+            index_writer.add_document(doc!(text_field=>"d"));
         }
+        index_writer.commit()?;
 
-        {
-            index_writer.add_document(doc!(text_field=>"e"));
-            index_writer.add_document(doc!(text_field=>"f"));
-            assert!(index_writer.commit().is_ok());
-        }
+        index_writer.add_document(doc!(text_field=>"e"));
+        index_writer.add_document(doc!(text_field=>"f"));
+        index_writer.commit()?;
 
-        {
-            let term = Term::from_field_text(text_field, "a");
-            index_writer.delete_term(term);
-            assert!(index_writer.commit().is_ok());
-        }
-        let reader = index.reader().unwrap();
+        let term = Term::from_field_text(text_field, "a");
+        index_writer.delete_term(term);
+        index_writer.commit()?;
+
+        let reader = index.reader()?;
         assert_eq!(reader.searcher().num_docs(), 302);
 
-        {
-            index_writer
-                .wait_merging_threads()
-                .expect("waiting for merging threads");
-        }
+        index_writer.wait_merging_threads()?;
 
-        reader.reload().unwrap();
+        reader.reload()?;
         assert_eq!(reader.searcher().segment_readers().len(), 1);
         assert_eq!(reader.searcher().num_docs(), 302);
+        Ok(())
     }
 
     #[test]
-    fn delete_all_docs() {
+    fn delete_all_docs() -> crate::Result<()> {
         let mut schema_builder = Schema::builder();
         let text_field = schema_builder.add_text_field("text", TEXT);
-        let schema = schema_builder.build();
-
-        let index = Index::create_in_ram(schema);
+        let index = Index::create_in_ram(schema_builder.build());
 
         // writing the segment
-        let mut index_writer = index.writer_with_num_threads(1, 3_000_000).unwrap();
+        let mut index_writer = index.writer_for_tests()?;
 
-        {
-            for _ in 0..100 {
-                index_writer.add_document(doc!(text_field=>"a"));
-                index_writer.add_document(doc!(text_field=>"b"));
-            }
-            assert!(index_writer.commit().is_ok());
+        for _ in 0..100 {
+            index_writer.add_document(doc!(text_field=>"a"));
+            index_writer.add_document(doc!(text_field=>"b"));
+        }
+        index_writer.commit()?;
+
+        for _ in 0..100 {
+            index_writer.add_document(doc!(text_field=>"c"));
+            index_writer.add_document(doc!(text_field=>"d"));
+        }
+        index_writer.commit()?;
+
+        index_writer.add_document(doc!(text_field=>"e"));
+        index_writer.add_document(doc!(text_field=>"f"));
+        index_writer.commit()?;
+
+        let seg_ids = index.searchable_segment_ids()?;
+        // docs exist, should have at least 1 segment
+        assert!(seg_ids.len() > 0);
+
+        let term_vals = vec!["a", "b", "c", "d", "e", "f"];
+        for term_val in term_vals {
+            let term = Term::from_field_text(text_field, term_val);
+            index_writer.delete_term(term);
+            index_writer.commit()?;
         }
 
-        {
-            for _ in 0..100 {
-                index_writer.add_document(doc!(text_field=>"c"));
-                index_writer.add_document(doc!(text_field=>"d"));
-            }
-            assert!(index_writer.commit().is_ok());
-        }
+        index_writer.wait_merging_threads()?;
 
-        {
-            index_writer.add_document(doc!(text_field=>"e"));
-            index_writer.add_document(doc!(text_field=>"f"));
-            assert!(index_writer.commit().is_ok());
-        }
-
-        {
-            let seg_ids = index
-                .searchable_segment_ids()
-                .expect("Searchable segments failed.");
-            // docs exist, should have at least 1 segment
-            assert!(seg_ids.len() > 0);
-        }
-
-        {
-            let term_vals = vec!["a", "b", "c", "d", "e", "f"];
-            for term_val in term_vals {
-                let term = Term::from_field_text(text_field, term_val);
-                index_writer.delete_term(term);
-                assert!(index_writer.commit().is_ok());
-            }
-        }
-
-        {
-            index_writer
-                .wait_merging_threads()
-                .expect("waiting for merging threads");
-        }
-
-        let reader = index.reader().unwrap();
+        let reader = index.reader()?;
         assert_eq!(reader.searcher().num_docs(), 0);
 
-        let seg_ids = index
-            .searchable_segment_ids()
-            .expect("Searchable segments failed.");
+        let seg_ids = index.searchable_segment_ids()?;
         assert!(seg_ids.is_empty());
 
-        reader.reload().unwrap();
+        reader.reload()?;
         assert_eq!(reader.searcher().num_docs(), 0);
         // empty segments should be erased
-        assert!(index.searchable_segment_metas().unwrap().is_empty());
+        assert!(index.searchable_segment_metas()?.is_empty());
         assert!(reader.searcher().segment_readers().is_empty());
+
+        Ok(())
     }
 
     #[test]
-    fn test_remove_all_segments() {
+    fn test_remove_all_segments() -> crate::Result<()> {
         let mut schema_builder = Schema::builder();
         let text_field = schema_builder.add_text_field("text", TEXT);
-        let schema = schema_builder.build();
-
-        let index = Index::create_in_ram(schema);
+        let index = Index::create_in_ram(schema_builder.build());
 
         // writing the segment
-        let mut index_writer = index.writer_with_num_threads(1, 3_000_000).unwrap();
-
-        {
-            for _ in 0..100 {
-                index_writer.add_document(doc!(text_field=>"a"));
-                index_writer.add_document(doc!(text_field=>"b"));
-            }
-            assert!(index_writer.commit().is_ok());
+        let mut index_writer = index.writer_for_tests()?;
+        for _ in 0..100 {
+            index_writer.add_document(doc!(text_field=>"a"));
+            index_writer.add_document(doc!(text_field=>"b"));
         }
+        index_writer.commit()?;
+
         index_writer.segment_updater().remove_all_segments();
         let seg_vec = index_writer
             .segment_updater()
             .segment_manager
             .segment_entries();
         assert!(seg_vec.is_empty());
+        Ok(())
     }
 
     #[test]
-    fn test_merge_over_soft_commit() {
+    fn test_merge_segments() -> crate::Result<()> {
+        let mut indices = vec![];
         let mut schema_builder = Schema::builder();
         let text_field = schema_builder.add_text_field("text", TEXT);
         let schema = schema_builder.build();
-        let index = Index::create_in_ram(schema);
-        // writing the segment
-        let mut index_writer = index.writer_with_num_threads(1, 3_000_000).unwrap();
-        index_writer.add_document(doc!(text_field=>"a"));
-        assert!(index_writer.soft_commit().is_ok());
-        index_writer.add_document(doc!(text_field=>"a"));
-        assert!(index_writer.soft_commit().is_ok());
 
-        let reader = index_writer.reader(1).unwrap();
-        let segment_ids: Vec<SegmentId> = reader
-            .searcher()
-            .segment_readers()
-            .iter()
-            .map(|reader| reader.segment_id())
-            .collect();
-        assert!(block_on(index_writer.merge(&segment_ids)).is_ok());
+        for _ in 0..3 {
+            let index = Index::create_in_ram(schema.clone());
+
+            // writing two segments
+            let mut index_writer = index.writer_for_tests()?;
+            for _ in 0..100 {
+                index_writer.add_document(doc!(text_field=>"fizz"));
+                index_writer.add_document(doc!(text_field=>"buzz"));
+            }
+            index_writer.commit()?;
+
+            for _ in 0..1000 {
+                index_writer.add_document(doc!(text_field=>"foo"));
+                index_writer.add_document(doc!(text_field=>"bar"));
+            }
+            index_writer.commit()?;
+            indices.push(index);
+        }
+
+        assert_eq!(indices.len(), 3);
+        let output_directory = RAMDirectory::default();
+        let index = merge_segments(&indices, output_directory)?;
+        assert_eq!(index.schema(), schema);
+
+        let segments = index.searchable_segments()?;
+        assert_eq!(segments.len(), 1);
+
+        let segment_metas = segments[0].meta();
+        assert_eq!(segment_metas.num_deleted_docs(), 0);
+        assert_eq!(segment_metas.num_docs(), 6600);
+        Ok(())
+    }
+
+    #[test]
+    fn test_merge_empty_indices_array() {
+        let merge_result = merge_segments(&[], RAMDirectory::default());
+        assert!(merge_result.is_err());
+    }
+
+    #[test]
+    fn test_merge_mismatched_schema() -> crate::Result<()> {
+        let first_index = {
+            let mut schema_builder = Schema::builder();
+            let text_field = schema_builder.add_text_field("text", TEXT);
+            let index = Index::create_in_ram(schema_builder.build());
+            let mut index_writer = index.writer_for_tests()?;
+            index_writer.add_document(doc!(text_field=>"some text"));
+            index_writer.commit()?;
+            index
+        };
+
+        let second_index = {
+            let mut schema_builder = Schema::builder();
+            let body_field = schema_builder.add_text_field("body", TEXT);
+            let index = Index::create_in_ram(schema_builder.build());
+            let mut index_writer = index.writer_for_tests()?;
+            index_writer.add_document(doc!(body_field=>"some body"));
+            index_writer.commit()?;
+            index
+        };
+
+        // mismatched schema index list
+        let result = merge_segments(&[first_index, second_index], RAMDirectory::default());
+        assert!(result.is_err());
+
+        Ok(())
     }
 }

src/indexer/segment_writer.rs

@@ -1,11 +1,9 @@
 use super::operation::AddOperation;
 use crate::core::Segment;
 use crate::core::SerializableSegment;
-use crate::directory::{SpillingResult, SpillingWriter, TerminatingWrite};
 use crate::fastfield::FastFieldsWriter;
-use crate::fieldnorm::FieldNormsWriter;
+use crate::fieldnorm::{FieldNormReaders, FieldNormsWriter};
 use crate::indexer::segment_serializer::SegmentSerializer;
-use crate::indexer::IndexWriterConfig;
 use crate::postings::compute_table_size;
 use crate::postings::MultiFieldPostingsWriter;
 use crate::schema::FieldType;
@@ -13,24 +11,19 @@ use crate::schema::Schema;
 use crate::schema::Term;
 use crate::schema::Value;
 use crate::schema::{Field, FieldEntry};
-use crate::store::StoreWriter;
 use crate::tokenizer::{BoxTokenStream, PreTokenizedStream};
-use crate::tokenizer::{FacetTokenizer, TextAnalyzer, TokenizerManager};
+use crate::tokenizer::{FacetTokenizer, TextAnalyzer};
 use crate::tokenizer::{TokenStreamChain, Tokenizer};
 use crate::Opstamp;
 use crate::{DocId, SegmentComponent};
-use std::io;
-use std::io::Write;
-use std::str;
-use crate::indexer::resource_manager::ResourceManager;
 
 /// Computes the initial size of the hash table.
 ///
 /// Returns a number of bit `b`, such that the recommended initial table size is 2^b.
-fn initial_table_size(per_thread_memory_budget: u64) -> crate::Result<usize> {
-    let table_memory_upper_bound = per_thread_memory_budget / 3u64;
+fn initial_table_size(per_thread_memory_budget: usize) -> crate::Result<usize> {
+    let table_memory_upper_bound = per_thread_memory_budget / 3;
     if let Some(limit) = (10..)
-        .take_while(|num_bits| compute_table_size(*num_bits) < table_memory_upper_bound)
+        .take_while(|num_bits: &usize| compute_table_size(*num_bits) < table_memory_upper_bound)
         .last()
     {
         Ok(limit.min(19)) // we cap it at 2^19 = 512K.
@@ -48,13 +41,12 @@ fn initial_table_size(per_thread_memory_budget: u64) -> crate::Result<usize> {
 pub struct SegmentWriter {
     max_doc: DocId,
     multifield_postings: MultiFieldPostingsWriter,
-    segment: Segment,
+    segment_serializer: SegmentSerializer,
     fast_field_writers: FastFieldsWriter,
     fieldnorms_writer: FieldNormsWriter,
     doc_opstamps: Vec<Opstamp>,
     tokenizers: Vec<Option<TextAnalyzer>>,
-    store_writer: StoreWriter<SpillingWriter>,
-    memory_manager: ResourceManager,
+    term_buffer: Term,
 }
 
 impl SegmentWriter {
@@ -68,13 +60,13 @@ impl SegmentWriter {
     /// - segment: The segment being written
     /// - schema
     pub fn for_segment(
-        config: &IndexWriterConfig,
+        memory_budget: usize,
         segment: Segment,
         schema: &Schema,
-        tokenizer_manager: &TokenizerManager,
-        memory_manager: ResourceManager
     ) -> crate::Result<SegmentWriter> {
-        let table_num_bits = initial_table_size(config.heap_size_in_byte_per_thread())?;
+        let tokenizer_manager = segment.index().tokenizers().clone();
+        let table_num_bits = initial_table_size(memory_budget)?;
+        let segment_serializer = SegmentSerializer::for_segment(segment)?;
         let multifield_postings = MultiFieldPostingsWriter::new(schema, table_num_bits);
         let tokenizers = schema
             .fields()
@@ -90,26 +82,15 @@ impl SegmentWriter {
                 },
             )
             .collect();
-        let mut segment_clone = segment.clone();
-        let spilling_wrt = SpillingWriter::new(
-            50_000_000,
-            Box::new(move || {
-                segment_clone
-                    .open_write(SegmentComponent::STORE)
-                    .map_err(|err| io::Error::new(io::ErrorKind::Other, err))
-            }),
-        );
-        let store_writer = StoreWriter::new(spilling_wrt);
         Ok(SegmentWriter {
             max_doc: 0,
             multifield_postings,
             fieldnorms_writer: FieldNormsWriter::for_schema(schema),
-            segment,
+            segment_serializer,
             fast_field_writers: FastFieldsWriter::from_schema(schema),
             doc_opstamps: Vec::with_capacity(1_000),
             tokenizers,
-            store_writer,
-            memory_manager
+            term_buffer: Term::new(),
         })
     }
 
@@ -117,40 +98,29 @@ impl SegmentWriter {
     ///
     /// Finalize consumes the `SegmentWriter`, so that it cannot
     /// be used afterwards.
-    pub fn finalize(mut self) -> crate::Result<(Segment, Vec<u64>)> {
+    pub fn finalize(mut self) -> crate::Result<Vec<u64>> {
         self.fieldnorms_writer.fill_up_to_max_doc(self.max_doc);
-        let spilling_wrt = self.store_writer.close()?;
-        let mut segment: Segment;
-        match spilling_wrt.finalize()? {
-            SpillingResult::Spilled => {
-                segment = self.segment.clone();
-            }
-            SpillingResult::Buffer(buf) => {
-                segment = self.segment.into_volatile(self.memory_manager.clone());
-                let mut store_wrt = segment.open_write(SegmentComponent::STORE)?;
-                store_wrt.write_all(&buf[..])?;
-                store_wrt.terminate()?;
-            }
-        }
-        let segment_serializer = SegmentSerializer::for_segment(&mut segment)?;
-        segment = segment.with_max_doc(self.max_doc);
         write(
             &self.multifield_postings,
             &self.fast_field_writers,
             &self.fieldnorms_writer,
-            segment_serializer,
+            self.segment_serializer,
         )?;
-        Ok((segment, self.doc_opstamps))
+        Ok(self.doc_opstamps)
     }
 
-    pub fn mem_usage(&self) -> u64 {
+    pub fn mem_usage(&self) -> usize {
         self.multifield_postings.mem_usage()
     }
 
     /// Indexes a new document
     ///
     /// As a user, you should rather use `IndexWriter`'s add_document.
-    pub fn add_document(&mut self, add_operation: AddOperation, schema: &Schema) -> io::Result<()> {
+    pub fn add_document(
+        &mut self,
+        add_operation: AddOperation,
+        schema: &Schema,
+    ) -> crate::Result<()> {
         let doc_id = self.max_doc;
         let mut doc = add_operation.document;
         self.doc_opstamps.push(add_operation.opstamp);
@@ -158,34 +128,45 @@ impl SegmentWriter {
         self.fast_field_writers.add_document(&doc);
 
         for (field, field_values) in doc.get_sorted_field_values() {
-            let field_options = schema.get_field_entry(field);
-            if !field_options.is_indexed() {
+            let field_entry = schema.get_field_entry(field);
+            let make_schema_error = || {
+                crate::TantivyError::SchemaError(format!(
+                    "Expected a {:?} for field {:?}",
+                    field_entry.field_type().value_type(),
+                    field_entry.name()
+                ))
+            };
+            if !field_entry.is_indexed() {
                 continue;
             }
-            match *field_options.field_type() {
-                FieldType::HierarchicalFacet => {
-                    let facets: Vec<&str> = field_values
-                        .iter()
-                        .flat_map(|field_value| match *field_value.value() {
-                            Value::Facet(ref facet) => Some(facet.encoded_str()),
-                            _ => {
-                                panic!("Expected hierarchical facet");
-                            }
-                        })
-                        .collect();
-                    let mut term = Term::for_field(field); // we set the Term
-                    for fake_str in facets {
+            let (term_buffer, multifield_postings) =
+                (&mut self.term_buffer, &mut self.multifield_postings);
+            match *field_entry.field_type() {
+                FieldType::HierarchicalFacet(_) => {
+                    term_buffer.set_field(field);
+                    let facets =
+                        field_values
+                            .iter()
+                            .flat_map(|field_value| match *field_value.value() {
+                                Value::Facet(ref facet) => Some(facet.encoded_str()),
+                                _ => {
+                                    panic!("Expected hierarchical facet");
+                                }
+                            });
+                    for facet_str in facets {
                         let mut unordered_term_id_opt = None;
-                        FacetTokenizer.token_stream(fake_str).process(&mut |token| {
-                            term.set_text(&token.text);
-                            let unordered_term_id =
-                                self.multifield_postings.subscribe(doc_id, &term);
-                            unordered_term_id_opt = Some(unordered_term_id);
-                        });
+                        FacetTokenizer
+                            .token_stream(facet_str)
+                            .process(&mut |token| {
+                                term_buffer.set_text(&token.text);
+                                let unordered_term_id =
+                                    multifield_postings.subscribe(doc_id, &term_buffer);
+                                unordered_term_id_opt = Some(unordered_term_id);
+                            });
                         if let Some(unordered_term_id) = unordered_term_id_opt {
                             self.fast_field_writers
                                 .get_multivalue_writer(field)
-                                .expect("multified writer for facet missing")
+                                .expect("writer for facet missing")
                                 .add_val(unordered_term_id);
                         }
                     }
@@ -202,7 +183,6 @@ impl SegmentWriter {
                                 if let Some(last_token) = tok_str.tokens.last() {
                                     total_offset += last_token.offset_to;
                                 }
-
                                 token_streams
                                     .push(PreTokenizedStream::from(tok_str.clone()).into());
                             }
@@ -212,7 +192,6 @@ impl SegmentWriter {
                                 {
                                     offsets.push(total_offset);
                                     total_offset += text.len();
-
                                     token_streams.push(tokenizer.token_stream(text));
                                 }
                             }
@@ -224,64 +203,77 @@ impl SegmentWriter {
                         0
                     } else {
                         let mut token_stream = TokenStreamChain::new(offsets, token_streams);
-                        self.multifield_postings
-                            .index_text(doc_id, field, &mut token_stream)
+                        multifield_postings.index_text(
+                            doc_id,
+                            field,
+                            &mut token_stream,
+                            term_buffer,
+                        )
                     };
 
                     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 {
-                            let term = Term::from_field_u64(
-                                field_value.field(),
-                                field_value.value().u64_value(),
-                            );
-                            self.multifield_postings.subscribe(doc_id, &term);
-                        }
+                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 {
-                            let term = Term::from_field_i64(
-                                field_value.field(),
-                                field_value.value().date_value().timestamp(),
-                            );
-                            self.multifield_postings.subscribe(doc_id, &term);
-                        }
+                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 {
-                            let term = Term::from_field_i64(
-                                field_value.field(),
-                                field_value.value().i64_value(),
-                            );
-                            self.multifield_postings.subscribe(doc_id, &term);
-                        }
+                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 {
-                            let term = Term::from_field_f64(
-                                field_value.field(),
-                                field_value.value().f64_value(),
-                            );
-                            self.multifield_postings.subscribe(doc_id, &term);
-                        }
+                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 => {
-                    // Do nothing. Bytes only supports fast fields.
+                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);
+                    }
                 }
             }
         }
         doc.filter_fields(|field| schema.get_field_entry(field).is_stored());
         doc.prepare_for_store();
-        self.store_writer.store(&doc)?;
+        let doc_writer = self.segment_serializer.get_store_writer();
+        doc_writer.store(&doc)?;
         self.max_doc += 1;
         Ok(())
     }
@@ -314,9 +306,16 @@ fn write(
     fieldnorms_writer: &FieldNormsWriter,
     mut serializer: SegmentSerializer,
 ) -> crate::Result<()> {
-    let term_ord_map = multifield_postings.serialize(serializer.get_postings_serializer())?;
+    if let Some(fieldnorms_serializer) = serializer.extract_fieldnorms_serializer() {
+        fieldnorms_writer.serialize(fieldnorms_serializer)?;
+    }
+    let fieldnorm_data = serializer
+        .segment()
+        .open_read(SegmentComponent::FIELDNORMS)?;
+    let fieldnorm_readers = FieldNormReaders::open(fieldnorm_data)?;
+    let term_ord_map =
+        multifield_postings.serialize(serializer.get_postings_serializer(), fieldnorm_readers)?;
     fast_field_writers.serialize(serializer.get_fast_field_serializer(), &term_ord_map)?;
-    fieldnorms_writer.serialize(serializer.get_fieldnorms_serializer())?;
     serializer.close()?;
     Ok(())
 }