Module tantivy_fst::map

Map operations implemented by finite state transducers.

This API provided by this sub-module is close in spirit to the API provided by std::collections::BTreeMap.

Overview of types

Map is a read only interface to pre-constructed sets. MapBuilder is used to create new sets. (Once a set is created, it can never be modified.) Stream, Keys and Values are streams that originated from a map. StreamBuilder builds range queries. OpBuilder collects a set of streams and executes set operations like union or intersection on them with the option of specifying a merge strategy for a map's values. The rest of the types are streams for set operations.

Structs

Difference	A stream of set difference over multiple map streams in lexicographic order.
IndexedValue	A value indexed by a stream.
Intersection	A stream of set intersection over multiple map streams in lexicographic order.
Keys	A lexicographically ordered stream of keys from a map.
Map	Map is a lexicographically ordered map from byte strings to integers.
MapBuilder	A builder for creating a map.
OpBuilder	A builder for collecting map streams on which to perform set operations on the keys of maps.
Stream	A lexicographically ordered stream of key-value pairs from a map.
StreamBuilder	A builder for constructing range queries on streams.
StreamWithState	A lexicographically ordered stream of key-value from a map along with the states of the automaton.
StreamWithStateBuilder	A builder for constructing range queries of streams that returns results along with automaton states.
SymmetricDifference	A stream of set symmetric difference over multiple map streams in lexicographic order.
Union	A stream of set union over multiple map streams in lexicographic order.
Values	A stream of values from a map, lexicographically ordered by each value's corresponding key.