Struct mongodb::options::CountOptions

#[non_exhaustive]
pub struct CountOptions {
    pub hint: Option<Hint>,
    pub limit: Option<u64>,
    pub max_time: Option<Duration>,
    pub skip: Option<u64>,
    pub collation: Option<Collation>,
    pub selection_criteria: Option<SelectionCriteria>,
    pub read_concern: Option<ReadConcern>,
    pub comment: Option<Bson>,
}

Specifies the options to a Collection::count_documents 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.

hint: Option<Hint>

The index to use for the operation.

limit: Option<u64>

The maximum number of documents to count.

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.

skip: Option<u64>

The number of documents to skip before counting.

collation: Option<Collation>

The collation to use for the operation.

See the documentation for more information on how to use this option.

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 available on server versions 4.4+.

Implementations

impl CountOptions

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

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

Trait Implementations

impl Clone for CountOptions

fn clone(&self) -> CountOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CountOptions

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

Formats the value using the given formatter.

impl Default for CountOptions

fn default() -> CountOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CountOptions

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

Deserialize this value from the given Serde deserializer.