MongoDB C++ Driver  mongocxx-3.7.0
All Classes Namespaces Functions Typedefs Enumerations Enumerator Friends Pages
error_code.hpp
1 // Copyright 2015 MongoDB Inc.
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 
15 #pragma once
16 
17 #include <cstdint>
18 #include <system_error>
19 
20 #include <bsoncxx/config/prelude.hpp>
21 
22 namespace bsoncxx {
23 BSONCXX_INLINE_NAMESPACE_BEGIN
24 
28 enum class error_code : std::int32_t {
31 
34 
37 
40 
43 #define BSONCXX_ENUM(name, value) k_need_element_type_k_##name,
44 #include <bsoncxx/enums/type.hpp>
45 #undef BSONCXX_ENUM
46  k_need_key,
48 
51 
54 
55  // Attempted to view or extract a document when a key was still awaiting a matching value.
56  k_unmatched_key_in_builder,
57 
60 
63 
66 
67  // This type is unused and deprecated.
68  k_failed_converting_bson_to_json,
69 
72 
75 
78 
81 
84 
87 
90 
93 
95 #define BSONCXX_ENUM(name, value) k_cannot_append_##name,
96 #include <bsoncxx/enums/type.hpp>
97 #undef BSONCXX_ENUM
98  k_cannot_append_utf8 = k_cannot_append_string,
99  k_need_element_type_k_utf8 = k_need_element_type_k_string,
100  // Add new constant string message to error_code.cpp as well!
101 };
102 
108 BSONCXX_API const std::error_category& BSONCXX_CALL error_category();
109 
116 BSONCXX_INLINE std::error_code make_error_code(error_code error) {
117  return {static_cast<int>(error), error_category()};
118 }
119 
120 BSONCXX_INLINE_NAMESPACE_END
121 } // namespace bsoncxx
122 
123 #include <bsoncxx/config/postlude.hpp>
124 
125 namespace std {
126 // Specialize is_error_code_enum so we get simpler std::error_code construction
127 template <>
128 struct is_error_code_enum<bsoncxx::error_code> : public true_type {};
129 } // namespace std
bsoncxx::error_code::k_no_document_to_close
@ k_no_document_to_close
A document was closed while no document was open.
bsoncxx::error_code::k_cannot_perform_document_operation_on_array
@ k_cannot_perform_document_operation_on_array
A document operation was performed while building an array.
bsoncxx::error_code::k_cannot_end_appending_document
@ k_cannot_end_appending_document
Failed to complete appending a BSON document to a BSON document or array.
bsoncxx::error_code::k_cannot_close_document_in_sub_array
@ k_cannot_close_document_in_sub_array
A subdocument was closed while building a subarray.
bsoncxx
Top level namespace for MongoDB C++ BSON functionality.
Definition: element.hpp:24
bsoncxx::error_code::k_json_parse_failure
@ k_json_parse_failure
A JSON document failed to parse.
bsoncxx::error_code::k_invalid_decimal128
@ k_invalid_decimal128
A Decimal128 string failed to parse.
bsoncxx::error_category
const std::error_category & error_category()
Get the error_category for exceptions originating from the bsoncxx library.
bsoncxx::error_code
error_code
Enum representing the various error types that can occur while operating on BSON values.
Definition: error_code.hpp:28
bsoncxx::make_error_code
std::error_code make_error_code(error_code error)
Translate a bsoncxx::error_code into a std::error_code.
Definition: error_code.hpp:116
bsoncxx::error_code::k_cannot_append_key_in_sub_array
@ k_cannot_append_key_in_sub_array
A new key was appended while building a subarray.
bsoncxx::error_code::k_invalid_binary_subtype
@ k_invalid_binary_subtype
Invalid binary subtype.
bsoncxx::error_code::k_invalid_bson_type_id
@ k_invalid_bson_type_id
Invalid type.
bsoncxx::error_code::k_need_key
@ k_need_key
No key was provided when one was needed.
bsoncxx::error_code::k_cannot_end_appending_array
@ k_cannot_end_appending_array
Failed to complete appending an array to a BSON document or array.
bsoncxx::error_code::k_cannot_begin_appending_document
@ k_cannot_begin_appending_document
Failed to begin appending a BSON document to a BSON document or array.
bsoncxx::error_code::k_cannot_close_array_in_sub_document
@ k_cannot_close_array_in_sub_document
A subarray was closed while building a subdocument.
bsoncxx::error_code::k_invalid_oid
@ k_invalid_oid
An Object ID string failed to parse.
bsoncxx::error_code::k_cannot_perform_array_operation_on_document
@ k_cannot_perform_array_operation_on_document
An array operation was performed while building a document.
bsoncxx::error_code::k_no_array_to_close
@ k_no_array_to_close
An array was closed while no array was open.
bsoncxx::error_code::k_cannot_begin_appending_array
@ k_cannot_begin_appending_array
Failed to begin appending an array to a BSON document or array.
bsoncxx::error_code::k_internal_error
@ k_internal_error
BSON data could not be processed, but no specific reason was available.
bsoncxx::error_code::k_unset_element
@ k_unset_element
An empty element was accessed.