Struct tantivy::schema::IntOptions

pub struct IntOptions { /* fields omitted */ }

Define how an int field should be handled by tantivy.

Methods

impl IntOptions

pub fn is_stored(&self) -> bool

Returns true iff the value is stored.

pub fn is_indexed(&self) -> bool

Returns true iff the value is indexed.

pub fn is_fast(&self) -> bool

Returns true iff the value is a fast field.

pub fn set_stored(self) -> IntOptions

Set the u64 options as stored.

Only the fields that are set as stored are persisted into the Tantivy's store.

pub fn set_indexed(self) -> IntOptions

Set the u64 options as indexed.

Setting an integer as indexed will generate a posting list for each value taken by the integer.

pub fn set_fast(self, cardinality: Cardinality) -> IntOptions

Set the u64 options as a single-valued fast field.

Fast fields are designed for random access. Access time are similar to a random lookup in an array. If more than one value is associated to a fast field, only the last one is kept.

pub fn get_fastfield_cardinality(&self) -> Option<Cardinality>

Returns the cardinality of the fastfield.

If the field has not been declared as a fastfield, then the method returns None.

Trait Implementations

impl Clone for IntOptions

fn clone(&self) -> IntOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IntOptions

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl PartialEq for IntOptions

fn eq(&self, __arg_0: &IntOptions) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, __arg_0: &IntOptions) -> bool

This method tests for !=.

impl Eq for IntOptions

impl Default for IntOptions

fn default() -> IntOptions

Returns the "default value" for a type.

impl BitOr for IntOptions

type Output = IntOptions

The resulting type after applying the | operator.

fn bitor(self, other: IntOptions) -> IntOptions

Performs the | operation.