Struct mongodb::action::Aggregate

pub struct Aggregate<'a, Session = ImplicitSession, T = Document> { /* private fields */ }

Run an aggregation operation. Construct with Database::aggregate or Collection::aggregate.

Implementations

impl<'a, Session, T> Aggregate<'a, Session, T>

pub fn with_options(self, value: impl Into<Option<AggregateOptions>>) -> Self

Set all options. Note that this will replace all previous values set.

pub fn allow_disk_use(self, value: bool) -> Self

Set the AggregateOptions::allow_disk_use option.

pub fn batch_size(self, value: u32) -> Self

Set the AggregateOptions::batch_size option.

pub fn bypass_document_validation(self, value: bool) -> Self

Set the AggregateOptions::bypass_document_validation option.

pub fn collation(self, value: Collation) -> Self

Set the AggregateOptions::collation option.

pub fn comment(self, value: impl Into<Bson>) -> Self

Set the AggregateOptions::comment option.

pub fn hint(self, value: Hint) -> Self

Set the AggregateOptions::hint option.

pub fn max_await_time(self, value: Duration) -> Self

Set the AggregateOptions::max_await_time option.

pub fn max_time(self, value: Duration) -> Self

Set the AggregateOptions::max_time option.

pub fn read_concern(self, value: ReadConcern) -> Self

Set the AggregateOptions::read_concern option.

pub fn selection_criteria(self, value: SelectionCriteria) -> Self

Set the AggregateOptions::selection_criteria option.

pub fn write_concern(self, value: WriteConcern) -> Self

Set the AggregateOptions::write_concern option.

pub fn let_vars(self, value: Document) -> Self

Set the AggregateOptions::let_vars option.

impl<'a, T> Aggregate<'a, ImplicitSession, T>

pub fn session( self, value: impl Into<&'a mut ClientSession>, ) -> Aggregate<'a, ExplicitSession<'a>>

Use the provided session when running the operation.

impl<'a, Session, T> Aggregate<'a, Session, T>

pub fn with_type<U>(self) -> Aggregate<'a, Session, U>

Use the provided type for the returned cursor.

#[derive(Deserialize)]
struct PipelineOutput {
    len: usize,
}

let aggregate_cursor = database
    .aggregate(pipeline)
    .with_type::<PipelineOutput>()
    .await?;
let aggregate_results: Vec<PipelineOutput> = aggregate_cursor.try_collect().await?;

impl<'a, T> Aggregate<'a, ImplicitSession, T>

pub fn run(self) -> Result<Cursor<T>>

Available on crate feature sync only.

Synchronously execute this action.

impl<'a, T> Aggregate<'a, ExplicitSession<'a>, T>

pub fn run(self) -> Result<SessionCursor<T>>

Available on crate feature sync only.

Synchronously execute this action.

Trait Implementations

impl<'a, T> Action for Aggregate<'a, ExplicitSession<'a>, T>

fn optional<Value>( self, value: Option<Value>, f: impl FnOnce(Self, Value) -> Self, ) -> Self

where Self: Sized,

If the value is Some, call the provided function on self. Convenient for chained updates with values that need to be set conditionally. For example:

impl<'a, T> Action for Aggregate<'a, ImplicitSession, T>

fn optional<Value>( self, value: Option<Value>, f: impl FnOnce(Self, Value) -> Self, ) -> Self

where Self: Sized,

If the value is Some, call the provided function on self. Convenient for chained updates with values that need to be set conditionally. For example:

impl<'a, T> IntoFuture for Aggregate<'a, ExplicitSession<'a>, T>

type Output = Result<SessionCursor<T>, Error>

The output that the future will produce on completion.

type IntoFuture = AggregateSessionFuture<'a, T>

Which kind of future are we turning this into?

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.

impl<'a, T> IntoFuture for Aggregate<'a, ImplicitSession, T>

type Output = Result<Cursor<T>, Error>

The output that the future will produce on completion.

type IntoFuture = AggregateFuture<'a, T>

Which kind of future are we turning this into?

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.