MongoDB C++ Driver  mongocxx-3.10.2
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/json-fwd.hpp>
20 
21 #include <bsoncxx/array/view.hpp>
22 #include <bsoncxx/document/value.hpp>
23 #include <bsoncxx/document/view.hpp>
24 #include <bsoncxx/stdx/optional.hpp>
25 
26 #include <bsoncxx/config/prelude.hpp>
27 
28 namespace bsoncxx {
29 namespace v_noabi {
30 
33 enum class ExtendedJsonMode : std::uint8_t {
34  k_legacy,
35  k_canonical,
36  k_relaxed,
37 };
38 
51 BSONCXX_API std::string BSONCXX_CALL to_json(document::view view,
53 
54 BSONCXX_API std::string BSONCXX_CALL to_json(array::view view,
56 
67 BSONCXX_API document::value BSONCXX_CALL from_json(stdx::string_view json);
68 
83 BSONCXX_API document::value BSONCXX_CALL operator""_bson(const char* json, size_t len);
84 
85 } // namespace v_noabi
86 } // namespace bsoncxx
87 
88 namespace bsoncxx {
89 
90 using ::bsoncxx::v_noabi::from_json;
91 using ::bsoncxx::v_noabi::to_json;
92 
93 using ::bsoncxx::v_noabi::operator""_bson;
94 
95 } // namespace bsoncxx
96 
97 #include <bsoncxx/config/postlude.hpp>
A read-only, non-owning view of a BSON document.
Definition: view.hpp:36
A read-only BSON document that owns its underlying buffer.
Definition: value.hpp:38
A read-only, non-owning view of a BSON document.
Definition: view.hpp:35
std::string to_json(document::view view, ExtendedJsonMode mode=ExtendedJsonMode::k_legacy)
Converts a BSON document to a JSON string, in extended format.
ExtendedJsonMode
An enumeration of the types of Extended JSON that the to_json function accepts.
Definition: json.hpp:33
@ k_relaxed
to produce Relaxed Extended JSON
@ k_legacy
to produce Legacy Extended JSON
@ k_canonical
to produce Canonical Extended JSON
document::value from_json(stdx::string_view json)
Constructs a new document::value from the provided JSON text.
The top-level namespace for bsoncxx library entities.
Definition: element-fwd.hpp:19