Re-exports§
pub use self::heed_codec::BEU16StrCodec;
pub use self::heed_codec::BEU32StrCodec;
pub use self::heed_codec::BoRoaringBitmapCodec;
pub use self::heed_codec::BoRoaringBitmapLenCodec;
pub use self::heed_codec::CboRoaringBitmapCodec;
pub use self::heed_codec::CboRoaringBitmapLenCodec;
pub use self::heed_codec::FieldIdWordCountCodec;
pub use self::heed_codec::ObkvCodec;
pub use self::heed_codec::RoaringBitmapCodec;
pub use self::heed_codec::RoaringBitmapLenCodec;
pub use self::heed_codec::StrBEU32Codec;
pub use self::heed_codec::U8StrStrCodec;
pub use self::heed_codec::UncheckedU8StrStrCodec;
pub use self::index::Index;
pub use self::update::ChannelCongestion;
pub use charabia as tokenizer;
pub use heed;
pub use rhai;
pub use arroy;
Modules§
- constants
- database_
stats - disabled_
typos_ terms - documents
- facet
- heed_
codec - index
- order_
by_ map - progress
- prompt
- proximity
- score_
details - update
- vector
Macros§
Structs§
- Attribute
Patterns - Default
Search Logger - A dummy
SearchLogger
which does nothing. - External
Documents Ids - Facet
Distribution - Facet
Value Hit - Fieldids
Weights Map - Fields
IdsMap - Filter
- Filter
Features - Filterable
Attributes Features - Filterable
Attributes Patterns - Format
Options - Global
Fields IdsMap - A fields ids map that can be globally updated to add fields
- Localized
Attributes Rule - A rule that defines which locales are supported for a given attribute.
- Match
Bounds - Matcher
Builder - Structure used to build a Matcher allowing to customize formatting tags.
- Matching
Words - Structure created from a query tree referencing words that match the given query tree.
- Panic
Catched - Search
- Search
Context - A structure used throughout the execution of a search query.
- Search
ForFacet Values - Search
Result - Semantic
Search - Similar
- Thread
Pool NoAbort - A rayon ThreadPool wrapper that can catch panics in the pool and modifies the install function accordingly.
- Thread
Pool NoAbort Builder - Time
Budget - Token
- Visual
Search Logger
Enums§
- AscDesc
- AscDesc
Error - This error type is never supposed to be shown to the end user. You must always cast it to a sort error or a criterion error.
- Compression
Type - The different supported types of compression.
- Condition
- Criterion
- Criterion
Error - Error
- Field
IdMap Missing Entry - Filter
Condition - Filterable
Attributes Rule - GeoSort
Strategy - Define the strategy used by the geo sort. The parameter represents the cache size, and, in the case of the Dynamic strategy, the point where we move from using the iterative strategy to the rtree.
- Internal
Error - Member
- OrderBy
- How should we fetch the facets?
- Pattern
Match - Serialization
Error - Sort
Error - Terms
Matching Strategy - User
Error
Constants§
- DEFAULT_
VALUES_ PER_ FACET - The default number of values by facets that will be fetched from the key-value store.
- MAX_
FACET_ VALUE_ LENGTH - The maximum length a field value can be when inserted in an LMDB key.
- MAX_
POSITION_ PER_ ATTRIBUTE - MAX_
WORD_ LENGTH - The maximum length a word can be
Traits§
- Search
Logger - Trait for structure logging the execution of a search query.
Functions§
- absolute_
from_ relative_ position - all_
obkv_ to_ json - Transform every field of a raw obkv store into a JSON Object.
- bucketed_
position - Compute the “bucketed” absolute position from the field id and relative position in the field.
- default_
criteria - distance_
between_ two_ points - Return the distance between two points in meters. Each points are composed of two f64, one latitude and one longitude.
- execute_
search - filtered_
universe - is_
faceted - Returns
true
if the field match one of the faceted fields. See the functionis_faceted_by
below to see what “matching” means. - is_
faceted_ by - Returns
true
if the field match the facet. - json_
to_ string - Transform a JSON value into a string that can be indexed.
- lat_
lng_ to_ xyz - Convert a point expressed in terms of latitude and longitude to a point in the cartesian coordinate expressed in terms of x, y and z.
- normalize_
facet - obkv_
to_ json - Transform a raw obkv store into a JSON Object.
- relative_
from_ absolute_ position
Type Aliases§
- Attribute
- BEU16
- BEU32
- BEU64
- Document
Id - Fast
Map4 - Fast
Map8 - Field
Distribution - FieldId
- GeoPoint
- A GeoPoint is a point in cartesian plan, called xyz_point in the code. Its metadata is a tuple composed of 1. the DocumentId of the associated document and 2. the original point expressed in term of latitude and longitude.
- Object
- Position
- Prefix
- Relative
Position - Result
- Small
String32 - Small
Vec8 - Small
Vec16 - Small
Vec32 - Span
- Weight