MongoDB C++ Driver mongocxx-3.6.7
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
22namespace bsoncxx {
23BSONCXX_INLINE_NAMESPACE_BEGIN
24
28enum 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
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
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
103BSONCXX_API const std::error_category& BSONCXX_CALL error_category();
104
111BSONCXX_INLINE std::error_code make_error_code(error_code error) {
112 return {static_cast<int>(error), error_category()};
113}
114
115BSONCXX_INLINE_NAMESPACE_END
116} // namespace bsoncxx
117
118#include <bsoncxx/config/postlude.hpp>
119
120namespace std {
121// Specialize is_error_code_enum so we get simpler std::error_code construction
122template <>
123struct is_error_code_enum<bsoncxx::error_code> : public true_type {};
124} // namespace std
Top level namespace for MongoDB C++ BSON functionality.
Definition: element.hpp:24
error_code
Enum representing the various error types that can occur while operating on BSON values.
Definition: error_code.hpp:28
@ k_no_array_to_close
An array was closed while no array was open.
@ k_cannot_append_key_in_sub_array
A new key was appended while building a subarray.
@ k_cannot_begin_appending_document
Failed to begin appending a BSON document to a BSON document or array.
@ k_cannot_close_document_in_sub_array
A subdocument was closed while building a subarray.
@ k_need_key
No key was provided when one was needed.
@ k_unset_element
An empty element was accessed.
@ k_json_parse_failure
A JSON document failed to parse.
@ k_internal_error
BSON data could not be processed, but no specific reason was available.
@ k_cannot_perform_array_operation_on_document
An array operation was performed while building a document.
@ k_cannot_perform_document_operation_on_array
A document operation was performed while building an array.
@ k_cannot_end_appending_array
Failed to complete appending an array to a BSON document or array.
@ k_invalid_decimal128
A Decimal128 string failed to parse.
@ k_no_document_to_close
A document was closed while no document was open.
@ k_cannot_begin_appending_array
Failed to begin appending an array to a BSON document or array.
@ k_invalid_oid
An Object ID string failed to parse.
@ k_cannot_close_array_in_sub_document
A subarray was closed while building a subdocument.
@ k_invalid_binary_subtype
Invalid binary subtype.
@ k_cannot_end_appending_document
Failed to complete appending a BSON document to a BSON document or array.
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.
Definition: error_code.hpp:111