Struct tantivy::schema::JsonObjectOptions

pub struct JsonObjectOptions { /* private fields */ }

The JsonObjectOptions make it possible to configure how a json object field should be indexed and stored.

Implementations

impl JsonObjectOptions

pub fn is_stored(&self) -> bool

Returns true if the json object should be stored.

pub fn is_indexed(&self) -> bool

Returns true iff the json object should be indexed.

pub fn is_fast(&self) -> bool

Returns true if and only if the json object fields are to be treated as fast fields.

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

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

pub fn is_expand_dots_enabled(&self) -> bool

Returns true iff dots in json keys should be expanded.

When expand_dots is enabled, json object like {"k8s.node.id": 5} is processed as if it was {"k8s": {"node": {"id": 5}}}. This option has the merit of allowing users to write queries like k8s.node.id:5. On the other, enabling that feature can lead to ambiguity.

If disabled, the “.” needs to be escaped: k8s\.node\.id:5.

pub fn set_expand_dots_enabled(self) -> Self

Sets expands_dots to true. See is_expand_dots_enabled for more information.

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

Returns the text indexing options.

If set to Some then both int and str values will be indexed. The inner TextFieldIndexing will however, only apply to the str values in the json object.

pub fn set_stored(self) -> Self

Sets the field as stored

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

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_indexing_options(self, indexing: TextFieldIndexing) -> Self

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

Trait Implementations

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

type Output = JsonObjectOptions

The resulting type after applying the | operator.

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

Performs the | operation.

impl Clone for JsonObjectOptions

fn clone(&self) -> JsonObjectOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JsonObjectOptions

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

Formats the value using the given formatter.

impl Default for JsonObjectOptions

fn default() -> JsonObjectOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for JsonObjectOptions

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<()> for JsonObjectOptions

fn from(_: ()) -> Self

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 JsonObjectOptions

fn eq(&self, other: &JsonObjectOptions) -> 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 JsonObjectOptions

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 JsonObjectOptions