Struct mongodb::options::EstimatedDocumentCountOptions

#[non_exhaustive]
pub struct EstimatedDocumentCountOptions {
    pub max_time: Option<Duration>,
    pub selection_criteria: Option<SelectionCriteria>,
    pub read_concern: Option<ReadConcern>,
    pub comment: Option<Bson>,
}

Specifies the options to a Collection::estimated_document_count operation.

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.

max_time: Option<Duration>

The maximum amount of time to allow the query to run.

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

selection_criteria: Option<SelectionCriteria>

The criteria used to select a server for this operation.

If none specified, the default set on the collection will be used.

read_concern: Option<ReadConcern>

The level of the read concern.

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 supported on server versions 4.4+. The comment can be any Bson value on server versions 4.4.14+. On server versions between 4.4.0 and 4.4.14, only Bson::String values are supported.

Implementations

impl EstimatedDocumentCountOptions

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

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

Trait Implementations

impl Clone for EstimatedDocumentCountOptions

fn clone(&self) -> EstimatedDocumentCountOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EstimatedDocumentCountOptions

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

Formats the value using the given formatter.

impl Default for EstimatedDocumentCountOptions

fn default() -> EstimatedDocumentCountOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EstimatedDocumentCountOptions

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

Deserialize this value from the given Serde deserializer.

impl Serialize for EstimatedDocumentCountOptions

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

Serialize this value into the given Serde serializer.