Struct mongodb::options::AggregateOptions [−][src]
#[non_exhaustive]pub struct AggregateOptions { pub allow_disk_use: Option<bool>, pub batch_size: Option<u32>, pub bypass_document_validation: Option<bool>, pub collation: Option<Collation>, pub comment: Option<String>, pub hint: Option<Hint>, pub max_await_time: Option<Duration>, pub max_time: Option<Duration>, pub read_concern: Option<ReadConcern>, pub selection_criteria: Option<SelectionCriteria>, pub write_concern: Option<WriteConcern>, }
Expand description
Specifies the options to a Collection::aggregate
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.allow_disk_use: Option<bool>
Expand description
Enables writing to temporary files. When set to true, aggregation stages can write data to the _tmp subdirectory in the dbPath directory.
batch_size: Option<u32>
Expand description
The number of documents the server should return per cursor batch.
Note that this does not have any affect on the documents that are returned by a cursor, only the number of documents kept in memory at a given time (and by extension, the number of round trips needed to return the entire set of documents returned by the query).
bypass_document_validation: Option<bool>
Expand description
Opt out of document-level validation.
collation: Option<Collation>
Expand description
The collation to use for the operation.
See the documentation for more information on how to use this option.
comment: Option<String>
Expand description
Tags the query with an arbitrary string to help trace the operation through the database profiler, currentOp and logs.
hint: Option<Hint>
Expand description
The index to use for the operation.
max_await_time: Option<Duration>
Expand description
The maximum amount of time for the server to wait on new documents to satisfy a tailable await cursor query.
This option will have no effect on non-tailable cursors that result from this operation.
max_time: Option<Duration>
Expand description
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.
read_concern: Option<ReadConcern>
Expand description
The read concern to use for the operation.
If none is specified, the read concern defined on the object executing this operation will be used.
selection_criteria: Option<SelectionCriteria>
Expand description
The criteria used to select a server for this operation.
If none is specified, the selection criteria defined on the object executing this operation will be used.
write_concern: Option<WriteConcern>
Expand description
The write concern to use for the operation.
If none is specified, the write concern defined on the object executing this operation will be used.
Implementations
impl AggregateOptions
[src]
impl AggregateOptions
[src]pub fn builder(
) -> AggregateOptionsBuilder<((), (), (), (), (), (), (), (), (), (), ())>
[src]
pub fn builder(
) -> AggregateOptionsBuilder<((), (), (), (), (), (), (), (), (), (), ())>
[src]Create a builder for building AggregateOptions
.
On the builder, call .allow_disk_use(...)
(optional), .batch_size(...)
(optional), .bypass_document_validation(...)
(optional), .collation(...)
(optional), .comment(...)
(optional), .hint(...)
(optional), .max_await_time(...)
(optional), .max_time(...)
(optional), .read_concern(...)
(optional), .selection_criteria(...)
(optional), .write_concern(...)
(optional) to set the values of the fields.
Finally, call .build()
to create the instance of AggregateOptions
.
Trait Implementations
impl Clone for AggregateOptions
[src]
impl Clone for AggregateOptions
[src]fn clone(&self) -> AggregateOptions
[src]
fn clone(&self) -> AggregateOptions
[src]Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]Performs copy-assignment from source
. Read more
impl Debug for AggregateOptions
[src]
impl Debug for AggregateOptions
[src]impl Default for AggregateOptions
[src]
impl Default for AggregateOptions
[src]fn default() -> AggregateOptions
[src]
fn default() -> AggregateOptions
[src]Returns the “default value” for a type. Read more
impl<'de> Deserialize<'de> for AggregateOptions
[src]
impl<'de> Deserialize<'de> for AggregateOptions
[src]fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]Deserialize this value from the given Serde deserializer. Read more
impl Serialize for AggregateOptions
[src]
impl Serialize for AggregateOptions
[src]Auto Trait Implementations
impl !RefUnwindSafe for AggregateOptions
impl Send for AggregateOptions
impl Sync for AggregateOptions
impl Unpin for AggregateOptions
impl !UnwindSafe for AggregateOptions
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> Instrument for T
[src]
impl<T> Instrument for T
[src]fn instrument(self, span: Span) -> Instrumented<Self>
[src]
fn instrument(self, span: Span) -> Instrumented<Self>
[src]Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
fn in_current_span(self) -> Instrumented<Self>
[src]
fn in_current_span(self) -> Instrumented<Self>
[src]impl<T> Same<T> for T
impl<T> Same<T> for T
type Output = T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
pub fn vzip(self) -> V
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,