simdjson  3.6.0
Ridiculously Fast JSON
value.h
1 #ifndef SIMDJSON_GENERIC_ONDEMAND_VALUE_H
2 
3 #ifndef SIMDJSON_CONDITIONAL_INCLUDE
4 #define SIMDJSON_GENERIC_ONDEMAND_VALUE_H
5 #include "simdjson/generic/ondemand/base.h"
6 #include "simdjson/generic/implementation_simdjson_result_base.h"
7 #include "simdjson/generic/ondemand/value_iterator.h"
8 #endif // SIMDJSON_CONDITIONAL_INCLUDE
9 
10 namespace simdjson {
11 namespace SIMDJSON_IMPLEMENTATION {
12 namespace ondemand {
13 
18 class value {
19 public:
25  simdjson_inline value() noexcept = default;
26 
38  template<typename T> simdjson_inline simdjson_result<T> get() noexcept {
39  // Unless the simdjson library provides an inline implementation, calling this method should
40  // immediately fail.
41  static_assert(!sizeof(T), "The get method with given type is not implemented by the simdjson library. "
42  "The supported types are ondemand::object, ondemand::array, raw_json_string, std::string_view, uint64_t, "
43  "int64_t, double, and bool. We recommend you use get_double(), get_bool(), get_uint64(), get_int64(), "
44  " get_object(), get_array(), get_raw_json_string(), or get_string() instead of the get template.");
45  }
46 
56  template<typename T> simdjson_inline error_code get(T &out) noexcept;
57 
64  simdjson_inline simdjson_result<array> get_array() noexcept;
65 
72  simdjson_inline simdjson_result<object> get_object() noexcept;
73 
80  simdjson_inline simdjson_result<uint64_t> get_uint64() noexcept;
81 
88  simdjson_inline simdjson_result<uint64_t> get_uint64_in_string() noexcept;
89 
96  simdjson_inline simdjson_result<int64_t> get_int64() noexcept;
97 
104  simdjson_inline simdjson_result<int64_t> get_int64_in_string() noexcept;
105 
112  simdjson_inline simdjson_result<double> get_double() noexcept;
113 
120  simdjson_inline simdjson_result<double> get_double_in_string() noexcept;
121 
136  simdjson_inline simdjson_result<std::string_view> get_string(bool allow_replacement = false) noexcept;
137 
151  template <typename string_type>
152  simdjson_inline error_code get_string(string_type& receiver, bool allow_replacement = false) noexcept;
153 
167  simdjson_inline simdjson_result<std::string_view> get_wobbly_string() noexcept;
176  simdjson_inline simdjson_result<raw_json_string> get_raw_json_string() noexcept;
177 
184  simdjson_inline simdjson_result<bool> get_bool() noexcept;
185 
194  simdjson_inline simdjson_result<bool> is_null() noexcept;
195 
196 #if SIMDJSON_EXCEPTIONS
203  simdjson_inline operator array() noexcept(false);
210  simdjson_inline operator object() noexcept(false);
217  simdjson_inline operator uint64_t() noexcept(false);
224  simdjson_inline operator int64_t() noexcept(false);
231  simdjson_inline operator double() noexcept(false);
243  simdjson_inline operator std::string_view() noexcept(false);
252  simdjson_inline operator raw_json_string() noexcept(false);
259  simdjson_inline operator bool() noexcept(false);
260 #endif
261 
269  simdjson_inline simdjson_result<array_iterator> begin() & noexcept;
275  simdjson_inline simdjson_result<array_iterator> end() & noexcept;
290  simdjson_inline simdjson_result<size_t> count_elements() & noexcept;
308  simdjson_inline simdjson_result<size_t> count_fields() & noexcept;
316  simdjson_inline simdjson_result<value> at(size_t index) noexcept;
339  simdjson_inline simdjson_result<value> find_field(std::string_view key) noexcept;
341  simdjson_inline simdjson_result<value> find_field(const char *key) noexcept;
342 
365  simdjson_inline simdjson_result<value> find_field_unordered(std::string_view key) noexcept;
367  simdjson_inline simdjson_result<value> find_field_unordered(const char *key) noexcept;
369  simdjson_inline simdjson_result<value> operator[](std::string_view key) noexcept;
371  simdjson_inline simdjson_result<value> operator[](const char *key) noexcept;
372 
386  simdjson_inline simdjson_result<json_type> type() noexcept;
387 
395  simdjson_inline simdjson_result<bool> is_scalar() noexcept;
396 
402  simdjson_inline bool is_negative() noexcept;
416  simdjson_inline simdjson_result<bool> is_integer() noexcept;
439  simdjson_inline simdjson_result<number_type> get_number_type() noexcept;
440 
471  simdjson_warn_unused simdjson_inline simdjson_result<number> get_number() noexcept;
472 
473 
499  simdjson_inline std::string_view raw_json_token() noexcept;
500 
509  simdjson_inline simdjson_result<std::string_view> raw_json() noexcept;
510 
514  simdjson_inline simdjson_result<const char *> current_location() noexcept;
515 
525  simdjson_inline int32_t current_depth() const noexcept;
526 
569  simdjson_inline simdjson_result<value> at_pointer(std::string_view json_pointer) noexcept;
570 
571 protected:
575  simdjson_inline value(const value_iterator &iter) noexcept;
576 
580  simdjson_inline void skip() noexcept;
581 
587  static simdjson_inline value start(const value_iterator &iter) noexcept;
588 
592  static simdjson_inline value resume(const value_iterator &iter) noexcept;
593 
597  simdjson_inline simdjson_result<object> start_or_resume_object() noexcept;
598 
599  // simdjson_inline void log_value(const char *type) const noexcept;
600  // simdjson_inline void log_error(const char *message) const noexcept;
601 
602  value_iterator iter{};
603 
604  friend class document;
605  friend class array_iterator;
606  friend class field;
607  friend class object;
608  friend struct simdjson_result<value>;
609  friend struct simdjson_result<field>;
610 };
611 
612 } // namespace ondemand
613 } // namespace SIMDJSON_IMPLEMENTATION
614 } // namespace simdjson
615 
616 namespace simdjson {
617 
618 template<>
619 struct simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> : public SIMDJSON_IMPLEMENTATION::implementation_simdjson_result_base<SIMDJSON_IMPLEMENTATION::ondemand::value> {
620 public:
622  simdjson_inline simdjson_result(error_code error) noexcept;
623  simdjson_inline simdjson_result() noexcept = default;
624 
625  simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::array> get_array() noexcept;
626  simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::object> get_object() noexcept;
627 
628  simdjson_inline simdjson_result<uint64_t> get_uint64() noexcept;
629  simdjson_inline simdjson_result<uint64_t> get_uint64_in_string() noexcept;
630  simdjson_inline simdjson_result<int64_t> get_int64() noexcept;
631  simdjson_inline simdjson_result<int64_t> get_int64_in_string() noexcept;
632  simdjson_inline simdjson_result<double> get_double() noexcept;
633  simdjson_inline simdjson_result<double> get_double_in_string() noexcept;
634  simdjson_inline simdjson_result<std::string_view> get_string(bool allow_replacement = false) noexcept;
635  template <typename string_type>
636  simdjson_inline error_code get_string(string_type& receiver, bool allow_replacement = false) noexcept;
637  simdjson_inline simdjson_result<std::string_view> get_wobbly_string() noexcept;
638  simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::raw_json_string> get_raw_json_string() noexcept;
639  simdjson_inline simdjson_result<bool> get_bool() noexcept;
640  simdjson_inline simdjson_result<bool> is_null() noexcept;
641 
642  template<typename T> simdjson_inline simdjson_result<T> get() noexcept;
643 
644  template<typename T> simdjson_inline error_code get(T &out) noexcept;
645 
646 #if SIMDJSON_EXCEPTIONS
647  simdjson_inline operator SIMDJSON_IMPLEMENTATION::ondemand::array() noexcept(false);
648  simdjson_inline operator SIMDJSON_IMPLEMENTATION::ondemand::object() noexcept(false);
649  simdjson_inline operator uint64_t() noexcept(false);
650  simdjson_inline operator int64_t() noexcept(false);
651  simdjson_inline operator double() noexcept(false);
652  simdjson_inline operator std::string_view() noexcept(false);
653  simdjson_inline operator SIMDJSON_IMPLEMENTATION::ondemand::raw_json_string() noexcept(false);
654  simdjson_inline operator bool() noexcept(false);
655 #endif
656  simdjson_inline simdjson_result<size_t> count_elements() & noexcept;
657  simdjson_inline simdjson_result<size_t> count_fields() & noexcept;
658  simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> at(size_t index) noexcept;
661 
682  simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> find_field(std::string_view key) noexcept;
684  simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> find_field(const char *key) noexcept;
685 
705  simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> find_field_unordered(std::string_view key) noexcept;
707  simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> find_field_unordered(const char *key) noexcept;
709  simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> operator[](std::string_view key) noexcept;
711  simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> operator[](const char *key) noexcept;
712 
721  simdjson_inline simdjson_result<bool> is_scalar() noexcept;
722  simdjson_inline simdjson_result<bool> is_negative() noexcept;
723  simdjson_inline simdjson_result<bool> is_integer() noexcept;
724  simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::number_type> get_number_type() noexcept;
725  simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::number> get_number() noexcept;
726 
728  simdjson_inline simdjson_result<std::string_view> raw_json_token() noexcept;
729  simdjson_inline simdjson_result<std::string_view> raw_json() noexcept;
730 
732  simdjson_inline simdjson_result<const char *> current_location() noexcept;
734  simdjson_inline simdjson_result<int32_t> current_depth() const noexcept;
735  simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> at_pointer(std::string_view json_pointer) noexcept;
736 };
737 
738 } // namespace simdjson
739 
740 #endif // SIMDJSON_GENERIC_ONDEMAND_VALUE_H
A JSON field (key/value pair) in an object.
Definition: field.h:22
A forward-only JSON object field iterator.
Definition: object.h:17
A string escaped per JSON rules, terminated with quote (").
An ephemeral JSON value returned during iteration.
Definition: value.h:18
static simdjson_inline value start(const value_iterator &iter) noexcept
Start a value at the current position.
Definition: value-inl.h:23
simdjson_inline simdjson_result< bool > is_null() noexcept
Checks if this JSON value is null.
Definition: value-inl.h:78
simdjson_inline simdjson_result< const char * > current_location() noexcept
Returns the current location in the document if in bounds.
Definition: value-inl.h:220
simdjson_inline simdjson_result< value > find_field(std::string_view key) noexcept
Look up a field by name on an object (order-sensitive).
Definition: value-inl.h:150
simdjson_inline bool is_negative() noexcept
Checks whether the value is a negative number.
Definition: value-inl.h:182
simdjson_inline simdjson_result< number_type > get_number_type() noexcept
Determine the number type (integer or floating-point number) as quickly as possible.
Definition: value-inl.h:189
simdjson_inline simdjson_result< array > get_array() noexcept
Cast this JSON value to an array.
Definition: value-inl.h:30
simdjson_inline std::string_view raw_json_token() noexcept
Get the raw JSON for this token.
Definition: value-inl.h:196
simdjson_inline simdjson_result< object > get_object() noexcept
Cast this JSON value to an object.
Definition: value-inl.h:33
simdjson_inline simdjson_result< size_t > count_elements() &noexcept
This method scans the array and counts the number of elements.
Definition: value-inl.h:128
simdjson_inline simdjson_result< int64_t > get_int64_in_string() noexcept
Cast this JSON value (inside string) to a signed integer.
Definition: value-inl.h:72
simdjson_inline simdjson_result< size_t > count_fields() &noexcept
This method scans the object and counts the number of key-value pairs.
Definition: value-inl.h:138
simdjson_inline simdjson_result< bool > is_integer() noexcept
Checks whether the value is an integer number.
Definition: value-inl.h:186
simdjson_inline simdjson_result< array_iterator > end() &noexcept
Sentinel representing the end of the array.
Definition: value-inl.h:125
simdjson_inline simdjson_result< object > start_or_resume_object() noexcept
Get the object, starting or resuming it as necessary.
Definition: value-inl.h:36
simdjson_inline simdjson_result< array_iterator > begin() &noexcept
Begin array iteration.
Definition: value-inl.h:122
simdjson_inline simdjson_result< uint64_t > get_uint64_in_string() noexcept
Cast this JSON value (inside string) to a unsigned integer.
Definition: value-inl.h:66
simdjson_inline int32_t current_depth() const noexcept
Returns the current depth in the document if in bounds.
Definition: value-inl.h:224
simdjson_inline simdjson_result< bool > is_scalar() noexcept
Checks whether the value is a scalar (string, number, null, Boolean).
Definition: value-inl.h:175
simdjson_inline simdjson_result< T > get() noexcept
Get this value as the given type.
Definition: value.h:38
simdjson_inline simdjson_result< std::string_view > raw_json() noexcept
Get a string_view pointing at this value in the JSON document.
Definition: value-inl.h:200
static simdjson_inline value resume(const value_iterator &iter) noexcept
Resume a value.
Definition: value-inl.h:26
simdjson_inline simdjson_result< double > get_double() noexcept
Cast this JSON value to a double.
Definition: value-inl.h:57
simdjson_inline simdjson_result< std::string_view > get_string(bool allow_replacement=false) noexcept
Cast this JSON value to a string.
Definition: value-inl.h:47
simdjson_inline simdjson_result< bool > get_bool() noexcept
Cast this JSON value to a bool.
Definition: value-inl.h:75
simdjson_warn_unused simdjson_inline simdjson_result< number > get_number() noexcept
Attempt to parse an ondemand::number.
Definition: value-inl.h:192
simdjson_inline simdjson_result< value > at_pointer(std::string_view json_pointer) noexcept
Get the value associated with the given JSON pointer.
Definition: value-inl.h:228
simdjson_inline simdjson_result< std::string_view > get_wobbly_string() noexcept
Cast this JSON value to a "wobbly" string.
Definition: value-inl.h:54
simdjson_inline simdjson_result< int64_t > get_int64() noexcept
Cast this JSON value to a signed integer.
Definition: value-inl.h:69
simdjson_inline value() noexcept=default
Create a new invalid value.
simdjson_inline simdjson_result< json_type > type() noexcept
Get the type of this JSON value.
Definition: value-inl.h:171
simdjson_inline simdjson_result< double > get_double_in_string() noexcept
Cast this JSON value (inside string) to a double.
Definition: value-inl.h:60
simdjson_inline simdjson_result< raw_json_string > get_raw_json_string() noexcept
Cast this JSON value to a raw_json_string.
Definition: value-inl.h:44
simdjson_inline simdjson_result< value > find_field_unordered(std::string_view key) noexcept
Look up a field by name on an object, without regard to key order.
Definition: value-inl.h:157
simdjson_inline simdjson_result< value > at(size_t index) noexcept
Get the value at the given index in the array.
Definition: value-inl.h:145
simdjson_inline simdjson_result< uint64_t > get_uint64() noexcept
Cast this JSON value to an unsigned integer.
Definition: value-inl.h:63
simdjson_inline void skip() noexcept
Skip this value, allowing iteration to continue.
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
A type representing a JSON number.
Definition: json_type.h:32
The result of a simdjson operation that could fail.
Definition: error.h:214
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.