Struct tantivy::schema::FieldEntry

source · [−]

pub struct FieldEntry { /* private fields */ }

Expand description

A FieldEntry represents a field and its configuration. Schema are a collection of FieldEntry

It consists of

a field name
a field type, itself wrapping up options describing how the field should be indexed.

Implementations

source

impl FieldEntry

source

pub fn new(field_name: String, field_type: FieldType) -> FieldEntry

Creates a new field entry given a name and a field type

source

pub fn new_text(field_name: String, text_options: TextOptions) -> FieldEntry

Creates a new text field entry.

source

pub fn new_u64(field_name: String, int_options: NumericOptions) -> FieldEntry

Creates a new u64 field entry.

source

pub fn new_i64(field_name: String, int_options: NumericOptions) -> FieldEntry

Creates a new i64 field entry.

source

pub fn new_f64(field_name: String, f64_options: NumericOptions) -> FieldEntry

Creates a new f64 field entry.

source

pub fn new_date(field_name: String, date_options: NumericOptions) -> FieldEntry

Creates a new date field entry.

source

pub fn new_facet(field_name: String, facet_options: FacetOptions) -> FieldEntry

Creates a field entry for a facet.

source

pub fn new_bytes(field_name: String, bytes_options: BytesOptions) -> FieldEntry

Creates a field entry for a bytes field

source

pub fn new_json(
field_name: String,
json_object_options: JsonObjectOptions
) -> FieldEntry

Creates a field entry for a json field

source

pub fn name(&self) -> &str

Returns the name of the field

source

pub fn field_type(&self) -> &FieldType

Returns the field type

source

pub fn is_indexed(&self) -> bool

Returns true if the field is indexed.

An indexed field is searchable.

source

pub fn has_fieldnorms(&self) -> bool

Returns true if the field is normed

source

pub fn is_fast(&self) -> bool

Returns true if the field is a int (signed or unsigned) fast field

source

pub fn is_stored(&self) -> bool

Returns true if the field is stored

Trait Implementations

source

impl Clone for FieldEntry

source

fn clone(&self) -> FieldEntry

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 FieldEntry

source

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

Formats the value using the given formatter. Read more

source

impl<'de> Deserialize<'de> for FieldEntry

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 PartialEq<FieldEntry> for FieldEntry

source

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

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

source

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

This method tests for !=.

source

impl Serialize for FieldEntry

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 StructuralPartialEq for FieldEntry

Auto Trait Implementations

impl RefUnwindSafe for FieldEntry

impl Send for FieldEntry

impl Sync for FieldEntry

impl Unpin for FieldEntry

impl UnwindSafe for FieldEntry

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::FieldEntry

Implementations

impl FieldEntry

pub fn new(field_name: String, field_type: FieldType) -> FieldEntry

pub fn new_text(field_name: String, text_options: TextOptions) -> FieldEntry

pub fn new_u64(field_name: String, int_options: NumericOptions) -> FieldEntry

pub fn new_i64(field_name: String, int_options: NumericOptions) -> FieldEntry

pub fn new_f64(field_name: String, f64_options: NumericOptions) -> FieldEntry

pub fn new_date(field_name: String, date_options: NumericOptions) -> FieldEntry

pub fn new_facet(field_name: String, facet_options: FacetOptions) -> FieldEntry

pub fn new_bytes(field_name: String, bytes_options: BytesOptions) -> FieldEntry

pub fn new_json( field_name: String, json_object_options: JsonObjectOptions) -> FieldEntry

pub fn name(&self) -> &str

pub fn field_type(&self) -> &FieldType

pub fn is_indexed(&self) -> bool

pub fn has_fieldnorms(&self) -> bool

pub fn is_fast(&self) -> bool

pub fn is_stored(&self) -> bool

Trait Implementations

impl Clone for FieldEntry

fn clone(&self) -> FieldEntry

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

impl Debug for FieldEntry

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

impl<'de> Deserialize<'de> for FieldEntry

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

impl PartialEq<FieldEntry> for FieldEntry

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

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

impl Serialize for FieldEntry

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

impl StructuralPartialEq for FieldEntry

Auto Trait Implementations

impl RefUnwindSafe for FieldEntry

impl Send for FieldEntry

impl Sync for FieldEntry

impl Unpin for FieldEntry

impl UnwindSafe for FieldEntry

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>,

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

pub fn new_json(
field_name: String,
json_object_options: JsonObjectOptions
) -> FieldEntry

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,