Module sync

Available on crate feature sync only.

Contains the sync API. This is only available when the sync feature is enabled.

Modules

gridfs

Contains the functionality for GridFS operations.

Structs

ChangeStream

A ChangeStream streams the ongoing changes of its associated collection, database or deployment. ChangeStream instances should be created with method watch against the relevant target.

Client

This is the main entry point for the synchronous API. A Client is used to connect to a MongoDB cluster. By default, it will monitor the topology of the cluster, keeping track of any changes, such as servers being added or removed.

ClientSession

A MongoDB client session. This struct represents a logical session used for ordering sequential operations. To create a ClientSession, call start_session on a Client.

Collection

Collection is the client-side abstraction of a MongoDB Collection. It can be used to perform collection-level operations such as CRUD operations. A Collection can be obtained through a Database by calling either Database::collection or Database::collection_with_options.

Cursor

A Cursor streams the result of a query. When a query is made, a Cursor will be returned with the first batch of results from the server; the documents will be returned as the Cursor is iterated. When the batch is exhausted and if there are more results, the Cursor will fetch the next batch of documents, and so forth until the results are exhausted. Note that because of this batching, additional network I/O may occur on any given call to Cursor::next. Because of this, a Cursor iterates over Result<Document> items rather than simply Document items.

Database

Database is the client-side abstraction of a MongoDB database. It can be used to perform database-level operations or to obtain handles to specific collections within the database. A Database can only be obtained through a Client by calling either Client::database or Client::database_with_options.

SessionChangeStream

A SessionChangeStream is a change stream that was created with a ClientSession that must be iterated using one. To iterate, use SessionChangeStream::next:

SessionCursor

A SessionCursor is a cursor that was created with a ClientSession must be iterated using one. To iterate, retrieve a [SessionCursorIter] using SessionCursor::iter:

SessionCursorIter

A handle that borrows a ClientSession temporarily for executing getMores or iterating through the current buffer of a SessionCursor.