MongoDB C++ Driver
mongocxx-3.6.0
src
bsoncxx
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/document/value.hpp>
20
#include <bsoncxx/document/view.hpp>
21
#include <bsoncxx/stdx/optional.hpp>
22
23
#include <bsoncxx/config/prelude.hpp>
24
28
namespace
bsoncxx
{
29
BSONCXX_INLINE_NAMESPACE_BEGIN
30
31
// Placing this variable between the `BSONCXX_INLINE_NAMESPACE_BEGIN` and the Doxygen documentation
32
// for `to_json` suppressed the macro name from being shown as part of the return type in the
33
// generated documentation pages.
34
extern
const
bool
k_silence_doxygen;
35
38
enum class
ExtendedJsonMode
: std::uint8_t {
39
k_legacy
,
40
k_canonical
,
41
k_relaxed
,
42
};
43
56
BSONCXX_API std::string BSONCXX_CALL
to_json
(document::view view,
57
ExtendedJsonMode
mode =
ExtendedJsonMode::k_legacy
);
58
69
BSONCXX_API document::value BSONCXX_CALL
from_json
(stdx::string_view json);
70
71
BSONCXX_INLINE_NAMESPACE_END
72
}
// namespace bsoncxx
73
74
#include <bsoncxx/config/postlude.hpp>
bsoncxx::ExtendedJsonMode::k_relaxed
@ k_relaxed
to produce Relaxed Extended JSON
bsoncxx::to_json
std::string to_json(document::view view, ExtendedJsonMode mode=ExtendedJsonMode::k_legacy)
Converts a BSON document to a JSON string, in extended format.
bsoncxx::from_json
document::value from_json(stdx::string_view json)
Constructs a new document::value from the provided JSON text.
bsoncxx
Top level namespace for MongoDB C++ BSON functionality.
Definition:
element.hpp:24
bsoncxx::ExtendedJsonMode::k_canonical
@ k_canonical
to produce Canonical Extended JSON
bsoncxx::ExtendedJsonMode
ExtendedJsonMode
An enumeration of the types of Extended JSON that the to_json function accepts.
Definition:
json.hpp:38
bsoncxx::ExtendedJsonMode::k_legacy
@ k_legacy
to produce Legacy Extended JSON
Generated by
1.8.17