Struct ListCollections 

pub struct ListCollections<'a, M = ListSpecifications, S = ImplicitSession> { /* private fields */ }

Gets information about each of the collections in the database. Create by calling Database::list_collections or Database::list_collection_names.

Implementations

impl<M, S> ListCollections<'_, M, S>

pub fn with_options( self, value: impl Into<Option<ListCollectionsOptions>>, ) -> ListCollections<'_, M, S>

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

pub fn batch_size(self, value: u32) -> ListCollections<'_, M, S>

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).

pub fn comment(self, value: impl Into<Bson>) -> ListCollections<'_, M, S>

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+.

pub fn filter(self, value: Document) -> ListCollections<'_, M, S>

Filters the list operation.

pub fn authorized_collections(self, value: bool) -> ListCollections<'_, M, S>

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.

impl<'a, M> ListCollections<'a, M>

pub fn session<'s>( self, value: impl Into<&'s mut ClientSession>, ) -> ListCollections<'a, M, ExplicitSession<'s>>

Use the provided session when running the operation.

Trait Implementations

impl<'a> Action for ListCollections<'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> Action for ListCollections<'a, ListNames>

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> Action for ListCollections<'a, ListNames, ExplicitSession<'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> Action for ListCollections<'a, ListSpecifications, ExplicitSession<'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 ListCollections<'a>

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

The output that the future will produce on completion.

type IntoFuture = ListCollectionsFuture<'a>

Which kind of future are we turning this into?

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

Creates a future from a value.

impl<'a> IntoFuture for ListCollections<'a, ListNames>

type Output = Result<Vec<String>, Error>

The output that the future will produce on completion.

type IntoFuture = ListCollectionNamesFuture<'a>

Which kind of future are we turning this into?

fn into_future( self, ) -> <ListCollections<'a, ListNames> as IntoFuture>::IntoFuture

Creates a future from a value.

impl<'a> IntoFuture for ListCollections<'a, ListNames, ExplicitSession<'a>>

type Output = Result<Vec<String>, Error>

The output that the future will produce on completion.

type IntoFuture = ListCollectionNamesSessionFuture<'a>

Which kind of future are we turning this into?

fn into_future( self, ) -> <ListCollections<'a, ListNames, ExplicitSession<'a>> as IntoFuture>::IntoFuture

Creates a future from a value.

impl<'a> IntoFuture for ListCollections<'a, ListSpecifications, ExplicitSession<'a>>

type Output = Result<SessionCursor<CollectionSpecification>, Error>

The output that the future will produce on completion.

type IntoFuture = ListCollectionsSessionFuture<'a>

Which kind of future are we turning this into?

fn into_future( self, ) -> <ListCollections<'a, ListSpecifications, ExplicitSession<'a>> as IntoFuture>::IntoFuture

Creates a future from a value.