Struct avocado::prelude::IndexModel

pub struct IndexModel {
    pub keys: OrderedDocument,
    pub options: IndexOptions,
}

A single index model.

Fields

keys: OrderedDocument

options: IndexOptions

Methods

impl IndexModel

pub fn new(keys: OrderedDocument, options: Option<IndexOptions>) -> IndexModel

pub fn name(&self) -> Result<String, Error>

Returns the name of the index as specified by the options, or as automatically generated using the keys.

pub fn generate_index_name(&self) -> Result<String, Error>

Generates the index name from keys. Auto-generated names have the form "key1_val1_key2_val2..."

pub fn to_bson(&self) -> Result<OrderedDocument, Error>

Converts the model to its BSON document representation.

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 PartialEq<IndexModel> for IndexModel

fn eq(&self, other: &IndexModel) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &IndexModel) -> bool

This method tests for !=.

impl Debug for IndexModel

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

Formats the value using the given formatter.