MongoDB C++ Driver mongocxx-3.9.0
Loading...
Searching...
No Matches
Namespaces | Classes | Enumerations | Functions
bsoncxx Namespace Reference

The top-level namespace for bsoncxx library entities. More...

Namespaces

namespace  stdx
 Declares polyfills for C++17 forward compatibility.
 
namespace  v_noabi
 Entities declared in this namespace do not have a stable ABI.
 

Classes

class  decimal128
 Represents an IEEE 754-2008 BSON Decimal128 value in a platform-independent way. More...
 
class  exception
 Class representing any exceptions emitted from the bsoncxx library or its underlying implementation. More...
 
class  oid
 Represents a MongoDB ObjectId. More...
 
class  validator
 A validator is used to enable or disable specific checks that can be performed during BSON validation. More...
 
class  view_or_value
 Class representing a view-or-value variant type. More...
 

Enumerations

enum class  error_code : std::int32_t {
  k_cannot_append_key_in_sub_array = 1 , k_cannot_close_array_in_sub_document , k_cannot_close_document_in_sub_array , k_cannot_perform_array_operation_on_document ,
  k_cannot_perform_document_operation_on_array , BSONCXX_ENUM , k_need_key , k_no_array_to_close ,
  k_no_document_to_close , k_unmatched_key_in_builder , k_unset_element , k_json_parse_failure ,
  k_invalid_oid , k_failed_converting_bson_to_json , k_invalid_decimal128 , k_internal_error ,
  k_cannot_begin_appending_array , k_cannot_begin_appending_document , k_cannot_end_appending_array , k_cannot_end_appending_document ,
  k_invalid_binary_subtype , k_invalid_bson_type_id , BSONCXX_ENUM , k_cannot_append_utf8 = k_cannot_append_string ,
  k_need_element_type_k_utf8 = k_need_element_type_k_string
}
 Enum representing the various error types that can occur while operating on BSON values. More...
 
enum class  ExtendedJsonMode : std::uint8_t { k_legacy , k_canonical , k_relaxed }
 An enumeration of the types of Extended JSON that the to_json function accepts. More...
 
enum class  type : std::uint8_t
 An enumeration of each BSON type. More...
 
enum class  binary_sub_type : std::uint8_t
 An enumeration of each BSON binary sub type. More...
 

Functions

const std::error_category & error_category ()
 Get the error_category for exceptions originating from the bsoncxx library.
 
std::error_code make_error_code (error_code error)
 Translate a bsoncxx::error_code into a std::error_code.
 
std::string to_json (document::view view, ExtendedJsonMode mode=ExtendedJsonMode::k_legacy)
 Converts a BSON document to a JSON string, in extended format.
 
document::value from_json (stdx::string_view json)
 Constructs a new document::value from the provided JSON text.
 
document::value operator""_bson (const char *json, size_t len)
 Constructs a new document::value from the provided JSON text.
 
std::string to_string (type rhs)
 Returns a stringification of the given type.
 
std::string to_string (binary_sub_type rhs)
 Returns a stringification of the given binary sub type.
 
stdx::optional< document::view > validate (const std::uint8_t *data, std::size_t length)
 Validates a BSON document.
 
stdx::optional< document::view > validate (const std::uint8_t *data, std::size_t length, const validator &validator, std::size_t *invalid_offset=nullptr)
 Validates a BSON document.
 

Detailed Description

The top-level namespace for bsoncxx library entities.