Struct Find

pub struct Find<'a> { /* private fields */ }

Finds and returns the FilesCollectionDocuments within a bucket that match a given filter. Construct with GridFsBucket::find.

Implementations

impl Find<'_>

pub fn with_options( self, value: impl Into<Option<GridFsFindOptions>>, ) -> Find<'_>

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

pub fn allow_disk_use(self, value: bool) -> Find<'_>

Enables writing to temporary files on the server. When set to true, the server can write temporary data to disk while executing the find operation on the files collection.

pub fn batch_size(self, value: u32) -> Find<'_>

The number of documents to return per batch.

pub fn limit(self, value: i64) -> Find<'_>

The maximum number of documents to return.

pub fn max_time(self, value: Duration) -> Find<'_>

The maximum amount of time to allow the query to run.

pub fn skip(self, value: u64) -> Find<'_>

The number of documents to skip before returning.

pub fn sort(self, value: Document) -> Find<'_>

The order by which to sort results. Defaults to not sorting.

Trait Implementations

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

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> IntoFuture for Find<'a>

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

The output that the future will produce on completion.

type IntoFuture = FindFuture<'a>

Which kind of future are we turning this into?

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

Creates a future from a value.