Enum mongodm::index::IndexOption

pub enum IndexOption {
    Background,
    Unique,
    Name(String),
    PartialFilterExpression(Document),
    Sparse,
    ExpireAfterSeconds(i32),
    StorageEngine(Document),
    Collation(Document),
    Custom {
        name: String,
        value: Bson,
    },
}

Option to be used at index creation.

Mongo manual

Variants

Background

Enable background builds

Unique

Creates a unique index

Name(String)

Name of the index

PartialFilterExpression(Document)

Only references documents that match the filter expression

Sparse

Only references documents with the specified field

ExpireAfterSeconds(i32)

TTL to control how long data is retained in the collectino

StorageEngine(Document)

Configure the storage engine

Collation(Document)

Specifies the collation

Custom

Specify a custom index option. This is present to provide forwards compatibility.

Fields of Custom

name: Stringvalue: Bson

Implementations

impl IndexOption

pub fn name(&self) -> &str

pub fn into_value(self) -> Bson

pub fn into_key_value(self) -> (String, Bson)

Trait Implementations

impl Clone for IndexOption

fn clone(&self) -> IndexOption

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IndexOption

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

Formats the value using the given formatter.