Struct mongodb::options::CreateIndexOptions
source · [−]#[non_exhaustive]pub struct CreateIndexOptions {
pub commit_quorum: Option<CommitQuorum>,
pub max_time: Option<Duration>,
pub write_concern: Option<WriteConcern>,
}
Expand description
Specifies the options to a
Collection::create_index
or Collection:: create_indexes
operation.
For more information, see createIndexes
.
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
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.
Implementations
sourceimpl CreateIndexOptions
impl CreateIndexOptions
sourcepub fn builder() -> CreateIndexOptionsBuilder<((), (), ())>
pub fn builder() -> CreateIndexOptionsBuilder<((), (), ())>
Create a builder for building CreateIndexOptions
.
On the builder, call .commit_quorum(...)
(optional), .max_time(...)
(optional), .write_concern(...)
(optional) to set the values of the fields.
Finally, call .build()
to create the instance of CreateIndexOptions
.
Trait Implementations
sourceimpl Clone for CreateIndexOptions
impl Clone for CreateIndexOptions
sourcefn clone(&self) -> CreateIndexOptions
fn clone(&self) -> CreateIndexOptions
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for CreateIndexOptions
impl Debug for CreateIndexOptions
sourceimpl Default for CreateIndexOptions
impl Default for CreateIndexOptions
sourcefn default() -> CreateIndexOptions
fn default() -> CreateIndexOptions
Returns the “default value” for a type. Read more
sourceimpl Serialize for CreateIndexOptions
impl Serialize for CreateIndexOptions
Auto Trait Implementations
impl RefUnwindSafe for CreateIndexOptions
impl Send for CreateIndexOptions
impl Sync for CreateIndexOptions
impl Unpin for CreateIndexOptions
impl UnwindSafe for CreateIndexOptions
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more