Struct CollectionSchema

pub struct CollectionSchema {
    pub default_sorting_field: Option<String>,
    pub enable_nested_fields: Option<bool>,
    pub fields: Vec<Field>,
    pub name: String,
    pub symbols_to_index: Option<Vec<String>>,
    pub token_separators: Option<Vec<String>>,
    pub voice_query_model: Option<Box<VoiceQueryModelCollectionConfig>>,
}

Fields

default_sorting_field: Option<String>

The name of an int32 / float field that determines the order in which the search results are ranked when a sort_by clause is not provided during searching. This field must indicate some kind of popularity.

enable_nested_fields: Option<bool>

Enables experimental support at a collection level for nested object or object array fields. This field is only available if the Typesense server is version 0.24.0.rcn34 or later.

fields: Vec<Field>

A list of fields for querying, filtering and faceting

name: String

Name of the collection

symbols_to_index: Option<Vec<String>>

List of symbols or special characters to be indexed.

token_separators: Option<Vec<String>>

List of symbols or special characters to be used for splitting the text into individual words in addition to space and new-line characters.

voice_query_model: Option<Box<VoiceQueryModelCollectionConfig>>

Implementations

impl CollectionSchema

pub fn new(fields: Vec<Field>, name: String) -> CollectionSchema

Trait Implementations

impl Clone for CollectionSchema

fn clone(&self) -> CollectionSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CollectionSchema

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

Formats the value using the given formatter.

impl Default for CollectionSchema

fn default() -> CollectionSchema

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CollectionSchema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CollectionSchema

fn eq(&self, other: &CollectionSchema) -> 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 Serialize for CollectionSchema

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CollectionSchema