Struct ListCollectionsOptions 

#[non_exhaustive]
pub struct ListCollectionsOptions {
    pub batch_size: Option<u32>,
    pub comment: Option<Bson>,
    pub filter: Option<Document>,
    pub authorized_collections: Option<bool>,
}

Specifies the options to a Database::list_collections 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.

batch_size: Option<u32>

The number of documents the server should return per cursor batch.

Note that this does not have any affect on the documents that are returned by a cursor, only the number of documents kept in memory at a given time (and by extension, the number of round trips needed to return the entire set of documents returned by the query).

comment: Option<Bson>

Tags the query with an arbitrary Bson value to help trace the operation through the database profiler, currentOp and logs.

This option is only available on server versions 4.4+.

filter: Option<Document>

Filters the list operation.

authorized_collections: Option<bool>

When true and used with list_collection_names, the command returns only those collections for which the user has privileges. When used with list_collections this option has no effect.

Implementations

impl ListCollectionsOptions

pub fn builder() -> ListCollectionsOptionsBuilder

Create a builder for building ListCollectionsOptions. On the builder, call .batch_size(...)(optional), .comment(...)(optional), .filter(...)(optional), .authorized_collections(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of ListCollectionsOptions.

Trait Implementations

impl Clone for ListCollectionsOptions

fn clone(&self) -> ListCollectionsOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListCollectionsOptions

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

Formats the value using the given formatter.

impl Default for ListCollectionsOptions

fn default() -> ListCollectionsOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ListCollectionsOptions

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ListCollectionsOptions

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.