Struct tantivy::schema::document::TantivyDocument

pub struct TantivyDocument { /* private fields */ }

TantivyDocument provides a default implementation of the Document trait. It is the object that can be indexed and then searched for.

Documents are fundamentally a collection of unordered couples (field, value). In this list, one field may appear more than once.

Implementations

impl TantivyDocument

pub fn new() -> TantivyDocument

Creates a new, empty document object

pub fn len(&self) -> usize

Returns the length of the document.

pub fn add_facet<F>(&mut self, field: Field, path: F)

where Facet: From<F>,

Adding a facet to the document.

pub fn add_text<S: ToString>(&mut self, field: Field, text: S)

Add a text field.

pub fn add_pre_tokenized_text( &mut self, field: Field, pre_tokenized_text: PreTokenizedString )

Add a pre-tokenized text field.

pub fn add_u64(&mut self, field: Field, value: u64)

Add a u64 field

pub fn add_ip_addr(&mut self, field: Field, value: Ipv6Addr)

Add a IP address field. Internally only Ipv6Addr is used.

pub fn add_i64(&mut self, field: Field, value: i64)

Add a i64 field

pub fn add_f64(&mut self, field: Field, value: f64)

Add a f64 field

pub fn add_bool(&mut self, field: Field, value: bool)

Add a bool field

pub fn add_date(&mut self, field: Field, value: DateTime)

Add a date field with unspecified time zone offset

pub fn add_bytes<T: Into<Vec<u8>>>(&mut self, field: Field, value: T)

Add a bytes field

pub fn add_object(&mut self, field: Field, object: BTreeMap<String, OwnedValue>)

Add a dynamic object field

pub fn add_field_value<T: Into<OwnedValue>>( &mut self, field: Field, typed_val: T )

Add a (field, value) to the document.

pub fn field_values(&self) -> &[FieldValue]

field_values accessor

pub fn get_all(&self, field: Field) -> impl Iterator<Item = &OwnedValue>

Returns all of the FieldValues associated the given field

pub fn get_first(&self, field: Field) -> Option<&OwnedValue>

Returns the first FieldValue associated the given field

pub fn convert_named_doc( schema: &Schema, named_doc: NamedFieldDocument ) -> Result<TantivyDocument, DocParsingError>

Create document from a named doc.

pub fn parse_json( schema: &Schema, doc_json: &str ) -> Result<TantivyDocument, DocParsingError>

Build a document object from a json-object.

pub fn from_json_object( schema: &Schema, json_obj: Map<String, Value> ) -> Result<TantivyDocument, DocParsingError>

Build a document object from a json-object.

Trait Implementations

impl Clone for TantivyDocument

fn clone(&self) -> TantivyDocument

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TantivyDocument

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

Formats the value using the given formatter.

impl Default for TantivyDocument

fn default() -> TantivyDocument

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TantivyDocument

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Document for TantivyDocument

type Value<'a> = &'a OwnedValue

The value of the field.

type FieldsValuesIter<'a> = FieldValueIter<'a>

The iterator over all of the fields and values within the doc.

fn iter_fields_and_values(&self) -> Self::FieldsValuesIter<'_>

Get an iterator iterating over all fields and values in a document.

fn get_sorted_field_values(&self) -> Vec<(Field, Vec<Self::Value<'_>>)>

Sort and groups the field_values by field.

fn to_named_doc(&self, schema: &Schema) -> NamedFieldDocument

Create a named document from the doc.

fn to_json(&self, schema: &Schema) -> String

Encode the doc in JSON.

impl DocumentDeserialize for TantivyDocument

fn deserialize<'de, D>(deserializer: D) -> Result<Self, DeserializeError>

where D: DocumentDeserializer<'de>,

Attempts to deserialize Self from a given document deserializer.

impl From<Vec<FieldValue>> for TantivyDocument

fn from(field_values: Vec<FieldValue>) -> Self

Converts to this type from the input type.

impl IntoIterator for TantivyDocument

type Item = FieldValue

The type of the elements being iterated over.

type IntoIter = IntoIter<FieldValue>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for TantivyDocument

fn eq(&self, other: &Self) -> 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 TantivyDocument

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for TantivyDocument