Enum TokenPositions 

#[non_exhaustive]
pub enum TokenPositions {
    Omit,
    Record,
}

Whether a text index records each token’s position (crate::Store::idx_create_text).

Positions let a phrase query verify that its words are adjacent; they cost the positional side-channel’s memory.

assert_eq!(kevy_embedded::TokenPositions::default(), kevy_embedded::TokenPositions::Omit);

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Omit

Index terms only. Term queries work as usual; a multi-word phrase query has no offsets to verify adjacency against and matches nothing.

use kevy_embedded::{Config, Store, TokenPositions};

let s = Store::open(Config::default())?;
s.idx_create_text(b"ft", b"doc:", &[(b"body", 1.0)], TokenPositions::Omit, &[])?;
s.hset(b"doc:1", &[(b"body", b"an engine written in rust")])?;
assert_eq!(s.idx_match(b"ft", b"rust engine", 10)?.len(), 1);
// no offsets were recorded, so no phrase can be verified
assert!(s.idx_match(b"ft", b"\"written in rust\"", 10)?.is_empty());

Record

Record token offsets, so phrase queries verify adjacency.

use kevy_embedded::{Config, Store, TokenPositions};

let s = Store::open(Config::default())?;
s.idx_create_text(b"ft", b"doc:", &[(b"body", 1.0)], TokenPositions::Record, &[])?;
s.hset(b"doc:1", &[(b"body", b"an engine written in rust")])?;
assert!(s.idx_match(b"ft", b"\"rust engine\"", 10)?.is_empty(), "not adjacent");
assert_eq!(s.idx_match(b"ft", b"\"written in rust\"", 10)?.len(), 1);

Trait Implementations

impl Clone for TokenPositions

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for TokenPositions

impl Debug for TokenPositions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TokenPositions

fn default() -> Self

Returns the “default value” for a type.

impl Eq for TokenPositions

impl Hash for TokenPositions

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for TokenPositions

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for TokenPositions