Struct SurferSchema 

pub struct SurferSchema { /* private fields */ }

Implementations

impl SurferSchema

pub fn new( schema: Schema, mappings: HashMap<String, SurferFieldTypes>, track_tf: bool, track_tf_idf: bool, ) -> Self

pub fn resolve_mapping(&self) -> &HashMap<String, SurferFieldTypes>

Methods from Deref<Target = 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 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.

Examples found in repository

examples/04_binary_data.rs (line 47)

fn main() {
    println!("This example is here to demonstrate that Tantivy does not support stored bytes yet");
    // Build Container
    let data = Container::default();
    let value = serde_value::to_value(data).expect("[Cough]");
    let json_doc = serde_json::to_string(&value).expect("[Cough Again]");
    println!("Json: {}", json_doc);

    // Build Schema
    let mut builder = Schema::builder();
    // Is there any alternate way or just not supported?
    // src/schema/field_type.rs:32 - FieldType maps to Type which say Vec<u8>
    let field_name = "buffer".to_string();
    let entry = FieldEntry::new_bytes(field_name);
    let _ = builder.add_field(entry);

    let text_options = TextOptions::default();
    let field_name = "labels".to_string();
    let entry = FieldEntry::new_text(field_name, text_options);
    let _ = builder.add_field(entry);

    let schema = builder.build();
    let document = schema.parse_document(&json_doc).expect("[Dies Coughing]");
    println!("Document: {:#?}", document);
}

Trait Implementations

impl Clone for SurferSchema

fn clone(&self) -> SurferSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SurferSchema

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

Formats the value using the given formatter.

impl Deref for SurferSchema

type Target = Schema

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for SurferSchema

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Display for SurferSchema

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

Formats the value using the given formatter.

impl PartialEq for SurferSchema

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

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

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 Eq for SurferSchema

impl StructuralPartialEq for SurferSchema