Struct mongodb::options::GridFsFindOptions

#[non_exhaustive]
pub struct GridFsFindOptions {
    pub allow_disk_use: Option<bool>,
    pub batch_size: Option<u32>,
    pub limit: Option<i64>,
    pub max_time: Option<Duration>,
    pub skip: Option<u64>,
    pub sort: Option<Document>,
}

Contains the options for finding FilesCollectionDocuments in a GridFsBucket.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

allow_disk_use: Option<bool>

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.

batch_size: Option<u32>

The number of documents to return per batch.

limit: Option<i64>

The maximum number of documents to return.

max_time: Option<Duration>

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

skip: Option<u64>

The number of documents to skip before returning.

sort: Option<Document>

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

Implementations

impl GridFsFindOptions

pub fn builder() -> GridFsFindOptionsBuilder<((), (), (), (), (), ())>

Create a builder for building GridFsFindOptions. On the builder, call .allow_disk_use(...)(optional), .batch_size(...)(optional), .limit(...)(optional), .max_time(...)(optional), .skip(...)(optional), .sort(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of GridFsFindOptions.

Trait Implementations

impl Clone for GridFsFindOptions

fn clone(&self) -> GridFsFindOptions

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GridFsFindOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GridFsFindOptions

fn default() -> GridFsFindOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GridFsFindOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<GridFsFindOptions> for FindOptions

fn from(options: GridFsFindOptions) -> Self

Converts to this type from the input type.