Permalink
Cannot retrieve contributors at this time
// Copyright 2015 MongoDB Inc. | |
// | |
// Licensed under the Apache License, Version 2.0 (the "License"); | |
// you may not use this file except in compliance with the License. | |
// You may obtain a copy of the License at | |
// | |
// http://www.apache.org/licenses/LICENSE-2.0 | |
// | |
// Unless required by applicable law or agreed to in writing, software | |
// distributed under the License is distributed on an "AS IS" BASIS, | |
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
// See the License for the specific language governing permissions and | |
// limitations under the License. | |
#pragma once | |
#include <bsoncxx/config/prelude.hpp> | |
#include <string> | |
#include <bsoncxx/document/value.hpp> | |
#include <bsoncxx/document/view.hpp> | |
#include <bsoncxx/stdx/optional.hpp> | |
/// | |
/// Top level namespace for MongoDB C++ BSON functionality. | |
/// | |
namespace bsoncxx { | |
BSONCXX_INLINE_NAMESPACE_BEGIN | |
// Placing this variable between the `BSONCXX_INLINE_NAMESPACE_BEGIN` and the Doxygen documentation | |
// for `to_json` suppressed the macro name from being shown as part of the return type in the | |
// generated documentation pages. | |
extern const bool k_silence_doxygen; | |
/// | |
/// An enumeration of the types of Extended JSON that the to_json function accepts | |
enum class ExtendedJsonMode : std::uint8_t { | |
k_legacy, ///< to produce Legacy Extended JSON | |
k_canonical, ///< to produce Canonical Extended JSON | |
k_relaxed, ///< to produce Relaxed Extended JSON | |
}; | |
/// | |
/// Converts a BSON document to a JSON string, in extended format. | |
/// | |
/// @param view | |
/// A valid BSON document. | |
/// @param mode | |
/// An optional JSON representation mode. | |
/// | |
/// @throws bsoncxx::exception with error details if the conversion failed. | |
/// | |
/// @returns An extended JSON string. | |
/// | |
BSONCXX_API std::string BSONCXX_CALL to_json(document::view view, | |
ExtendedJsonMode mode = ExtendedJsonMode::k_legacy); | |
/// | |
/// Constructs a new document::value from the provided JSON text. | |
/// | |
/// @param 'json' | |
/// A string_view into a JSON document. | |
/// | |
/// @returns A document::value if conversion worked. | |
/// | |
/// @throws bsoncxx::exception with error details if the conversion failed. | |
/// | |
BSONCXX_API document::value BSONCXX_CALL from_json(stdx::string_view json); | |
/// | |
/// Constructs a new document::value from the provided JSON text. This is the UDL version of | |
/// from_json(). | |
/// | |
/// @param 'json' | |
/// A string into a JSON document. | |
/// | |
/// @param 'len' | |
/// The length of the JSON string. This is calculated automatically upon use of the UDL. | |
/// | |
/// @returns A document::value if conversion worked. | |
/// | |
/// @throws bsoncxx::exception with error details if the conversion failed. | |
/// | |
BSONCXX_API document::value BSONCXX_CALL operator"" _bson(const char* json, size_t len); | |
BSONCXX_INLINE_NAMESPACE_END | |
} // namespace bsoncxx | |
#include <bsoncxx/config/postlude.hpp> |