validate.hpp

Go to the documentation of this file.

// Copyright 2009-present 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 <cstdint>
#include <memory>
 
#include <bsoncxx/validate-fwd.hpp>
 
#include <bsoncxx/document/view.hpp>
#include <bsoncxx/stdx/optional.hpp>
 
#include <bsoncxx/config/prelude.hpp>
 
namespace bsoncxx {
namespace v_noabi {
 
BSONCXX_ABI_EXPORT_CDECL(stdx::optional<document::view>)
validate(const std::uint8_t* data, std::size_t length);
 
BSONCXX_ABI_EXPORT_CDECL(stdx::optional<document::view>)
validate(const std::uint8_t* data,
         std::size_t length,
         const validator& validator,
         std::size_t* invalid_offset = nullptr);
 
class validator {
   public:
    BSONCXX_ABI_EXPORT_CDECL() validator();
 
    BSONCXX_ABI_EXPORT_CDECL() ~validator();
 
    BSONCXX_ABI_EXPORT_CDECL(void) check_utf8(bool check_utf8);
 
    BSONCXX_ABI_EXPORT_CDECL(bool) check_utf8() const;
 
    BSONCXX_ABI_EXPORT_CDECL(void) check_utf8_allow_null(bool check_utf8_allow_null);
 
    BSONCXX_ABI_EXPORT_CDECL(bool) check_utf8_allow_null() const;
 
    BSONCXX_ABI_EXPORT_CDECL(void) check_dollar_keys(bool check_dollar_keys);
 
    BSONCXX_ABI_EXPORT_CDECL(bool) check_dollar_keys() const;
 
    BSONCXX_ABI_EXPORT_CDECL(void) check_dot_keys(bool check_dot_keys);
 
    BSONCXX_ABI_EXPORT_CDECL(bool) check_dot_keys() const;
 
   private:
    struct impl;
    std::unique_ptr<impl> _impl;
};
 
}  // namespace v_noabi
}  // namespace bsoncxx
 
namespace bsoncxx {
 
using ::bsoncxx::v_noabi::validate;
 
}  // namespace bsoncxx
 
#include <bsoncxx/config/postlude.hpp>
 
 
#if defined(BSONCXX_PRIVATE_DOXYGEN_PREPROCESSOR)
 
namespace bsoncxx {
 
v_noabi::stdx::optional<v_noabi::document::view> validate(const std::uint8_t* data,
                                                          std::size_t length);
 
v_noabi::stdx::optional<v_noabi::document::view> validate(const std::uint8_t* data,
                                                          std::size_t length,
                                                          const v_noabi::validator& validator,
                                                          std::size_t* invalid_offset = nullptr);
 
}  // namespace bsoncxx
 
#endif  // defined(BSONCXX_PRIVATE_DOXYGEN_PREPROCESSOR)