simdjson  3.6.4
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  template <class T>
204  explicit simdjson_inline operator T() noexcept(false);
211  simdjson_inline operator array() noexcept(false);
218  simdjson_inline operator object() noexcept(false);
225  simdjson_inline operator uint64_t() noexcept(false);
232  simdjson_inline operator int64_t() noexcept(false);
239  simdjson_inline operator double() noexcept(false);
251  simdjson_inline operator std::string_view() noexcept(false);
260  simdjson_inline operator raw_json_string() noexcept(false);
267  simdjson_inline operator bool() noexcept(false);
268 #endif
269 
277  simdjson_inline simdjson_result<array_iterator> begin() & noexcept;
283  simdjson_inline simdjson_result<array_iterator> end() & noexcept;
298  simdjson_inline simdjson_result<size_t> count_elements() & noexcept;
316  simdjson_inline simdjson_result<size_t> count_fields() & noexcept;
324  simdjson_inline simdjson_result<value> at(size_t index) noexcept;
347  simdjson_inline simdjson_result<value> find_field(std::string_view key) noexcept;
349  simdjson_inline simdjson_result<value> find_field(const char *key) noexcept;
350 
373  simdjson_inline simdjson_result<value> find_field_unordered(std::string_view key) noexcept;
375  simdjson_inline simdjson_result<value> find_field_unordered(const char *key) noexcept;
377  simdjson_inline simdjson_result<value> operator[](std::string_view key) noexcept;
379  simdjson_inline simdjson_result<value> operator[](const char *key) noexcept;
380 
394  simdjson_inline simdjson_result<json_type> type() noexcept;
395 
403  simdjson_inline simdjson_result<bool> is_scalar() noexcept;
404 
410  simdjson_inline bool is_negative() noexcept;
424  simdjson_inline simdjson_result<bool> is_integer() noexcept;
447  simdjson_inline simdjson_result<number_type> get_number_type() noexcept;
448 
479  simdjson_warn_unused simdjson_inline simdjson_result<number> get_number() noexcept;
480 
481 
507  simdjson_inline std::string_view raw_json_token() noexcept;
508 
517  simdjson_inline simdjson_result<std::string_view> raw_json() noexcept;
518 
522  simdjson_inline simdjson_result<const char *> current_location() noexcept;
523 
533  simdjson_inline int32_t current_depth() const noexcept;
534 
577  simdjson_inline simdjson_result<value> at_pointer(std::string_view json_pointer) noexcept;
578 
579 protected:
583  simdjson_inline value(const value_iterator &iter) noexcept;
584 
588  simdjson_inline void skip() noexcept;
589 
595  static simdjson_inline value start(const value_iterator &iter) noexcept;
596 
600  static simdjson_inline value resume(const value_iterator &iter) noexcept;
601 
605  simdjson_inline simdjson_result<object> start_or_resume_object() noexcept;
606 
607  // simdjson_inline void log_value(const char *type) const noexcept;
608  // simdjson_inline void log_error(const char *message) const noexcept;
609 
610  value_iterator iter{};
611 
612  friend class document;
613  friend class array_iterator;
614  friend class field;
615  friend class object;
616  friend struct simdjson_result<value>;
617  friend struct simdjson_result<field>;
618 };
619 
620 } // namespace ondemand
621 } // namespace SIMDJSON_IMPLEMENTATION
622 } // namespace simdjson
623 
624 namespace simdjson {
625 
626 template<>
627 struct simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> : public SIMDJSON_IMPLEMENTATION::implementation_simdjson_result_base<SIMDJSON_IMPLEMENTATION::ondemand::value> {
628 public:
630  simdjson_inline simdjson_result(error_code error) noexcept;
631  simdjson_inline simdjson_result() noexcept = default;
632 
633  simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::array> get_array() noexcept;
634  simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::object> get_object() noexcept;
635 
636  simdjson_inline simdjson_result<uint64_t> get_uint64() noexcept;
637  simdjson_inline simdjson_result<uint64_t> get_uint64_in_string() noexcept;
638  simdjson_inline simdjson_result<int64_t> get_int64() noexcept;
639  simdjson_inline simdjson_result<int64_t> get_int64_in_string() noexcept;
640  simdjson_inline simdjson_result<double> get_double() noexcept;
641  simdjson_inline simdjson_result<double> get_double_in_string() noexcept;
642  simdjson_inline simdjson_result<std::string_view> get_string(bool allow_replacement = false) noexcept;
643  template <typename string_type>
644  simdjson_inline error_code get_string(string_type& receiver, bool allow_replacement = false) noexcept;
645  simdjson_inline simdjson_result<std::string_view> get_wobbly_string() noexcept;
646  simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::raw_json_string> get_raw_json_string() noexcept;
647  simdjson_inline simdjson_result<bool> get_bool() noexcept;
648  simdjson_inline simdjson_result<bool> is_null() noexcept;
649 
650  template<typename T> simdjson_inline simdjson_result<T> get() noexcept;
651 
652  template<typename T> simdjson_inline error_code get(T &out) noexcept;
653 
654 #if SIMDJSON_EXCEPTIONS
655  template <class T>
656  explicit simdjson_inline operator T() noexcept(false);
657  simdjson_inline operator SIMDJSON_IMPLEMENTATION::ondemand::array() noexcept(false);
658  simdjson_inline operator SIMDJSON_IMPLEMENTATION::ondemand::object() noexcept(false);
659  simdjson_inline operator uint64_t() noexcept(false);
660  simdjson_inline operator int64_t() noexcept(false);
661  simdjson_inline operator double() noexcept(false);
662  simdjson_inline operator std::string_view() noexcept(false);
663  simdjson_inline operator SIMDJSON_IMPLEMENTATION::ondemand::raw_json_string() noexcept(false);
664  simdjson_inline operator bool() noexcept(false);
665 #endif
666  simdjson_inline simdjson_result<size_t> count_elements() & noexcept;
667  simdjson_inline simdjson_result<size_t> count_fields() & noexcept;
668  simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> at(size_t index) noexcept;
671 
692  simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> find_field(std::string_view key) noexcept;
694  simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> find_field(const char *key) noexcept;
695 
715  simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> find_field_unordered(std::string_view key) noexcept;
717  simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> find_field_unordered(const char *key) noexcept;
719  simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> operator[](std::string_view key) noexcept;
721  simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> operator[](const char *key) noexcept;
722 
731  simdjson_inline simdjson_result<bool> is_scalar() noexcept;
732  simdjson_inline simdjson_result<bool> is_negative() noexcept;
733  simdjson_inline simdjson_result<bool> is_integer() noexcept;
734  simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::number_type> get_number_type() noexcept;
735  simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::number> get_number() noexcept;
736 
738  simdjson_inline simdjson_result<std::string_view> raw_json_token() noexcept;
739  simdjson_inline simdjson_result<std::string_view> raw_json() noexcept;
740 
742  simdjson_inline simdjson_result<const char *> current_location() noexcept;
744  simdjson_inline simdjson_result<int32_t> current_depth() const noexcept;
745  simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> at_pointer(std::string_view json_pointer) noexcept;
746 };
747 
748 } // namespace simdjson
749 
750 #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:224
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:154
simdjson_inline bool is_negative() noexcept
Checks whether the value is a negative number.
Definition: value-inl.h:186
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:193
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:200
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:132
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:142
simdjson_inline simdjson_result< bool > is_integer() noexcept
Checks whether the value is an integer number.
Definition: value-inl.h:190
simdjson_inline simdjson_result< array_iterator > end() &noexcept
Sentinel representing the end of the array.
Definition: value-inl.h:129
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:126
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:228
simdjson_inline simdjson_result< bool > is_scalar() noexcept
Checks whether the value is a scalar (string, number, null, Boolean).
Definition: value-inl.h:179
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:204
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:196
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:232
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:175
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:161
simdjson_inline simdjson_result< value > at(size_t index) noexcept
Get the value at the given index in the array.
Definition: value-inl.h:149
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.