simdjson  3.3.0
Ridiculously Fast JSON
parser.h
1 #ifndef SIMDJSON_GENERIC_ONDEMAND_PARSER_H
2 
3 #ifndef SIMDJSON_CONDITIONAL_INCLUDE
4 #define SIMDJSON_GENERIC_ONDEMAND_PARSER_H
5 #include "simdjson/generic/ondemand/base.h"
6 #include "simdjson/generic/implementation_simdjson_result_base.h"
7 #endif // SIMDJSON_CONDITIONAL_INCLUDE
8 
9 #include <memory>
10 
11 namespace simdjson {
12 namespace SIMDJSON_IMPLEMENTATION {
13 namespace ondemand {
14 
20 static constexpr size_t DEFAULT_BATCH_SIZE = 1000000;
29 static constexpr size_t MINIMAL_BATCH_SIZE = 32;
30 
36 class parser {
37 public:
43  inline explicit parser(size_t max_capacity = SIMDJSON_MAXSIZE_BYTES) noexcept;
44 
45  inline parser(parser &&other) noexcept = default;
46  simdjson_inline parser(const parser &other) = delete;
47  simdjson_inline parser &operator=(const parser &other) = delete;
48  simdjson_inline parser &operator=(parser &&other) noexcept = default;
49 
51  inline ~parser() noexcept = default;
52 
100  simdjson_warn_unused simdjson_result<document> iterate(padded_string_view json) & noexcept;
102  simdjson_warn_unused simdjson_result<document> iterate(const char *json, size_t len, size_t capacity) & noexcept;
104  simdjson_warn_unused simdjson_result<document> iterate(const uint8_t *json, size_t len, size_t capacity) & noexcept;
106  simdjson_warn_unused simdjson_result<document> iterate(std::string_view json, size_t capacity) & noexcept;
108  simdjson_warn_unused simdjson_result<document> iterate(const std::string &json) & noexcept;
110  simdjson_warn_unused simdjson_result<document> iterate(const simdjson_result<padded_string> &json) & noexcept;
112  simdjson_warn_unused simdjson_result<document> iterate(const simdjson_result<padded_string_view> &json) & noexcept;
114  simdjson_warn_unused simdjson_result<document> iterate(padded_string &&json) & noexcept = delete;
115 
156  simdjson_warn_unused simdjson_result<json_iterator> iterate_raw(padded_string_view json) & noexcept;
157 
158 
228  inline simdjson_result<document_stream> iterate_many(const uint8_t *buf, size_t len, size_t batch_size = DEFAULT_BATCH_SIZE, bool allow_comma_separated = false) noexcept;
230  inline simdjson_result<document_stream> iterate_many(const char *buf, size_t len, size_t batch_size = DEFAULT_BATCH_SIZE, bool allow_comma_separated = false) noexcept;
232  inline simdjson_result<document_stream> iterate_many(const std::string &s, size_t batch_size = DEFAULT_BATCH_SIZE, bool allow_comma_separated = false) noexcept;
233  inline simdjson_result<document_stream> iterate_many(const std::string &&s, size_t batch_size, bool allow_comma_separated = false) = delete;// unsafe
235  inline simdjson_result<document_stream> iterate_many(const padded_string &s, size_t batch_size = DEFAULT_BATCH_SIZE, bool allow_comma_separated = false) noexcept;
236  inline simdjson_result<document_stream> iterate_many(const padded_string &&s, size_t batch_size, bool allow_comma_separated = false) = delete;// unsafe
237 
239  simdjson_result<document_stream> iterate_many(const char *buf, size_t batch_size = DEFAULT_BATCH_SIZE) noexcept = delete;
240 
242  simdjson_inline size_t capacity() const noexcept;
244  simdjson_inline size_t max_capacity() const noexcept;
245  simdjson_inline void set_max_capacity(size_t max_capacity) noexcept;
252  simdjson_inline size_t max_depth() const noexcept;
253 
266  simdjson_warn_unused error_code allocate(size_t capacity, size_t max_depth=DEFAULT_MAX_DEPTH) noexcept;
267 
268  #ifdef SIMDJSON_THREADS_ENABLED
274  bool threaded{true};
275  #endif
276 
299  simdjson_inline simdjson_result<std::string_view> unescape(raw_json_string in, uint8_t *&dst, bool allow_replacement = false) const noexcept;
300 
322  simdjson_inline simdjson_result<std::string_view> unescape_wobbly(raw_json_string in, uint8_t *&dst) const noexcept;
323 
324 private:
326  std::unique_ptr<internal::dom_parser_implementation> implementation{};
327  size_t _capacity{0};
328  size_t _max_capacity;
329  size_t _max_depth{DEFAULT_MAX_DEPTH};
330  std::unique_ptr<uint8_t[]> string_buf{};
331 #if SIMDJSON_DEVELOPMENT_CHECKS
332  std::unique_ptr<token_position[]> start_positions{};
333 #endif
334 
335  friend class json_iterator;
336  friend class document_stream;
337 };
338 
339 } // namespace ondemand
340 } // namespace SIMDJSON_IMPLEMENTATION
341 } // namespace simdjson
342 
343 namespace simdjson {
344 
345 template<>
346 struct simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::parser> : public SIMDJSON_IMPLEMENTATION::implementation_simdjson_result_base<SIMDJSON_IMPLEMENTATION::ondemand::parser> {
347 public:
349  simdjson_inline simdjson_result(error_code error) noexcept;
350  simdjson_inline simdjson_result() noexcept = default;
351 };
352 
353 } // namespace simdjson
354 
355 #endif // SIMDJSON_GENERIC_ONDEMAND_PARSER_H
simdjson_inline size_t max_capacity() const noexcept
The maximum capacity of this parser (the largest document it is allowed to process).
Definition: parser-inl.h:120
simdjson_warn_unused simdjson_result< document > iterate(padded_string_view json) &noexcept
Start iterating an on-demand JSON document.
Definition: parser-inl.h:46
simdjson_inline simdjson_result< std::string_view > unescape(raw_json_string in, uint8_t *&dst, bool allow_replacement=false) const noexcept
Unescape this JSON string, replacing \ with \, with newline, etc.
Definition: parser-inl.h:135
~parser() noexcept=default
Deallocate the JSON parser.
parser(size_t max_capacity=SIMDJSON_MAXSIZE_BYTES) noexcept
Create a JSON parser.
Definition: parser-inl.h:20
simdjson_inline simdjson_result< std::string_view > unescape_wobbly(raw_json_string in, uint8_t *&dst) const noexcept
Unescape this JSON string, replacing \ with \, with newline, etc.
Definition: parser-inl.h:143
simdjson_inline size_t max_depth() const noexcept
The maximum depth of this parser (the most deeply nested objects and arrays it can process).
Definition: parser-inl.h:123
simdjson_warn_unused error_code allocate(size_t capacity, size_t max_depth=DEFAULT_MAX_DEPTH) noexcept
Ensure this parser has enough memory to process JSON documents up to capacity bytes in length and max...
Definition: parser-inl.h:24
simdjson_inline size_t capacity() const noexcept
The capacity of this parser (the largest document it can process).
Definition: parser-inl.h:117
simdjson_result< document_stream > iterate_many(const uint8_t *buf, size_t len, size_t batch_size=DEFAULT_BATCH_SIZE, bool allow_comma_separated=false) noexcept
Parse a buffer containing many JSON documents.
Definition: parser-inl.h:102
A string escaped per JSON rules, terminated with quote (").
An implementation of simdjson for a particular CPU architecture.
User-provided string that promises it has extra padded bytes at the end for use with parser::parse().
The top level simdjson namespace, containing everything the library provides.
Definition: base.h:8
constexpr SIMDJSON_PUSH_DISABLE_UNUSED_WARNINGS size_t SIMDJSON_MAXSIZE_BYTES
The maximum document size supported by simdjson.
Definition: base.h:21
constexpr size_t DEFAULT_MAX_DEPTH
By default, simdjson supports this many nested objects and arrays.
Definition: base.h:38
error_code
All possible errors returned by simdjson.
Definition: error.h:19
String with extra allocation for ease of use with parser::parse()
Definition: padded_string.h:23
The result of a simdjson operation that could fail.
Definition: error.h:207
simdjson_inline error_code error() const noexcept
The error.
Definition: error-inl.h:131
simdjson_inline T & value() &noexcept(false)
Get the result value.