MongoDB C++ Driver  mongocxx-3.6.6
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 {
30  k_cannot_append_key_in_sub_array = 1,
31 
33  k_cannot_close_array_in_sub_document,
34 
36  k_cannot_close_document_in_sub_array,
37 
39  k_cannot_perform_array_operation_on_document,
40 
42  k_cannot_perform_document_operation_on_array,
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 
50  k_no_array_to_close,
51 
53  k_no_document_to_close,
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 
59  k_unset_element,
60 
62  k_json_parse_failure,
63 
65  k_invalid_oid,
66 
67  // This type is unused and deprecated.
68  k_failed_converting_bson_to_json,
69 
71  k_invalid_decimal128,
72 
74  k_internal_error,
75 
77  k_cannot_begin_appending_array,
78 
80  k_cannot_begin_appending_document,
81 
83  k_cannot_end_appending_array,
84 
86  k_cannot_end_appending_document,
87 
89  k_invalid_binary_subtype,
90 
92 #define BSONCXX_ENUM(name, value) k_cannot_append_##name,
93 #include <bsoncxx/enums/type.hpp>
94 #undef BSONCXX_ENUM
95  // Add new constant string message to error_code.cpp as well!
96 };
97 
103 BSONCXX_API const std::error_category& BSONCXX_CALL error_category();
104 
111 BSONCXX_INLINE std::error_code make_error_code(error_code error) {
112  return {static_cast<int>(error), error_category()};
113 }
114 
115 BSONCXX_INLINE_NAMESPACE_END
116 } // namespace bsoncxx
117 
118 #include <bsoncxx/config/postlude.hpp>
119 
120 namespace std {
121 // Specialize is_error_code_enum so we get simpler std::error_code construction
122 template <>
123 struct is_error_code_enum<bsoncxx::error_code> : public true_type {};
124 } // namespace std
bsoncxx
Top level namespace for MongoDB C++ BSON functionality.
Definition: element.hpp:24
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:111