simdjson  3.2.3
Ridiculously Fast JSON
element.h
1 #ifndef SIMDJSON_DOM_ELEMENT_H
2 #define SIMDJSON_DOM_ELEMENT_H
3 
4 #include "simdjson/dom/base.h"
5 #include "simdjson/dom/array.h"
6 
7 namespace simdjson {
8 namespace dom {
9 
14 enum class element_type {
15  ARRAY = '[',
16  OBJECT = '{',
17  INT64 = 'l',
18  UINT64 = 'u',
19  DOUBLE = 'd',
20  STRING = '"',
21  BOOL = 't',
22  NULL_VALUE = 'n'
23 };
24 
31 class element {
32 public:
34  simdjson_inline element() noexcept;
35 
37  simdjson_inline element_type type() const noexcept;
38 
45  inline simdjson_result<array> get_array() const noexcept;
52  inline simdjson_result<object> get_object() const noexcept;
69  inline simdjson_result<const char *> get_c_str() const noexcept;
79  inline simdjson_result<size_t> get_string_length() const noexcept;
89  inline simdjson_result<std::string_view> get_string() const noexcept;
97  inline simdjson_result<int64_t> get_int64() const noexcept;
105  inline simdjson_result<uint64_t> get_uint64() const noexcept;
112  inline simdjson_result<double> get_double() const noexcept;
119  inline simdjson_result<bool> get_bool() const noexcept;
120 
126  inline bool is_array() const noexcept;
132  inline bool is_object() const noexcept;
138  inline bool is_string() const noexcept;
144  inline bool is_int64() const noexcept;
150  inline bool is_uint64() const noexcept;
156  inline bool is_double() const noexcept;
157 
163  inline bool is_number() const noexcept;
164 
170  inline bool is_bool() const noexcept;
174  inline bool is_null() const noexcept;
175 
188  template<typename T>
189  simdjson_inline bool is() const noexcept;
190 
210  template<typename T>
211  inline simdjson_result<T> get() const noexcept {
212  // Unless the simdjson library provides an inline implementation, calling this method should
213  // immediately fail.
214  static_assert(!sizeof(T), "The get method with given type is not implemented by the simdjson library.");
215  }
216 
233  template<typename T>
234  simdjson_warn_unused simdjson_inline error_code get(T &value) const noexcept;
235 
251  template<typename T>
252  inline void tie(T &value, error_code &error) && noexcept;
253 
254 #if SIMDJSON_EXCEPTIONS
261  inline operator bool() const noexcept(false);
262 
274  inline explicit operator const char*() const noexcept(false);
275 
285  inline operator std::string_view() const noexcept(false);
286 
294  inline operator uint64_t() const noexcept(false);
302  inline operator int64_t() const noexcept(false);
310  inline operator double() const noexcept(false);
317  inline operator array() const noexcept(false);
324  inline operator object() const noexcept(false);
325 
332  inline dom::array::iterator begin() const noexcept(false);
333 
340  inline dom::array::iterator end() const noexcept(false);
341 #endif // SIMDJSON_EXCEPTIONS
342 
356  inline simdjson_result<element> operator[](std::string_view key) const noexcept;
357 
371  inline simdjson_result<element> operator[](const char *key) const noexcept;
372 
395  inline simdjson_result<element> at_pointer(const std::string_view json_pointer) const noexcept;
396 
397 #ifndef SIMDJSON_DISABLE_DEPRECATED_API
418  [[deprecated("For standard compliance, use at_pointer instead, and prefix your pointers with a slash '/', see RFC6901 ")]]
419  inline simdjson_result<element> at(const std::string_view json_pointer) const noexcept;
420 #endif // SIMDJSON_DISABLE_DEPRECATED_API
421 
428  inline simdjson_result<element> at(size_t index) const noexcept;
429 
442  inline simdjson_result<element> at_key(std::string_view key) const noexcept;
443 
452  inline simdjson_result<element> at_key_case_insensitive(std::string_view key) const noexcept;
453 
455  inline bool dump_raw_tape(std::ostream &out) const noexcept;
456 
457 private:
458  simdjson_inline element(const internal::tape_ref &tape) noexcept;
459  internal::tape_ref tape;
460  friend class document;
461  friend class object;
462  friend class array;
463  friend struct simdjson_result<element>;
464  template<typename T>
465  friend class simdjson::internal::string_builder;
466 
467 };
468 
469 } // namespace dom
470 
472 template<>
473 struct simdjson_result<dom::element> : public internal::simdjson_result_base<dom::element> {
474 public:
475  simdjson_inline simdjson_result() noexcept;
476  simdjson_inline simdjson_result(dom::element &&value) noexcept;
477  simdjson_inline simdjson_result(error_code error) noexcept;
478 
479  simdjson_inline simdjson_result<dom::element_type> type() const noexcept;
480  template<typename T>
481  simdjson_inline bool is() const noexcept;
482  template<typename T>
483  simdjson_inline simdjson_result<T> get() const noexcept;
484  template<typename T>
485  simdjson_warn_unused simdjson_inline error_code get(T &value) const noexcept;
486 
487  simdjson_inline simdjson_result<dom::array> get_array() const noexcept;
488  simdjson_inline simdjson_result<dom::object> get_object() const noexcept;
489  simdjson_inline simdjson_result<const char *> get_c_str() const noexcept;
490  simdjson_inline simdjson_result<size_t> get_string_length() const noexcept;
491  simdjson_inline simdjson_result<std::string_view> get_string() const noexcept;
492  simdjson_inline simdjson_result<int64_t> get_int64() const noexcept;
493  simdjson_inline simdjson_result<uint64_t> get_uint64() const noexcept;
494  simdjson_inline simdjson_result<double> get_double() const noexcept;
495  simdjson_inline simdjson_result<bool> get_bool() const noexcept;
496 
497  simdjson_inline bool is_array() const noexcept;
498  simdjson_inline bool is_object() const noexcept;
499  simdjson_inline bool is_string() const noexcept;
500  simdjson_inline bool is_int64() const noexcept;
501  simdjson_inline bool is_uint64() const noexcept;
502  simdjson_inline bool is_double() const noexcept;
503  simdjson_inline bool is_number() const noexcept;
504  simdjson_inline bool is_bool() const noexcept;
505  simdjson_inline bool is_null() const noexcept;
506 
507  simdjson_inline simdjson_result<dom::element> operator[](std::string_view key) const noexcept;
508  simdjson_inline simdjson_result<dom::element> operator[](const char *key) const noexcept;
509  simdjson_inline simdjson_result<dom::element> at_pointer(const std::string_view json_pointer) const noexcept;
510  [[deprecated("For standard compliance, use at_pointer instead, and prefix your pointers with a slash '/', see RFC6901 ")]]
511  simdjson_inline simdjson_result<dom::element> at(const std::string_view json_pointer) const noexcept;
512  simdjson_inline simdjson_result<dom::element> at(size_t index) const noexcept;
513  simdjson_inline simdjson_result<dom::element> at_key(std::string_view key) const noexcept;
514  simdjson_inline simdjson_result<dom::element> at_key_case_insensitive(std::string_view key) const noexcept;
515 
516 #if SIMDJSON_EXCEPTIONS
517  simdjson_inline operator bool() const noexcept(false);
518  simdjson_inline explicit operator const char*() const noexcept(false);
519  simdjson_inline operator std::string_view() const noexcept(false);
520  simdjson_inline operator uint64_t() const noexcept(false);
521  simdjson_inline operator int64_t() const noexcept(false);
522  simdjson_inline operator double() const noexcept(false);
523  simdjson_inline operator dom::array() const noexcept(false);
524  simdjson_inline operator dom::object() const noexcept(false);
525 
526  simdjson_inline dom::array::iterator begin() const noexcept(false);
527  simdjson_inline dom::array::iterator end() const noexcept(false);
528 #endif // SIMDJSON_EXCEPTIONS
529 };
530 
531 } // namespace simdjson
532 
533 #endif // SIMDJSON_DOM_DOCUMENT_H
JSON array.
Definition: array.h:13
A parsed JSON document.
Definition: document.h:16
A JSON element.
Definition: element.h:31
bool is_object() const noexcept
Whether this element is a json object.
Definition: element-inl.h:339
bool is_double() const noexcept
Whether this element is a json number that fits in a double.
Definition: element-inl.h:343
simdjson_inline element_type type() const noexcept
The type of this element.
Definition: element-inl.h:194
bool is_number() const noexcept
Whether this element is a json number.
Definition: element-inl.h:345
simdjson_result< const char * > get_c_str() const noexcept
Cast this element to a null-terminated C string.
Definition: element-inl.h:209
simdjson_result< element > at_pointer(const std::string_view json_pointer) const noexcept
Get the value associated with the given JSON pointer.
Definition: element-inl.h:378
simdjson_result< double > get_double() const noexcept
Cast this element to a double floating-point.
Definition: element-inl.h:267
simdjson_result< T > get() const noexcept
Get the value as the provided type (T).
Definition: element.h:211
simdjson_inline bool is() const noexcept
Tell whether the value can be cast to provided type (T).
Definition: element-inl.h:324
simdjson_result< element > at_key_case_insensitive(std::string_view key) const noexcept
Get the value associated with the given key in a case-insensitive manner.
Definition: element-inl.h:410
void tie(T &value, error_code &error) &&noexcept
Get the value as the provided type (T), setting error if it's not the given type.
simdjson_result< bool > get_bool() const noexcept
Cast this element to a bool.
Definition: element-inl.h:200
bool is_string() const noexcept
Whether this element is a json string.
Definition: element-inl.h:340
simdjson_result< element > at_key(std::string_view key) const noexcept
Get the value associated with the given key.
Definition: element-inl.h:407
dom::array::iterator end() const noexcept(false)
Iterate over each element in this array.
Definition: element-inl.h:365
simdjson_result< array > get_array() const noexcept
Cast this element to an array.
Definition: element-inl.h:289
simdjson_result< size_t > get_string_length() const noexcept
Gives the length in bytes of the string.
Definition: element-inl.h:219
simdjson_inline element() noexcept
Create a new, invalid element.
Definition: element-inl.h:191
simdjson_result< uint64_t > get_uint64() const noexcept
Cast this element to an unsigned integer.
Definition: element-inl.h:238
dom::array::iterator begin() const noexcept(false)
Iterate over each element in this array.
Definition: element-inl.h:362
simdjson_result< element > at(const std::string_view json_pointer) const noexcept
Version 0.4 of simdjson used an incorrect interpretation of the JSON Pointer standard and allowed the...
Definition: element-inl.h:397
simdjson_result< int64_t > get_int64() const noexcept
Cast this element to a signed integer.
Definition: element-inl.h:252
simdjson_result< object > get_object() const noexcept
Cast this element to an object.
Definition: element-inl.h:298
bool is_uint64() const noexcept
Whether this element is a json number that fits in an unsigned 64-bit integer.
Definition: element-inl.h:342
simdjson_result< element > operator[](std::string_view key) const noexcept
Get the value associated with the given key.
Definition: element-inl.h:371
bool is_int64() const noexcept
Whether this element is a json number that fits in a signed 64-bit integer.
Definition: element-inl.h:341
bool is_null() const noexcept
Whether this element is a json null.
Definition: element-inl.h:347
simdjson_result< std::string_view > get_string() const noexcept
Cast this element to a string.
Definition: element-inl.h:229
bool is_array() const noexcept
Whether this element is a json array.
Definition: element-inl.h:338
bool is_bool() const noexcept
Whether this element is a json true or false.
Definition: element-inl.h:344
JSON object.
Definition: object.h:14
element_type
The actual concrete type of a JSON element This is the type it is most easily cast to with get<>.
Definition: element.h:14
@ STRING
std::string_view
@ UINT64
uint64_t: any integer that fits in uint64_t but not int64_t
@ DOUBLE
double: Any number with a "." or "e" that fits in double.
The top level simdjson namespace, containing everything the library provides.
Definition: base.h:8
error_code
All possible errors returned by simdjson.
Definition: error.h:19
The result of a JSON conversion that may fail.
Definition: array.h:140
The result of a JSON navigation that may fail.
Definition: element.h:473
The result of a JSON conversion that may fail.
Definition: object.h:230
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_warn_unused simdjson_inline error_code get(T &value) &&noexcept
Move the value to the provided variable.
Definition: error-inl.h:126
simdjson_inline T & value() &noexcept(false)
Get the result value.