Struct mongodm::index::Index

pub struct Index { /* fields omitted */ }

Specify field to be used for indexing and options.

Mongo manual

Example

use mongodm::{Index, SortOrder, IndexOption, mongo::bson::doc};

let index = Index::new_with_direction("username", SortOrder::Descending)
    .with_key("last_seen") // compound with last_seen
    .with_option(IndexOption::Unique);

let doc = index.into_document();

assert_eq!(
    doc,
    doc! {
        "key": { "username": -1, "last_seen": 1 },
        "unique": true,
        "name": "username_-1_last_seen_1",
    }
)

Implementations

impl Index

pub fn new(key: impl Into<Cow<'static, str>>) -> Self

Make a new index for the given key with ascending direction.

Mongo manual

pub fn new_with_direction(
    key: impl Into<Cow<'static, str>>,
    direction: SortOrder
) -> Self

Make a new index for the given key with a direction.

Mongo manual

pub fn add_key(&mut self, key: impl Into<Cow<'static, str>>)

Make this index compound adding the given key with ascending direction.

Mongo manual.

pub fn with_key(self, key: impl Into<Cow<'static, str>>) -> Self

Builder style method for add_key.

pub fn add_key_with_direction(
    &mut self,
    key: impl Into<Cow<'static, str>>,
    direction: SortOrder
)

Make this index compound adding the given key with a direction.

Mongo manual.

pub fn with_key_with_direction(
    self,
    key: impl Into<Cow<'static, str>>,
    direction: SortOrder
) -> Self

Builder style method for add_key_with_direction.

pub fn add_option(&mut self, option: IndexOption)

Add an option to this index.

Mongo manual

pub fn with_option(self, option: IndexOption) -> Self

Builder style method for add_option.

pub fn into_document(self) -> Document

Convert this structure into a Document version structured as expected by mongo.

Trait Implementations

impl Clone for Index

fn clone(&self) -> Index

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Index

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

Formats the value using the given formatter.

impl Default for Index

fn default() -> Index

Returns the “default value” for a type.