Struct mongodb::options::CountOptions
source · [−]#[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>,
}
Expand description
Specifies the options to a
Collection::count_documents
operation.
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.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.
Implementations
sourceimpl CountOptions
impl CountOptions
sourcepub fn builder() -> CountOptionsBuilder<((), (), (), (), (), (), ())>
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) to set the values of the fields.
Finally, call .build()
to create the instance of CountOptions
.
Trait Implementations
sourceimpl Clone for CountOptions
impl Clone for CountOptions
sourcefn clone(&self) -> CountOptions
fn clone(&self) -> CountOptions
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 CountOptions
impl Debug for CountOptions
sourceimpl Default for CountOptions
impl Default for CountOptions
sourcefn default() -> CountOptions
fn default() -> CountOptions
Returns the “default value” for a type. Read more
sourceimpl<'de> Deserialize<'de> for CountOptions
impl<'de> Deserialize<'de> for CountOptions
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Auto Trait Implementations
impl !RefUnwindSafe for CountOptions
impl Send for CountOptions
impl Sync for CountOptions
impl Unpin for CountOptions
impl !UnwindSafe for CountOptions
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