Modules§
- Action builder types.
- BSON, short for Binary JSON, is a binary-encoded serialization of JSON-like documents. Like JSON, BSON supports the embedding of documents and arrays within other documents and arrays. BSON also contains extensions that allow representation of data types that are not part of the JSON spec. For example, BSON has a datetime type and a binary data type.
- Contains the functionality for change streams.
- Contains the
Error
andResult
types thatmongodb
uses. - Contains the events and functionality for monitoring internal
Client
behavior. - Contains the functionality for GridFS operations.
- Contains all of the types needed to specify options to MongoDB operations.
- Contains the types of results returned by CRUD operations.
Macros§
Structs§
- This is the main entry point for the 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. - A MongoDB client session. This struct represents a logical session used for ordering sequential operations. To create a
ClientSession
, callstart_session
on aClient
. - Struct modeling a cluster time reported by the server.
Collection
is the client-side abstraction of a MongoDB Collection. It can be used to perform collection-level operations such as CRUD operations. ACollection
can be obtained through aDatabase
by calling eitherDatabase::collection
orDatabase::collection_with_options
.- A
Cursor
streams the result of a query. When a query is made, the returnedCursor
will contain the first batch of results from the server; the individual results will then be returned as theCursor
is iterated. When the batch is exhausted and if there are more results, theCursor
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 tonext
. Because of this, aCursor
iterates overResult<T>
items rather than simplyT
items. 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. ADatabase
can only be obtained through aClient
by calling eitherClient::database
orClient::database_with_options
.- Specifies the fields and options for an index. For more information, see the documentation.
- A struct modeling the canonical name for a collection in MongoDB.
- Specifies the options for a search index.
- A description of the most up-to-date information known about a server. Further details can be found in the Server Discovery and Monitoring specification.
- A
SessionCursor
is a cursor that was created with aClientSession
that must be iterated using one. To iterate, useSessionCursor::next
or retrieve aSessionCursorStream
usingSessionCursor::stream
: - A type that implements
Stream
which can be used to stream the results of aSessionCursor
. Returned fromSessionCursor::stream
.
Enums§
- Specifies the type of search index.
- Enum representing the possible types of servers that the driver can connect to.
- The possible types for a topology.
Functions§
Type Aliases§
- A boxed future.