Struct tantivy::schema::Schema

pub struct Schema(_);

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 to a Field.

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

Return the field name for a given Field.

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 a named document off the doc.

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

Create a named document off 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.

Trait Implementations

impl Clone for Schema

fn clone(&self) -> Schema

Returns a copy of the value.

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<Schema> for Schema

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

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

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

This method tests for !=.

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 StructuralEq for Schema

impl StructuralPartialEq for Schema