Struct Field

pub struct Field {

    pub drop: Option<bool>,
    pub embed: Option<Box<FieldEmbed>>,
    pub facet: Option<bool>,
    pub index: Option<bool>,
    pub infix: Option<bool>,
    pub locale: Option<String>,
    pub name: String,
    pub num_dim: Option<i32>,
    pub optional: Option<bool>,
    pub range_index: Option<bool>,
    pub reference: Option<String>,
    pub sort: Option<bool>,
    pub stem: Option<bool>,
    pub store: Option<bool>,
    pub type: String,
    pub vec_dist: Option<String>,
}

Fields

drop: Option<bool>

embed: Option<Box<FieldEmbed>>

facet: Option<bool>

index: Option<bool>

infix: Option<bool>

locale: Option<String>

name: String

num_dim: Option<i32>

optional: Option<bool>

range_index: Option<bool>

Enables an index optimized for range filtering on numerical fields (e.g. rating:>3.5). Default: false.

reference: Option<String>

Name of a field in another collection that should be linked to this collection so that it can be joined during query.

sort: Option<bool>

stem: Option<bool>

Values are stemmed before indexing in-memory. Default: false.

store: Option<bool>

When set to false, the field value will not be stored on disk. Default: true.

type: String

vec_dist: Option<String>

The distance metric to be used for vector search. Default: cosine. You can also use ip for inner product.

Implementations

impl Field

pub fn new(name: String, type: String) -> Field

Trait Implementations

impl Clone for Field

fn clone(&self) -> Field

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Field

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

Formats the value using the given formatter.

impl Default for Field

fn default() -> Field

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Field

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Field

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

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 Field