Struct tantivy::schema::FieldEntry

pub struct FieldEntry { /* fields omitted */ }

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.

Methods

impl FieldEntry

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

Creates a new u64 field entry in the schema, given a name, and some options.

pub fn new_u64(field_name: String, field_type: IntOptions) -> FieldEntry

Creates a new u64 field entry in the schema, given a name, and some options.

pub fn new_i64(field_name: String, field_type: IntOptions) -> FieldEntry

Creates a new i64 field entry in the schema, given a name, and some options.

pub fn new_f64(field_name: String, field_type: IntOptions) -> FieldEntry

Creates a new f64 field entry in the schema, given a name, and some options.

pub fn new_date(field_name: String, field_type: IntOptions) -> FieldEntry

Creates a new date field entry in the schema, given a name, and some options.

pub fn new_facet(field_name: String) -> FieldEntry

Creates a field entry for a facet.

pub fn new_bytes(field_name: String) -> FieldEntry

Creates a field entry for a bytes field

pub fn name(&self) -> &str

Returns the name of the field

pub fn field_type(&self) -> &FieldType

Returns the field type

pub fn is_indexed(&self) -> bool

Returns true iff the field is indexed

pub fn is_int_fast(&self) -> bool

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

pub fn is_stored(&self) -> bool

Returns true iff the field is stored

Trait Implementations

impl Clone for FieldEntry

fn clone(&self) -> FieldEntry

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for FieldEntry

impl PartialEq<FieldEntry> for FieldEntry

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

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

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

This method tests for !=.

impl Debug for FieldEntry

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

Formats the value using the given formatter.

impl StructuralPartialEq for FieldEntry

impl StructuralEq for FieldEntry

impl Serialize for FieldEntry

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

Serialize this value into the given Serde serializer.

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

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

Deserialize this value from the given Serde deserializer.