Class List

Here are the classes, structs, unions and interfaces with brief descriptions:

[detail level 12345]

▼Nbsoncxx	The top-level namespace within which all bsoncxx library entities are declared
▼Narray	Declares entities representing a BSON array
Celement	A variant view type that accesses values in serialized BSON arrays
Cvalue	A read-only BSON array that owns its underlying buffer
▼Cview	A read-only, non-owning view of a BSON document
Cconst_iterator	A const iterator over the contents of an array view
▼Nbuilder	Declares entities used to build BSON documents
▼Nbasic	Declares entities used with "basic" BSON builder syntax
Carray	A traditional builder-style interface for constructing a BSON array
Cdocument	A traditional builder-style interface for constructing a BSON document
Csub_array	Represents an array element being constructed during an append operation
Csub_binary	Represents a BSON Binary element being constructed during an append operation
Csub_document	Represents a document element being constructed during an append operation
▼Nstream	Declares entities used with "streaming" BSON builder syntax
Carray	A streaming interface for constructing a BSON array
Carray_context	A stream context which expects any number of values
Cclosed_context	Indicates the document being constructed cannot be closed further
Cdocument	A streaming interface for constructing a BSON document
Ckey_context	A stream context which expects a key
Csingle_context	A stream context which appends a single value
Cvalue_context	A stream context which expects a value
Carray	A JSON-like builder for creating arrays
Cconcatenate_array	Container to concatenate an array
Cconcatenate_doc	Container to concatenate a document
Ccore	A low-level interface for constructing BSON documents and arrays
Cdocument	A JSON-like builder for creating documents
Clist	A JSON-like builder for creating documents and arrays
▼Ndocument	Declares entities representing a BSON document
Celement	A variant view type that accesses values in serialized BSON documents
Cvalue	A read-only BSON document that owns its underlying buffer
▼Cview	A read-only, non-owning view of a BSON document
Cconst_iterator	A const iterator over the contents of a document view
▼Nstdx	Declares C++17 standard library polyfills
Coptional	A polyfill for std::optional<T>
Cstring_view	A polyfill for std::string_view
▼Nstring	Declares entities related to handling string types
Cview_or_value	A view-or-value variant type for strings
▼Ntypes	Declares entities representing BSON value types
▼Nbson_value	Declares entities representing any BSON value type
Cvalue	An owning variant type that represents any BSON type
Cview	A non-owning variant that can contain any BSON type
Cb_array	A BSON array value
Cb_binary	A BSON binary data value
Cb_bool	A BSON boolean value
Cb_code	A BSON JavaScript code value
Cb_codewscope	A BSON JavaScript code with scope value
Cb_date	A BSON date value
Cb_dbpointer	A BSON DBPointer (aka DBRef) value
Cb_decimal128	A BSON Decimal128 value
Cb_document	A BSON document value
Cb_double	A BSON double value
Cb_int32	A BSON signed 32-bit integer value
Cb_int64	A BSON 64-bit signed integer value
Cb_maxkey	A BSON max-key value
Cb_minkey	A BSON min-key value
Cb_null	A BSON null value
Cb_oid	A BSON ObjectId value
Cb_regex	A BSON regex value
Cb_string	A BSON UTF-8 encoded string value
Cb_symbol	A BSON Symbol value
Cb_timestamp	A BSON replication timestamp value
Cb_undefined	A BSON undefined value
▼Nv1	Declares entities whose ABI stability is guaranteed for documented symbols
▼Nstdx	Declares C++17 standard library polyfills.
Coptional	A polyfill for std::optional<T>
Cstring_view	A polyfill for std::string_view
▼Nv_noabi	Declares entities whose ABI stability is NOT guaranteed
▼Narray	Declares entities representing a BSON array.
Celement	A variant view type that accesses values in serialized BSON arrays
Cvalue	A read-only BSON array that owns its underlying buffer
▼Cview	A read-only, non-owning view of a BSON document
Cconst_iterator	A const iterator over the contents of an array view
▼Nbuilder	Declares entities used to build BSON documents.
▼Nbasic	Declares entities used with "basic" BSON builder syntax.
Carray	A traditional builder-style interface for constructing a BSON array
Cdocument	A traditional builder-style interface for constructing a BSON document
Csub_array	Represents an array element being constructed during an append operation
Csub_binary	Represents a BSON Binary element being constructed during an append operation
Csub_document	Represents a document element being constructed during an append operation
▼Nstream	Declares entities used with "streaming" BSON builder syntax.
Carray	A streaming interface for constructing a BSON array
Carray_context	A stream context which expects any number of values
Cclose_array_type	The type of a stream manipulator to close a subarray
Cclose_document_type	The type of a stream manipulator to close a subdocument
Cclosed_context	Indicates the document being constructed cannot be closed further
Cdocument	A streaming interface for constructing a BSON document
Cfinalize_type	The type of a stream manipulator to finalize a document
Ckey_context	A stream context which expects a key
Copen_array_type	The type of a stream manipulator to open a subarray
Copen_document_type	The type of a stream manipulator to open a subdocument
Csingle_context	A stream context which appends a single value
Cvalue_context	A stream context which expects a value
Carray	A JSON-like builder for creating arrays
Cconcatenate_array	Container to concatenate an array
Cconcatenate_doc	Container to concatenate a document
Ccore	A low-level interface for constructing BSON documents and arrays
Cdocument	A JSON-like builder for creating documents
Clist	A JSON-like builder for creating documents and arrays
▼Ndocument	Declares entities representing a BSON document.
Celement	A variant view type that accesses values in serialized BSON documents
Cvalue	A read-only BSON document that owns its underlying buffer
▼Cview	A read-only, non-owning view of a BSON document
Cconst_iterator	A const iterator over the contents of a document view
▼Nstdx	Declares C++17 standard library polyfills.
Coptional	A polyfill for std::optional<T>
Cstring_view	A polyfill for std::string_view
▼Nstring	Declares entities related to handling string types.
Cview_or_value	A view-or-value variant type for strings
▼Ntypes	Declares entities representing BSON value types.
▼Nbson_value	Declares entities representing any BSON value type
Cvalue	An owning variant type that represents any BSON type
Cview	A non-owning variant that can contain any BSON type
Cb_array	A BSON array value
Cb_binary	A BSON binary data value
Cb_bool	A BSON boolean value
Cb_code	A BSON JavaScript code value
Cb_codewscope	A BSON JavaScript code with scope value
Cb_date	A BSON date value
Cb_dbpointer	A BSON DBPointer (aka DBRef) value
Cb_decimal128	A BSON Decimal128 value
Cb_document	A BSON document value
Cb_double	A BSON double value
Cb_int32	A BSON signed 32-bit integer value
Cb_int64	A BSON 64-bit signed integer value
Cb_maxkey	A BSON max-key value
Cb_minkey	A BSON min-key value
Cb_null	A BSON null value
Cb_oid	A BSON ObjectId value
Cb_regex	A BSON regex value
Cb_string	A BSON UTF-8 encoded string value
Cb_symbol	A BSON Symbol value
Cb_timestamp	A BSON replication timestamp value
Cb_undefined	A BSON undefined value
▼Nvector	Declarations related to the BSON Binary Vector subtype.
▼Nelements	Declares element accessor types for BSON Binary Vector
Cfloat32	A 32-bit float value in packed little-endian format
Cpacked_bit_byte	Reference to a byte or partial byte within a vector of packed_bit elements. Allows access to each byte as a uint8_t, while masking off writes to reserved bits
Cpacked_bit_element	Reference to a single element in a packed_bit vector
▼Nformats	Declares supported BSON Binary Vector formats.
Cf_float32	Vector format for 32-bit floating point elements, packed least significant byte first
Cf_int8	Vector format for signed 8-bit integer elements
Cf_packed_bit	Vector format for single bit elements, packed most significant bit first
▼Niterators	Declares iterator types for BSON Binary Vector
Cpacked_bit_byte	Iterator for bytes within a packed_bit vector
Cpacked_bit_element	Iterator for elements within a packed_bit vector
Caccessor	Accessor for the contents of a valid BSON Binary Vector
Cdecimal128	Represents a MongoDB BSON Decimal128
Cexception	Base class for all exceptions thrown by the bsoncxx library unless otherwise specified
Coid	Represents a MongoDB BSON ObjectId
Cvalidator	Used to toggle checks which may be performed during BSON validation
Cview_or_value	A view-or-value variant type
▼Nvector	Declarations related to the BSON Binary Vector subtype
▼Nformats	Declares supported BSON Binary Vector formats
Cf_float32	Vector format for 32-bit floating point elements, packed least significant byte first
Cf_int8	Vector format for signed 8-bit integer elements
Cf_packed_bit	Vector format for single bit elements, packed most significant bit first
Caccessor	Accessor for the contents of a valid BSON Binary Vector
Cdecimal128	Represents a MongoDB BSON Decimal128
Cexception	Base class for all exceptions thrown by the bsoncxx library unless otherwise specified
Coid	Represents a MongoDB BSON ObjectId
Cvalidator	Used to toggle checks which may be performed during BSON validation
Cview_or_value	A view-or-value variant type
▼Nmongocxx	The top-level namespace within which all mongocxx library entities are declared
▼Nevents	Declares entities describing APM events
Ccommand_failed_event	The failed execution of a MongoDB command
Ccommand_started_event	The start of the execution of a MongoDB command
Ccommand_succeeded_event	The successful execution of a MongoDB command
Cheartbeat_failed_event	The failed execution of a heartbeat ("hello") command
Cheartbeat_started_event	The start of the execution of a heartbeat ("hello") command
Cheartbeat_succeeded_event	The successful execution of a heartbeat ("hello") command
Cserver_changed_event	A change in the description of a connected MongoDB server
Cserver_closed_event	The closing of a connection to a shutdown MongoDB server
Cserver_description	The description of a connected MongoDB server
Cserver_opening_event	The addition of a new MongoDB server to the topology description
Ctopology_changed_event	A change in the topology description (including its server descriptions)
Ctopology_closed_event	The closing of connections to a topology of shutdown MongoDB servers
▼Ctopology_description	A description of the topology of one or more connected MongoDB servers
Cserver_descriptions	An array of server_description instances
Ctopology_opening_event	A new connection to a topology of MongoDB servers
▼Ngridfs	Declares entities related to GridFS
Cbucket	A GridFS bucket
Cchunks_and_bytes_offset	Used to specify the offset from which to start reading the chunks of the file
Cdownloader	Used to download a GridFS file
Cuploader	Used to upload a GridFS file
▼Nmodel	Declares entities representing bulk write operations
Cdelete_many	A MongoDB delete operation that removes multiple documents
Cdelete_one	A MongoDB delete operation that removes a single document
Cinsert_one	A MongoDB insert operation that creates a single document
Creplace_one	A MongoDB update operation that replaces a single document
Cupdate_many	A MongoDB update operation that modifies multiple documents
Cupdate_one	A MongoDB update operation that modifies a single document
Cwrite	A single write operation for use with mongocxx::v_noabi::bulk_write
▼Noptions	Declares entities representing options to use with various commands
▼Ngridfs	Declares entities representing options specific to GridFS
Cbucket	Used by mongocxx::v_noabi::gridfs::bucket
Cupload	Used by mongocxx::v_noabi::gridfs::bucket
Caggregate	Used by MongoDB aggregation operations
Capm	Used by mongocxx::v_noabi::options::client::apm_opts
Cauto_encryption	Used by mongocxx::v_noabi::options::client::auto_encryption_opts
Cbulk_write	Used by mongocxx::v_noabi::collection
Cchange_stream	Used by change streams
Cclient	Used by clients
Cclient_encryption	Used by mongocxx::v_noabi::client_encryption
Cclient_session	Used by client sessions
Ccount	Used by mongocxx::v_noabi::collection::count_documents
Cdata_key	Used by mongocxx::v_noabi::client_encryption::create_data_key
Cdelete_options	Used by MongoDB delete operations
Cdistinct	Used by mongocxx::v_noabi::collection
Cencrypt	Used by mongocxx::v_noabi::client_encryption
Cestimated_document_count	Used by mongocxx::v_noabi::collection::estimated_document_count
Cfind	Used by MongoDB find operations
Cfind_one_and_delete	Used by mongocxx::v_noabi::collection
Cfind_one_and_replace	Used by mongocxx::v_noabi::collection
Cfind_one_and_update	Used by mongocxx::v_noabi::collection
▼Cindex	Used by MongoDB index creation operations
Cbase_storage_options	Base class representing the optional storage engine options for indexes
Cwiredtiger_storage_options	The optional WiredTiger storage engine options for indexes
Cindex_view	Used by MongoDB index view operations
Cinsert	Used by mongocxx::v_noabi::collection
Cpool	Used by mongocxx::v_noabi::pool
Crange	Used by mongocxx::v_noabi::options::encrypt::range_opts
Creplace	Used by mongocxx::v_noabi::collection
Crewrap_many_datakey	Used by mongocxx::v_noabi::client_encryption::rewrap_many_datakey
Cserver_api	Used by mongocxx::v_noabi::options::client::server_api_opts
Ctls	Used by mongocxx::v_noabi::options::client::tls_opts
Ctransaction	Used by MongoDB transaction operations
Cupdate	Used by mongocxx::v_noabi::collection
▼Nresult	Declares entities representing the result of various commands
▼Ngridfs	Declares entities representing the result of GridFS commands
Cupload	The result of a GridFS upload operation
Cbulk_write	The result of a MongoDB bulk write operation
Cdelete_result	The result of a MongoDB delete operation
Cinsert_many	The result of a MongoDB insert many operation
Cinsert_one	The result of a MongoDB insert operation
Creplace_one	The result of a MongoDB replaceOne operation
Crewrap_many_datakey	The result of a MongoDB rewrapManyDatakey operation
Cupdate	The result of a MongoDB update operation
▼Nv_noabi	Declares entities whose ABI stability is NOT guaranteed
▼Nevents	Declares entities describing APM events.
Ccommand_failed_event	The failed execution of a MongoDB command
Ccommand_started_event	The start of the execution of a MongoDB command
Ccommand_succeeded_event	The successful execution of a MongoDB command
Cheartbeat_failed_event	The failed execution of a heartbeat ("hello") command
Cheartbeat_started_event	The start of the execution of a heartbeat ("hello") command
Cheartbeat_succeeded_event	The successful execution of a heartbeat ("hello") command
Cserver_changed_event	A change in the description of a connected MongoDB server
Cserver_closed_event	The closing of a connection to a shutdown MongoDB server
Cserver_description	The description of a connected MongoDB server
Cserver_opening_event	The addition of a new MongoDB server to the topology description
Ctopology_changed_event	A change in the topology description (including its server descriptions)
Ctopology_closed_event	The closing of connections to a topology of shutdown MongoDB servers
▼Ctopology_description	A description of the topology of one or more connected MongoDB servers
Cserver_descriptions	An array of server_description instances
Ctopology_opening_event	A new connection to a topology of MongoDB servers
▼Ngridfs	Declares entities related to GridFS.
Cbucket	A GridFS bucket
Cchunks_and_bytes_offset	Used to specify the offset from which to start reading the chunks of the file
Cdownloader	Used to download a GridFS file
Cuploader	Used to upload a GridFS file
▼Nmodel	Declares entities representing bulk write operations.
Cdelete_many	A MongoDB delete operation that removes multiple documents
Cdelete_one	A MongoDB delete operation that removes a single document
Cinsert_one	A MongoDB insert operation that creates a single document
Creplace_one	A MongoDB update operation that replaces a single document
Cupdate_many	A MongoDB update operation that modifies multiple documents
Cupdate_one	A MongoDB update operation that modifies a single document
Cwrite	A single write operation for use with mongocxx::v_noabi::bulk_write
▼Noptions	Declares entities representing options to use with various commands.
▼Ngridfs	Declares entities representing options specific to GridFS.
Cbucket	Used by mongocxx::v_noabi::gridfs::bucket
Cupload	Used by mongocxx::v_noabi::gridfs::bucket
Caggregate	Used by MongoDB aggregation operations
Capm	Used by mongocxx::v_noabi::options::client::apm_opts
Cauto_encryption	Used by mongocxx::v_noabi::options::client::auto_encryption_opts
Cbulk_write	Used by mongocxx::v_noabi::collection
Cchange_stream	Used by change streams
Cclient	Used by clients
Cclient_encryption	Used by mongocxx::v_noabi::client_encryption
Cclient_session	Used by client sessions
Ccount	Used by mongocxx::v_noabi::collection::count_documents
Cdata_key	Used by mongocxx::v_noabi::client_encryption::create_data_key
Cdelete_options	Used by MongoDB delete operations
Cdistinct	Used by mongocxx::v_noabi::collection
Cencrypt	Used by mongocxx::v_noabi::client_encryption
Cestimated_document_count	Used by mongocxx::v_noabi::collection::estimated_document_count
Cfind	Used by MongoDB find operations
Cfind_one_and_delete	Used by mongocxx::v_noabi::collection
Cfind_one_and_replace	Used by mongocxx::v_noabi::collection
Cfind_one_and_update	Used by mongocxx::v_noabi::collection
▼Cindex	Used by MongoDB index creation operations
Cbase_storage_options	Base class representing the optional storage engine options for indexes
Cwiredtiger_storage_options	The optional WiredTiger storage engine options for indexes
Cindex_view	Used by MongoDB index view operations
Cinsert	Used by mongocxx::v_noabi::collection
Cpool	Used by mongocxx::v_noabi::pool
Crange	Used by mongocxx::v_noabi::options::encrypt::range_opts
Creplace	Used by mongocxx::v_noabi::collection
Crewrap_many_datakey	Used by mongocxx::v_noabi::client_encryption::rewrap_many_datakey
Cserver_api	Used by mongocxx::v_noabi::options::client::server_api_opts
Ctls	Used by mongocxx::v_noabi::options::client::tls_opts
Ctransaction	Used by MongoDB transaction operations
Cupdate	Used by mongocxx::v_noabi::collection
▼Nresult	Declares entities representing the result of various commands.
▼Ngridfs	Declares entities representing the result of GridFS commands.
Cupload	The result of a GridFS upload operation
Cbulk_write	The result of a MongoDB bulk write operation
Cdelete_result	The result of a MongoDB delete operation
Cinsert_many	The result of a MongoDB insert many operation
Cinsert_one	The result of a MongoDB insert operation
Creplace_one	The result of a MongoDB replaceOne operation
Crewrap_many_datakey	The result of a MongoDB rewrapManyDatakey operation
Cupdate	The result of a MongoDB update operation
Cauthentication_exception	Unused. To be removed in an upcoming major release
Cbulk_write	A batch of write operations that can be sent to the server as a group
Cbulk_write_exception	An exception thrown during a bulk write operation
▼Cchange_stream	A MongoDB change stream
Citerator	A MongoDB change stream iterator
Cclient	A client connection to a MongoDB server
Cclient_encryption	Supports MongoDB Client-Side Field Level Encryption operations
Cclient_session	Supports MongoDB client session operations
Ccollection	A MongoDB collection
▼Ccursor	A cursor over the documents returned by a query to a MongoDB server
Citerator	An input iterator of documents in a MongoDB cursor result set
Cdatabase	A MongoDB database
Cexception	Base class for all exceptions thrown by the mongocxx library unless otherwise specified
Cgridfs_exception	An exception thrown during a GridFS operation
Chint	The index to "hint" or force a MongoDB server to use when performing a query
Cindex_model	Used by mongocxx::v_noabi::index_view
Cindex_view	A MongoDB index
Cinstance	An instance of the MongoDB driver
Clogger	The interface which user-defined loggers must implement
Clogic_error	An exception thrown due to incorrect use of mongocxx interfaces
Coperation_exception	An exception thrown during a MongoDB server operation
Cpipeline	A MongoDB aggregation pipeline
▼Cpool	A pool of reusable client objects connected to the same MongoDB topology
Centry	An owning handle to a client obtained from a pool
Cquery_exception	An exception thrown during a query operation
Cread_concern	Controls the consistency and isolation properties of data read from replica sets and sharded clusters
Cread_preference	Describes how MongoDB clients route read operations to the members of a replica set or sharded cluster
Csearch_index_model	Used by mongocxx::v_noabi::search_index_view
Csearch_index_view	A MongoDB Atlas Search Index
▼Curi	A MongoDB connection string URI
Chost	A host
Cvalidation_criteria	Supports creating validation rules for fields
Cwrite_concern	The level of acknowledgment requested for write operations to a MongoDB server
Cwrite_exception	An exception thrown during a write operation
Cauthentication_exception	Unused. To be removed in an upcoming major release
Cbulk_write	A batch of write operations that can be sent to the server as a group
Cbulk_write_exception	An exception thrown during a bulk write operation
▼Cchange_stream	A MongoDB change stream
Citerator	A MongoDB change stream iterator
Cclient	A client connection to a MongoDB server
Cclient_encryption	Supports MongoDB Client-Side Field Level Encryption operations
Cclient_session	Supports MongoDB client session operations
Ccollection	A MongoDB collection
▼Ccursor	A cursor over the documents returned by a query to a MongoDB server
Citerator	An input iterator of documents in a MongoDB cursor result set
Cdatabase	A MongoDB database
Cexception	Base class for all exceptions thrown by the mongocxx library unless otherwise specified
Cgridfs_exception	An exception thrown during a GridFS operation
Chint	The index to "hint" or force a MongoDB server to use when performing a query
Cindex_model	Used by mongocxx::v_noabi::index_view
Cindex_view	A MongoDB index
Cinstance	An instance of the MongoDB driver
Clogger	The interface which user-defined loggers must implement
Clogic_error	An exception thrown due to incorrect use of mongocxx interfaces
Coperation_exception	An exception thrown during a MongoDB server operation
Cpipeline	A MongoDB aggregation pipeline
▼Cpool	A pool of reusable client objects connected to the same MongoDB topology
Centry	An owning handle to a client obtained from a pool
Cquery_exception	An exception thrown during a query operation
Cread_concern	Controls the consistency and isolation properties of data read from replica sets and sharded clusters
Cread_preference	Describes how MongoDB clients route read operations to the members of a replica set or sharded cluster
Csearch_index_model	Used by mongocxx::v_noabi::search_index_view
Csearch_index_view	A MongoDB Atlas Search Index
▼Curi	A MongoDB connection string URI
Chost	A host
Cvalidation_criteria	Supports creating validation rules for fields
Cwrite_concern	The level of acknowledgment requested for write operations to a MongoDB server
Cwrite_exception	An exception thrown during a write operation