Struct RunCursorCommandOptions

#[non_exhaustive]
pub struct RunCursorCommandOptions {
    pub selection_criteria: Option<SelectionCriteria>,
    pub cursor_type: Option<CursorType>,
    pub batch_size: Option<u32>,
    pub max_time: Option<Duration>,
    pub comment: Option<Bson>,
}

Specifies the options to a Database::run_cursor_command operation.

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.

selection_criteria: Option<SelectionCriteria>

The default read preference for operations.

cursor_type: Option<CursorType>

The type of cursor to return.

batch_size: Option<u32>

Number of documents to return per batch.

max_time: Option<Duration>

Optional non-negative integer value. Use this value to configure the maxTimeMS option sent on subsequent getMore commands.

comment: Option<Bson>

Optional BSON value. Use this value to configure the comment option sent on subsequent getMore commands.

Implementations

impl RunCursorCommandOptions

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

Create a builder for building RunCursorCommandOptions. On the builder, call .selection_criteria(...)(optional), .cursor_type(...)(optional), .batch_size(...)(optional), .max_time(...)(optional), .comment(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of RunCursorCommandOptions.

Trait Implementations

impl Clone for RunCursorCommandOptions

fn clone(&self) -> RunCursorCommandOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RunCursorCommandOptions

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

Formats the value using the given formatter.

impl Default for RunCursorCommandOptions

fn default() -> RunCursorCommandOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RunCursorCommandOptions

where RunCursorCommandOptions: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.