Struct Schema

pub struct Schema(/* private fields */);

Tantivy has a very strict schema. You need to specify in advance, whether a field is indexed or not, stored or not, and RAM-based or not.

This is done by creating a schema object, and setting up the fields one by one. It is for the moment impossible to remove fields.

Examples

use tantivy::schema::*;

let mut schema_builder = Schema::builder();
let id_field = schema_builder.add_text_field("id", STRING);
let title_field = schema_builder.add_text_field("title", TEXT);
let body_field = schema_builder.add_text_field("body", TEXT);
let schema = schema_builder.build();

Implementations

impl Schema

pub fn get_field_entry(&self, field: Field) -> &FieldEntry

Return the FieldEntry associated with a Field.

pub fn get_field_name(&self, field: Field) -> &str

Return the field name for a given Field.

pub fn num_fields(&self) -> usize

Returns the number of fields in the schema.

pub fn fields(&self) -> impl Iterator<Item = (Field, &FieldEntry)>

Return the list of all the Fields.

pub fn builder() -> SchemaBuilder

Creates a new builder.

pub fn get_field(&self, field_name: &str) -> Option<Field>

Returns the field option associated with a given name.

pub fn convert_named_doc( &self, named_doc: NamedFieldDocument, ) -> Result<Document, DocParsingError>

Create document from a named doc.

pub fn to_named_doc(&self, doc: &Document) -> NamedFieldDocument

Create a named document from the doc.

pub fn to_json(&self, doc: &Document) -> String

Encode the schema in JSON.

Encoding a document cannot fail.

pub fn parse_document( &self, doc_json: &str, ) -> Result<Document, DocParsingError>

Build a document object from a json-object.

pub fn json_object_to_doc( &self, json_obj: Map<String, JsonValue>, ) -> Result<Document, DocParsingError>

Build a document object from a json-object.

pub fn find_field<'a>(&self, full_path: &'a str) -> Option<(Field, &'a str)>

Searches for a full_path in the schema, returning the field name and a JSON path.

This function works by checking if the field exists for the exact given full_path. If it’s not, it splits the full_path at non-escaped ‘.’ chars and tries to match the prefix with the field names, favoring the longest field names.

This does not check if field is a JSON field. It is possible for this functions to return a non-empty JSON path with a non-JSON field.

Trait Implementations

impl Clone for Schema

fn clone(&self) -> Schema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Schema

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Schema

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Schema

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Schema

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 Schema

impl StructuralPartialEq for Schema