Struct mongodb_gridfs::options::GridFSFindOptions

pub struct GridFSFindOptions {
    pub allow_disk_use: Option<bool>,
    pub batch_size: Option<u32>,
    pub limit: Option<i64>,
    pub max_time: Option<Duration>,
    pub no_cursor_timeout: Option<bool>,
    pub skip: u64,
    pub sort: Option<Document>,
}

Spec

Fields

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.

This option is sent only if the caller explicitly provides a value. The default is to not send a value. For servers < 3.2, this option is ignored and not sent as allowDiskUse does not exist in the OP_QUERY wire protocol.

@see https://docs.mongodb.com/manual/reference/command/find/

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.

no_cursor_timeout: Option<bool>

The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use. Set this option to prevent that.

skip: 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), .no_cursor_timeout(...)(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.