Struct Document 

pub struct Document { /* private fields */ }

A document to be indexed

Implementations

impl Document

pub fn new() -> Self

pub fn add_text(&mut self, field: Field, value: impl Into<String>)

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

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

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

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

pub fn add_sparse_vector( &mut self, field: Field, indices: Vec<u32>, values: Vec<f32>, )

pub fn add_dense_vector(&mut self, field: Field, values: Vec<f32>)

pub fn add_json(&mut self, field: Field, value: Value)

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

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

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

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

Convert document to a JSON object using field names from schema

Fields marked as multi in the schema are always returned as JSON arrays. Other fields with multiple values are also returned as arrays. Fields with a single value (and not marked multi) are returned as scalar values.

pub fn from_json(json: &Value, schema: &Schema) -> Option<Self>

Create a Document from a JSON object using field names from schema

Supports:

• String values -> Text fields
• Number values -> U64/I64/F64 fields (based on schema type)
• Array values -> Multiple values for the same field (multifields)

Unknown fields (not in schema) are silently ignored.

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Document

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

Formats the value using the given formatter.

impl Default for Document

fn default() -> Document

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Document

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Document

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

where __S: Serializer,

Serialize this value into the given Serde serializer.