Struct tantivy::schema::FieldEntry

pub struct FieldEntry { /* private fields */ }

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

impl FieldEntry

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

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

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

Creates a new text field entry.

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

Creates a new u64 field entry.

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

Creates a new i64 field entry.

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

Creates a new f64 field entry.

pub fn new_bool(field_name: String, bool_options: NumericOptions) -> FieldEntry

Creates a new bool field entry.

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

Creates a new date field entry.

pub fn new_ip_addr(field_name: String, ip_options: IpAddrOptions) -> FieldEntry

Creates a new ip address field entry.

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

Creates a field entry for a facet.

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

Creates a field entry for a bytes field

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

Creates a field entry for a json 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 if the field is indexed.

An indexed field is searchable.

pub fn has_fieldnorms(&self) -> bool

Returns true if the field is normed

pub fn is_fast(&self) -> bool

Returns true if the field is a fast field

pub fn is_expand_dots_enabled(&self) -> bool

Returns true if the field has the expand dots option set (for json fields)

pub fn is_stored(&self) -> bool

Returns true if 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 Debug for FieldEntry

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

Formats the value using the given formatter.

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.

impl PartialEq 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: &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 FieldEntry

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 FieldEntry