MongoDB C++ Driver  mongocxx-3.8.1
All Classes Namespaces Functions Typedefs Enumerations Enumerator Friends Pages
json.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 <string>
18 
19 #include <bsoncxx/array/view.hpp>
20 #include <bsoncxx/document/value.hpp>
21 #include <bsoncxx/document/view.hpp>
22 #include <bsoncxx/stdx/optional.hpp>
23 
24 #include <bsoncxx/config/prelude.hpp>
25 
29 namespace bsoncxx {
30 BSONCXX_INLINE_NAMESPACE_BEGIN
31 
32 // Placing this variable between the `BSONCXX_INLINE_NAMESPACE_BEGIN` and the Doxygen documentation
33 // for `to_json` suppressed the macro name from being shown as part of the return type in the
34 // generated documentation pages.
35 extern const bool k_silence_doxygen;
36 
39 enum class ExtendedJsonMode : std::uint8_t {
40  k_legacy,
41  k_canonical,
42  k_relaxed,
43 };
44 
57 BSONCXX_API std::string BSONCXX_CALL to_json(document::view view,
59 
60 BSONCXX_API std::string BSONCXX_CALL to_json(array::view view,
62 
73 BSONCXX_API document::value BSONCXX_CALL from_json(stdx::string_view json);
74 
89 BSONCXX_API document::value BSONCXX_CALL operator"" _bson(const char* json, size_t len);
90 
91 BSONCXX_INLINE_NAMESPACE_END
92 } // namespace bsoncxx
93 
94 #include <bsoncxx/config/postlude.hpp>
A read-only, non-owning view of a BSON document.
Definition: view.hpp:40
A read-only BSON document that owns its underlying buffer.
Definition: value.hpp:34
A read-only, non-owning view of a BSON document.
Definition: view.hpp:33
Top level namespace for MongoDB C++ BSON functionality.
Definition: element.hpp:24
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.
ExtendedJsonMode
An enumeration of the types of Extended JSON that the to_json function accepts.
Definition: json.hpp:39
@ k_relaxed
to produce Relaxed Extended JSON
@ k_legacy
to produce Legacy Extended JSON
@ k_canonical
to produce Canonical Extended JSON