Struct mongodb::options::CreateIndexOptions

#[non_exhaustive]
pub struct CreateIndexOptions {
    pub commit_quorum: Option<CommitQuorum>,
    pub max_time: Option<Duration>,
    pub write_concern: Option<WriteConcern>,
    pub comment: Option<Bson>,
}

Specifies the options to a Collection::create_index or Collection:: create_indexes operation.

For more information, see createIndexes.

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.

commit_quorum: Option<CommitQuorum>

Specify the commit quorum needed to mark an index as ready.

max_time: Option<Duration>

The maximum amount of time to allow the index to build.

This option maps to the maxTimeMS MongoDB query option, so the duration will be sent across the wire as an integer number of milliseconds.

write_concern: Option<WriteConcern>

The write concern for the operation.

comment: Option<Bson>

Tags the query with an arbitrary Bson value to help trace the operation through the database profiler, currentOp and logs.

This option is only available on server versions 4.4+.

Implementations

impl CreateIndexOptions

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

Create a builder for building CreateIndexOptions. On the builder, call .commit_quorum(...)(optional), .max_time(...)(optional), .write_concern(...)(optional), .comment(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of CreateIndexOptions.

Trait Implementations

impl Clone for CreateIndexOptions

fn clone(&self) -> CreateIndexOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateIndexOptions

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

Formats the value using the given formatter.

impl Default for CreateIndexOptions

fn default() -> CreateIndexOptions

Returns the “default value” for a type.

impl Serialize for CreateIndexOptions

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

Serialize this value into the given Serde serializer.