Struct tantivy::schema::TextOptions

pub struct TextOptions { /* private fields */ }

Define how a text field should be handled by tantivy.

Implementations

impl TextOptions

pub fn get_indexing_options(&self) -> Option<&TextFieldIndexing>

Returns the indexing options.

pub fn is_stored(&self) -> bool

Returns true if the text is to be stored.

pub fn is_fast(&self) -> bool

Returns true if and only if the value is a fast field.

pub fn get_fast_field_tokenizer_name(&self) -> Option<&str>

Returns true if and only if the value is a fast field.

pub fn should_coerce(&self) -> bool

Returns true if values should be coerced to strings (numbers, null).

pub fn set_fast(self, tokenizer_name: Option<&str>) -> TextOptions

Set the field as a fast field.

Fast fields are designed for random access. Access time are similar to a random lookup in an array. Text fast fields will have the term ids stored in the fast field.

The effective cardinality depends on the tokenizer. Without a tokenizer, the text will be stored as is, which equals to the “raw” tokenizer. The tokenizer can be used to apply normalization like lower case. The passed tokenizer_name must be available on the fast field tokenizer manager. Index::fast_field_tokenizer.

The original text can be retrieved via TermDictionary::ord_to_term() from the dictionary.

pub fn set_coerce(self) -> TextOptions

Coerce values if they are not of type string. Defaults to false.

pub fn set_stored(self) -> TextOptions

Sets the field as stored.

pub fn set_indexing_options(self, indexing: TextFieldIndexing) -> TextOptions

Sets the field as indexed, with the specific indexing options.

Trait Implementations

impl<T: Into<TextOptions>> BitOr<T> for TextOptions

type Output = TextOptions

The resulting type after applying the | operator.

fn bitor(self, other: T) -> TextOptions

Performs the | operation.

impl Clone for TextOptions

fn clone(&self) -> TextOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TextOptions

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

Formats the value using the given formatter.

impl Default for TextOptions

fn default() -> TextOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TextOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<()> for TextOptions

fn from(_: ()) -> TextOptions

Converts to this type from the input type.

impl From<TextOptions> for JsonObjectOptions

fn from(text_options: TextOptions) -> Self

Converts to this type from the input type.

impl PartialEq for TextOptions

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for TextOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TextOptions