Struct tantivy::schema::TextOptions
source · [−]pub struct TextOptions { /* private fields */ }
Expand description
Define how a text field should be handled by tantivy.
Implementations
sourceimpl TextOptions
impl TextOptions
sourcepub fn get_indexing_options(&self) -> Option<&TextFieldIndexing>
pub fn get_indexing_options(&self) -> Option<&TextFieldIndexing>
Returns the indexing options.
sourcepub fn set_fast(self) -> TextOptions
pub fn set_fast(self) -> 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 fast field will be a multivalued fast field.
The effective cardinality depends on the tokenizer. When creating fast fields on text fields it is recommended to use the “raw” tokenizer, since it will store the original text unchanged. The “default” tokenizer will store the terms as lower case and this will be reflected in the dictionary.
The original text can be retrieved via ord_to_term
from the dictionary.
sourcepub fn set_stored(self) -> TextOptions
pub fn set_stored(self) -> TextOptions
Sets the field as stored
sourcepub fn set_indexing_options(self, indexing: TextFieldIndexing) -> TextOptions
pub fn set_indexing_options(self, indexing: TextFieldIndexing) -> TextOptions
Sets the field as indexed, with the specific indexing options.
Trait Implementations
sourceimpl<T: Into<TextOptions>> BitOr<T> for TextOptions
impl<T: Into<TextOptions>> BitOr<T> for TextOptions
type Output = TextOptions
type Output = TextOptions
The resulting type after applying the |
operator.
sourcefn bitor(self, other: T) -> TextOptions
fn bitor(self, other: T) -> TextOptions
Performs the |
operation. Read more
sourceimpl Clone for TextOptions
impl Clone for TextOptions
sourcefn clone(&self) -> TextOptions
fn clone(&self) -> TextOptions
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for TextOptions
impl Debug for TextOptions
sourceimpl Default for TextOptions
impl Default for TextOptions
sourcefn default() -> TextOptions
fn default() -> TextOptions
Returns the “default value” for a type. Read more
sourceimpl<'de> Deserialize<'de> for TextOptions
impl<'de> Deserialize<'de> for TextOptions
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl From<()> for TextOptions
impl From<()> for TextOptions
sourcefn from(_: ()) -> TextOptions
fn from(_: ()) -> TextOptions
Converts to this type from the input type.
sourceimpl From<TextOptions> for JsonObjectOptions
impl From<TextOptions> for JsonObjectOptions
sourcefn from(text_options: TextOptions) -> Self
fn from(text_options: TextOptions) -> Self
Converts to this type from the input type.
sourceimpl PartialEq<TextOptions> for TextOptions
impl PartialEq<TextOptions> for TextOptions
sourcefn eq(&self, other: &TextOptions) -> bool
fn eq(&self, other: &TextOptions) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &TextOptions) -> bool
fn ne(&self, other: &TextOptions) -> bool
This method tests for !=
.
sourceimpl Serialize for TextOptions
impl Serialize for TextOptions
impl StructuralPartialEq for TextOptions
Auto Trait Implementations
impl RefUnwindSafe for TextOptions
impl Send for TextOptions
impl Sync for TextOptions
impl Unpin for TextOptions
impl UnwindSafe for TextOptions
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
sourcefn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
Convert Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
. Read more
sourcefn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more
sourcefn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
sourcefn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert &mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more
sourceimpl<T> DowncastSync for T where
T: Any + Send + Sync,
impl<T> DowncastSync for T where
T: Any + Send + Sync,
impl<T> Pointable for T
impl<T> Pointable for T
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more