Struct tantivy::schema::NumericOptions

source · [−]

pub struct NumericOptions { /* private fields */ }

Expand description

Define how an u64, i64, of f64 field should be handled by tantivy.

Implementations

source

impl NumericOptions

source

pub fn is_stored(&self) -> bool

Returns true iff the value is stored.

source

pub fn is_indexed(&self) -> bool

Returns true iff the value is indexed and therefore searchable.

source

pub fn fieldnorms(&self) -> bool

Returns true iff the field has fieldnorm.

source

pub fn is_multivalue_fast(&self) -> bool

Returns true iff the value is a fast field and multivalue.

source

pub fn is_fast(&self) -> bool

Returns true iff the value is a fast field.

source

pub fn set_stored(self) -> NumericOptions

Set the field as stored.

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

source

pub fn set_indexed(self) -> NumericOptions

Set the field as indexed.

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

This is required for the field to be searchable.

source

pub fn set_fieldnorm(self) -> NumericOptions

Set the field with fieldnorm.

Setting an integer as fieldnorm will generate the fieldnorm data for it.

source

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

Set the field 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.

source

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

source

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

type Output = NumericOptions

The resulting type after applying the | operator.

source

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

Performs the | operation. Read more

source

impl Clone for NumericOptions

source

fn clone(&self) -> NumericOptions

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for NumericOptions

source

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

Formats the value using the given formatter. Read more

source

impl Default for NumericOptions

source

fn default() -> NumericOptions

Returns the “default value” for a type. Read more

source

impl<'de> Deserialize<'de> for NumericOptions

source

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

source

impl From<()> for NumericOptions

source

fn from(_: ()) -> NumericOptions

Converts to this type from the input type.

source

impl PartialEq<NumericOptions> for NumericOptions

source

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

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

source

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

This method tests for !=.

source

impl Serialize for NumericOptions

source

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,

Serialize this value into the given Serde serializer. Read more

source

impl Eq for NumericOptions

source

impl StructuralEq for NumericOptions

source

impl StructuralPartialEq for NumericOptions

Auto Trait Implementations

impl RefUnwindSafe for NumericOptions

impl Send for NumericOptions

impl Sync for NumericOptions

impl Unpin for NumericOptions

impl UnwindSafe for NumericOptions

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> Downcast for T where
T: Any,

source

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

source

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

source

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

source

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

source

impl<T> DowncastSync for T where
T: Any + Send + Sync,

source

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync + 'static>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

source

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,

source

Struct tantivy::schema::NumericOptions

Implementations

impl NumericOptions

pub fn is_stored(&self) -> bool

pub fn is_indexed(&self) -> bool

pub fn fieldnorms(&self) -> bool

pub fn is_multivalue_fast(&self) -> bool

pub fn is_fast(&self) -> bool

pub fn set_stored(self) -> NumericOptions

pub fn set_indexed(self) -> NumericOptions

pub fn set_fieldnorm(self) -> NumericOptions

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

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

Trait Implementations

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

type Output = NumericOptions

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

impl Clone for NumericOptions

fn clone(&self) -> NumericOptions

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

impl Debug for NumericOptions

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

impl Default for NumericOptions

fn default() -> NumericOptions

impl<'de> Deserialize<'de> for NumericOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where __D: Deserializer<'de>,

impl From<()> for NumericOptions

fn from(_: ()) -> NumericOptions

impl PartialEq<NumericOptions> for NumericOptions

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

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

impl Serialize for NumericOptions

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

impl Eq for NumericOptions

impl StructuralEq for NumericOptions

impl StructuralPartialEq for NumericOptions

Auto Trait Implementations

impl RefUnwindSafe for NumericOptions

impl Send for NumericOptions

impl Sync for NumericOptions

impl Unpin for NumericOptions

impl UnwindSafe for NumericOptions

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> Downcast for T where T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

fn as_any(&self) -> &(dyn Any + 'static)

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

impl<T> DowncastSync for T where T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync + 'static>

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::()

type Init = T

unsafe fn init(init: <T as Pointable>::Init) -> usize

unsafe fn deref<'a>(ptr: usize) -> &'a T

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

unsafe fn drop(ptr: usize)

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> DeserializeOwned for T where T: for<'de> Deserialize<'de>,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
__D: Deserializer<'de>,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T> Downcast for T where
T: Any,

impl<T> DowncastSync for T where
T: Any + Send + Sync,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,

impl<T> Fruit for T where
T: Send + Downcast,