Struct Find

pub struct Find<'a, T, Session = ImplicitSession>
where
    T: Send + Sync,
{ /* private fields */ }

Finds the documents in a collection matching a filter. Construct with Collection::find.

Implementations

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

where T: Send + Sync,

pub fn with_options( self, value: impl Into<Option<FindOptions>>, ) -> Find<'a, T, Session>

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

pub fn allow_disk_use(self, value: bool) -> Find<'a, T, Session>

Set the FindOptions::allow_disk_use option.

pub fn allow_partial_results(self, value: bool) -> Find<'a, T, Session>

Set the FindOptions::allow_partial_results option.

pub fn batch_size(self, value: u32) -> Find<'a, T, Session>

Set the FindOptions::batch_size option.

pub fn comment(self, value: impl Into<Bson>) -> Find<'a, T, Session>

Set the FindOptions::comment option.

pub fn cursor_type(self, value: CursorType) -> Find<'a, T, Session>

Set the FindOptions::cursor_type option.

pub fn hint(self, value: Hint) -> Find<'a, T, Session>

Set the FindOptions::hint option.

pub fn limit(self, value: i64) -> Find<'a, T, Session>

Set the FindOptions::limit option.

pub fn max(self, value: Document) -> Find<'a, T, Session>

Set the FindOptions::max option.

pub fn max_await_time(self, value: Duration) -> Find<'a, T, Session>

Set the FindOptions::max_await_time option.

pub fn max_scan(self, value: u64) -> Find<'a, T, Session>

Set the FindOptions::max_scan option.

pub fn max_time(self, value: Duration) -> Find<'a, T, Session>

Set the FindOptions::max_time option.

pub fn min(self, value: Document) -> Find<'a, T, Session>

Set the FindOptions::min option.

pub fn no_cursor_timeout(self, value: bool) -> Find<'a, T, Session>

Set the FindOptions::no_cursor_timeout option.

pub fn projection(self, value: Document) -> Find<'a, T, Session>

Set the FindOptions::projection option.

pub fn read_concern(self, value: ReadConcern) -> Find<'a, T, Session>

Set the FindOptions::read_concern option.

pub fn return_key(self, value: bool) -> Find<'a, T, Session>

Set the FindOptions::return_key option.

pub fn selection_criteria( self, value: SelectionCriteria, ) -> Find<'a, T, Session>

Set the FindOptions::selection_criteria option.

pub fn show_record_id(self, value: bool) -> Find<'a, T, Session>

Set the FindOptions::show_record_id option.

pub fn skip(self, value: u64) -> Find<'a, T, Session>

Set the FindOptions::skip option.

pub fn sort(self, value: Document) -> Find<'a, T, Session>

Set the FindOptions::sort option.

pub fn collation(self, value: Collation) -> Find<'a, T, Session>

Set the FindOptions::collation option.

pub fn let_vars(self, value: Document) -> Find<'a, T, Session>

Set the FindOptions::let_vars option.

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

Use the provided session when running the operation.

Trait Implementations

impl<'a, T> Action for Find<'a, T>

where T: Send + Sync,

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 Find<'a, T, ExplicitSession<'a>>

where T: Send + Sync,

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 Find<'a, T>

where T: Send + Sync,

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

The output that the future will produce on completion.

type IntoFuture = FindFuture<'a, T>

Which kind of future are we turning this into?

fn into_future(self) -> <Find<'a, T> as IntoFuture>::IntoFuture

Creates a future from a value.

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

where T: Send + Sync,

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

The output that the future will produce on completion.

type IntoFuture = FindSessionFuture<'a, T>

Which kind of future are we turning this into?

fn into_future( self, ) -> <Find<'a, T, ExplicitSession<'a>> as IntoFuture>::IntoFuture

Creates a future from a value.