Struct mongodb::IndexModel

#[non_exhaustive]
pub struct IndexModel {
    pub keys: Document,
    pub options: Option<IndexOptions>,
}

Specifies the fields and options for an index. For more information, see the documentation.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

keys: Document

Specifies the index’s fields. For each field, specify a key-value pair in which the key is the name of the field to index and the value is index type.

options: Option<IndexOptions>

The options for the index.

Implementations

impl IndexModel

pub fn builder() -> IndexModelBuilder<((), ())>

Create a builder for building IndexModel. On the builder, call .keys(...)(optional), .options(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of IndexModel.

Trait Implementations

impl Clone for IndexModel

fn clone(&self) -> IndexModel

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IndexModel

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

Formats the value using the given formatter.

impl Default for IndexModel

fn default() -> IndexModel

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for IndexModel

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for IndexModel

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

Serialize this value into the given Serde serializer.