MongoDB C++ Driver
current
Loading...
Searching...
No Matches
bsoncxx
v_noabi
bsoncxx
validate.hpp
Go to the documentation of this file.
1
// Copyright 2009-present 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 <cstdint>
18
#include <memory>
19
20
#include <
bsoncxx/validate-fwd.hpp
>
21
22
#include <
bsoncxx/document/view.hpp
>
23
#include <
bsoncxx/stdx/optional.hpp
>
24
25
#include <
bsoncxx/config/prelude.hpp
>
26
27
namespace
bsoncxx
{
28
namespace
v_noabi {
29
44
BSONCXX_ABI_EXPORT_CDECL
(stdx::optional<document::view>)
45
validate
(const
std
::uint8_t* data,
std
::
size_t
length);
46
67
BSONCXX_ABI_EXPORT_CDECL
(stdx::optional<document::view>)
68
validate
(const
std
::uint8_t* data,
69
std
::
size_t
length,
70
const
validator
&
validator
,
71
std
::
size_t
* invalid_offset =
nullptr
);
72
77
class
validator
{
78
public
:
82
BSONCXX_ABI_EXPORT_CDECL
()
validator
();
83
87
BSONCXX_ABI_EXPORT_CDECL
() ~
validator
();
88
95
BSONCXX_ABI_EXPORT_CDECL
(
void
) check_utf8(
bool
check_utf8);
96
102
BSONCXX_ABI_EXPORT_CDECL
(
bool
) check_utf8() const;
103
112
BSONCXX_ABI_EXPORT_CDECL
(
void
) check_utf8_allow_null(
bool
check_utf8_allow_null);
113
121
BSONCXX_ABI_EXPORT_CDECL
(
bool
) check_utf8_allow_null() const;
122
129
BSONCXX_ABI_EXPORT_CDECL
(
void
) check_dollar_keys(
bool
check_dollar_keys);
130
137
BSONCXX_ABI_EXPORT_CDECL
(
bool
) check_dollar_keys() const;
138
145
BSONCXX_ABI_EXPORT_CDECL
(
void
) check_dot_keys(
bool
check_dot_keys);
146
153
BSONCXX_ABI_EXPORT_CDECL
(
bool
) check_dot_keys() const;
154
155
private:
156
struct impl;
157
std
::unique_ptr<impl> _impl;
158
};
159
160
}
// namespace v_noabi
161
}
// namespace bsoncxx
162
163
namespace
bsoncxx
{
164
165
using ::bsoncxx::v_noabi::validate;
166
167
}
// namespace bsoncxx
168
169
#include <
bsoncxx/config/postlude.hpp
>
170
175
176
#if defined(BSONCXX_PRIVATE_DOXYGEN_PREPROCESSOR)
177
178
namespace
bsoncxx
{
179
181
v_noabi::stdx::optional<v_noabi::document::view>
validate
(
const
std::uint8_t* data,
182
std::size_t length);
183
185
v_noabi::stdx::optional<v_noabi::document::view>
validate
(
const
std::uint8_t* data,
186
std::size_t length,
187
const
v_noabi::validator
&
validator
,
188
std::size_t* invalid_offset =
nullptr
);
189
190
}
// namespace bsoncxx
191
192
#endif
// defined(BSONCXX_PRIVATE_DOXYGEN_PREPROCESSOR)
postlude.hpp
The bsoncxx macro guard postlude header.
prelude.hpp
The bsoncxx macro guard prelude header.
bsoncxx::v_noabi::stdx::optional
A polyfill for std::optional<T>.
Definition
optional.hpp:826
bsoncxx::v_noabi::validator
A validator is used to enable or disable specific checks that can be performed during BSON validation...
Definition
validate.hpp:77
view.hpp
Provides bsoncxx::v_noabi::document::view.
BSONCXX_ABI_EXPORT_CDECL
#define BSONCXX_ABI_EXPORT_CDECL(...)
Equivalent to BSONCXX_ABI_EXPORT with BSONCXX_ABI_CDECL.
Definition
fwd.hpp:177
bsoncxx::v_noabi::validate
stdx::optional< document::view > validate(const std::uint8_t *data, std::size_t length)
Validates a BSON document. This is a simplified overload that will only do the bare minimum validatio...
bsoncxx
The top-level namespace within which all bsoncxx library entities are declared.
std
The top-level namespace reserved for the C++ standard library.
optional.hpp
Provides std::optional-related polyfills for library API usage.
validate-fwd.hpp
Declares bsoncxx::v_noabi::validator.
Generated by
1.9.8