simdjson 4.2.4
Ridiculously Fast JSON
Loading...
Searching...
No Matches
document.h
1#ifndef SIMDJSON_GENERIC_ONDEMAND_DOCUMENT_H
2
3#ifndef SIMDJSON_CONDITIONAL_INCLUDE
4#define SIMDJSON_GENERIC_ONDEMAND_DOCUMENT_H
5#include "simdjson/generic/ondemand/base.h"
6#include "simdjson/generic/ondemand/json_iterator.h"
7#include "simdjson/generic/ondemand/deserialize.h"
8#include "simdjson/generic/ondemand/value.h"
9#include <vector>
10#endif // SIMDJSON_CONDITIONAL_INCLUDE
11
12
13namespace simdjson {
14namespace SIMDJSON_IMPLEMENTATION {
15namespace ondemand {
16
24class document {
25public:
31 simdjson_inline document() noexcept = default;
32 simdjson_inline document(const document &other) noexcept = delete; // pass your documents by reference, not by copy
33 simdjson_inline document(document &&other) noexcept = default;
34 simdjson_inline document &operator=(const document &other) noexcept = delete;
35 simdjson_inline document &operator=(document &&other) noexcept = default;
36
43 simdjson_inline simdjson_result<array> get_array() & noexcept;
50 simdjson_inline simdjson_result<object> get_object() & noexcept;
57 simdjson_inline simdjson_result<uint64_t> get_uint64() noexcept;
64 simdjson_inline simdjson_result<uint64_t> get_uint64_in_string() noexcept;
71 simdjson_inline simdjson_result<int64_t> get_int64() noexcept;
78 simdjson_inline simdjson_result<int64_t> get_int64_in_string() noexcept;
85 simdjson_inline simdjson_result<double> get_double() noexcept;
86
93 simdjson_inline simdjson_result<double> get_double_in_string() noexcept;
106 simdjson_inline simdjson_result<std::string_view> get_string(bool allow_replacement = false) noexcept;
120 template <typename string_type>
121 simdjson_warn_unused simdjson_inline error_code get_string(string_type& receiver, bool allow_replacement = false) noexcept;
133 simdjson_inline simdjson_result<std::string_view> get_wobbly_string() noexcept;
142 simdjson_inline simdjson_result<raw_json_string> get_raw_json_string() noexcept;
149 simdjson_inline simdjson_result<bool> get_bool() noexcept;
162 simdjson_inline simdjson_result<value> get_value() noexcept;
163
172 simdjson_inline simdjson_result<bool> is_null() noexcept;
173
185 template <typename T>
186 simdjson_inline simdjson_result<T> get() &
187#if SIMDJSON_SUPPORTS_CONCEPTS
188 noexcept(custom_deserializable<T, document> ? nothrow_custom_deserializable<T, document> : true)
189#else
190 noexcept
191#endif
192 {
193 static_assert(std::is_default_constructible<T>::value, "Cannot initialize the specified type.");
194 T out{};
195 SIMDJSON_TRY(get<T>(out));
196 return out;
197 }
208 template<typename T>
209 simdjson_inline simdjson_result<T> get() &&
210#if SIMDJSON_SUPPORTS_CONCEPTS
211 noexcept(custom_deserializable<T, document> ? nothrow_custom_deserializable<T, document> : true)
212#else
213 noexcept
214#endif
215 {
216 static_assert(!std::is_same<T, array>::value && !std::is_same<T, object>::value, "You should never hold either an ondemand::array or ondemand::object without a corresponding ondemand::document being alive; that would be Undefined Behaviour.");
217 return static_cast<document&>(*this).get<T>();
218 }
219
231 template<typename T>
232 simdjson_warn_unused simdjson_inline error_code get(T &out) &
233#if SIMDJSON_SUPPORTS_CONCEPTS
234 noexcept(custom_deserializable<T, document> ? nothrow_custom_deserializable<T, document> : true)
235#else
236 noexcept
237#endif
238 {
239#if SIMDJSON_SUPPORTS_CONCEPTS
240 if constexpr (custom_deserializable<T, document>) {
241 return deserialize(*this, out);
242 } else {
243 static_assert(!sizeof(T), "The get<T> method with type T is not implemented by the simdjson library. "
244 "And you do not seem to have added support for it. Indeed, we have that "
245 "simdjson::custom_deserializable<T> is false and the type T is not a default type "
246 "such as ondemand::object, ondemand::array, raw_json_string, std::string_view, uint64_t, "
247 "int64_t, double, or bool.");
248 static_cast<void>(out); // to get rid of unused errors
249 return UNINITIALIZED;
250 }
251#else // SIMDJSON_SUPPORTS_CONCEPTS
252 // Unless the simdjson library or the user provides an inline implementation, calling this method should
253 // immediately fail.
254 static_assert(!sizeof(T), "The get method with given type is not implemented by the simdjson library. "
255 "The supported types are ondemand::object, ondemand::array, raw_json_string, std::string_view, uint64_t, "
256 "int64_t, double, and bool. We recommend you use get_double(), get_bool(), get_uint64(), get_int64(), "
257 " get_object(), get_array(), get_raw_json_string(), or get_string() instead of the get template."
258 " You may also add support for custom types, see our documentation.");
259 static_cast<void>(out); // to get rid of unused errors
260 return UNINITIALIZED;
261#endif // SIMDJSON_SUPPORTS_CONCEPTS
262 }
263
265 template<typename T> simdjson_deprecated simdjson_inline error_code get(T &out) && noexcept;
266
267#if SIMDJSON_EXCEPTIONS
277 template <class T>
278 explicit simdjson_inline operator T() & noexcept(false);
279 template <class T>
280 explicit simdjson_deprecated simdjson_inline operator T() && noexcept(false);
281
288 simdjson_inline operator array() & noexcept(false);
295 simdjson_inline operator object() & noexcept(false);
302 simdjson_inline operator uint64_t() noexcept(false);
309 simdjson_inline operator int64_t() noexcept(false);
316 simdjson_inline operator double() noexcept(false);
326 simdjson_inline operator std::string_view() noexcept(false) simdjson_lifetime_bound;
335 simdjson_inline operator raw_json_string() noexcept(false) simdjson_lifetime_bound;
342 simdjson_inline operator bool() noexcept(false);
354 simdjson_inline operator value() noexcept(false);
355#endif
368 simdjson_inline simdjson_result<size_t> count_elements() & noexcept;
383 simdjson_inline simdjson_result<size_t> count_fields() & noexcept;
391 simdjson_inline simdjson_result<value> at(size_t index) & noexcept;
397 simdjson_inline simdjson_result<array_iterator> begin() & noexcept;
403 simdjson_inline simdjson_result<array_iterator> end() & noexcept;
404
439 simdjson_inline simdjson_result<value> find_field(std::string_view key) & noexcept;
441 simdjson_inline simdjson_result<value> find_field(const char *key) & noexcept;
442
474 simdjson_inline simdjson_result<value> find_field_unordered(std::string_view key) & noexcept;
476 simdjson_inline simdjson_result<value> find_field_unordered(const char *key) & noexcept;
478 simdjson_inline simdjson_result<value> operator[](std::string_view key) & noexcept;
480 simdjson_inline simdjson_result<value> operator[](const char *key) & noexcept;
481 simdjson_result<value> operator[](int) & noexcept = delete;
482
510 simdjson_inline simdjson_result<json_type> type() noexcept;
511
519 simdjson_inline simdjson_result<bool> is_scalar() noexcept;
520
527 simdjson_inline simdjson_result<bool> is_string() noexcept;
528
534 simdjson_inline bool is_negative() noexcept;
544 simdjson_inline simdjson_result<bool> is_integer() noexcept;
569 simdjson_inline simdjson_result<number_type> get_number_type() noexcept;
570
597 simdjson_warn_unused simdjson_inline simdjson_result<number> get_number() noexcept;
598
621 simdjson_inline simdjson_result<std::string_view> raw_json_token() noexcept;
622
628 inline void rewind() noexcept;
632 inline std::string to_debug_string() noexcept;
637 inline bool is_alive() noexcept;
638
642 inline simdjson_result<const char *> current_location() const noexcept;
643
649 inline bool at_end() const noexcept;
650
660 simdjson_inline int32_t current_depth() const noexcept;
661
701 simdjson_inline simdjson_result<value> at_pointer(std::string_view json_pointer) noexcept;
702
724 simdjson_inline simdjson_result<value> at_path(std::string_view json_path) noexcept;
725
741 simdjson_inline simdjson_result<std::vector<value>> at_path_with_wildcard(std::string_view json_path) noexcept;
742
748 simdjson_inline simdjson_result<std::string_view> raw_json() noexcept;
749
750#if SIMDJSON_STATIC_REFLECTION
775 template<constevalutil::fixed_string... FieldNames, typename T>
776 requires(std::is_class_v<T> && (sizeof...(FieldNames) > 0))
777 simdjson_warn_unused simdjson_inline error_code extract_into(T& out) & noexcept;
778#endif // SIMDJSON_STATIC_REFLECTION
779protected:
783 simdjson_warn_unused simdjson_inline error_code consume() noexcept;
784
785 simdjson_inline document(ondemand::json_iterator &&iter) noexcept;
786 simdjson_inline const uint8_t *text(uint32_t idx) const noexcept;
787
788 simdjson_inline value_iterator resume_value_iterator() noexcept;
789 simdjson_inline value_iterator get_root_value_iterator() noexcept;
790 simdjson_inline simdjson_result<object> start_or_resume_object() noexcept;
791 static simdjson_inline document start(ondemand::json_iterator &&iter) noexcept;
792
793 //
794 // Fields
795 //
796 json_iterator iter{};
797 static constexpr depth_t DOCUMENT_DEPTH = 0;
798
799 friend class array_iterator;
800 friend class value;
801 friend class ondemand::parser;
802 friend class object;
803 friend class array;
804 friend class field;
805 friend class token;
806 friend class document_stream;
807 friend class document_reference;
808};
809
810
819class document_reference {
820public:
821 simdjson_inline document_reference() noexcept;
822 simdjson_inline document_reference(document &d) noexcept;
823 simdjson_inline document_reference(const document_reference &other) noexcept = default;
824 simdjson_inline document_reference& operator=(const document_reference &other) noexcept = default;
825 simdjson_inline void rewind() noexcept;
826 simdjson_inline simdjson_result<array> get_array() & noexcept;
827 simdjson_inline simdjson_result<object> get_object() & noexcept;
828 simdjson_inline simdjson_result<uint64_t> get_uint64() noexcept;
829 simdjson_inline simdjson_result<uint64_t> get_uint64_in_string() noexcept;
830 simdjson_inline simdjson_result<int64_t> get_int64() noexcept;
831 simdjson_inline simdjson_result<int64_t> get_int64_in_string() noexcept;
832 simdjson_inline simdjson_result<double> get_double() noexcept;
833 simdjson_inline simdjson_result<double> get_double_in_string() noexcept;
834 simdjson_inline simdjson_result<std::string_view> get_string(bool allow_replacement = false) noexcept;
835 template <typename string_type>
836 simdjson_warn_unused simdjson_inline error_code get_string(string_type& receiver, bool allow_replacement = false) noexcept;
837 simdjson_inline simdjson_result<std::string_view> get_wobbly_string() noexcept;
838 simdjson_inline simdjson_result<raw_json_string> get_raw_json_string() noexcept;
839 simdjson_inline simdjson_result<bool> get_bool() noexcept;
840 simdjson_inline simdjson_result<value> get_value() noexcept;
841
842 simdjson_inline simdjson_result<bool> is_null() noexcept;
843 template <typename T>
844 simdjson_inline simdjson_result<T> get() &
845#if SIMDJSON_SUPPORTS_CONCEPTS
846 noexcept(custom_deserializable<T, document> ? nothrow_custom_deserializable<T, document> : true)
847#else
848 noexcept
849#endif
850 {
851 static_assert(std::is_default_constructible<T>::value, "Cannot initialize the specified type.");
852 T out{};
853 SIMDJSON_TRY(get<T>(out));
854 return out;
855 }
856 template<typename T>
857 simdjson_inline simdjson_result<T> get() &&
858#if SIMDJSON_SUPPORTS_CONCEPTS
859 noexcept(custom_deserializable<T, document> ? nothrow_custom_deserializable<T, document> : true)
860#else
861 noexcept
862#endif
863 {
864 static_assert(!std::is_same<T, array>::value && !std::is_same<T, object>::value, "You should never hold either an ondemand::array or ondemand::object without a corresponding ondemand::document_reference being alive; that would be Undefined Behaviour.");
865 return static_cast<document&>(*this).get<T>();
866 }
867
879 template<typename T>
880 simdjson_warn_unused simdjson_inline error_code get(T &out) &
881#if SIMDJSON_SUPPORTS_CONCEPTS
882 noexcept(custom_deserializable<T, document> ? nothrow_custom_deserializable<T, document_reference> : true)
883#else
884 noexcept
885#endif
886 {
887#if SIMDJSON_SUPPORTS_CONCEPTS
888 if constexpr (custom_deserializable<T, document_reference>) {
889 return deserialize(*this, out);
890 } else {
891 static_assert(!sizeof(T), "The get<T> method with type T is not implemented by the simdjson library. "
892 "And you do not seem to have added support for it. Indeed, we have that "
893 "simdjson::custom_deserializable<T> is false and the type T is not a default type "
894 "such as ondemand::object, ondemand::array, raw_json_string, std::string_view, uint64_t, "
895 "int64_t, double, or bool.");
896 static_cast<void>(out); // to get rid of unused errors
897 return UNINITIALIZED;
898 }
899#else // SIMDJSON_SUPPORTS_CONCEPTS
900 // Unless the simdjson library or the user provides an inline implementation, calling this method should
901 // immediately fail.
902 static_assert(!sizeof(T), "The get method with given type is not implemented by the simdjson library. "
903 "The supported types are ondemand::object, ondemand::array, raw_json_string, std::string_view, uint64_t, "
904 "int64_t, double, and bool. We recommend you use get_double(), get_bool(), get_uint64(), get_int64(), "
905 " get_object(), get_array(), get_raw_json_string(), or get_string() instead of the get template."
906 " You may also add support for custom types, see our documentation.");
907 static_cast<void>(out); // to get rid of unused errors
908 return UNINITIALIZED;
909#endif // SIMDJSON_SUPPORTS_CONCEPTS
910 }
911
913 template<typename T> simdjson_inline error_code get(T &out) && noexcept;
914 simdjson_inline simdjson_result<std::string_view> raw_json() noexcept;
915#if SIMDJSON_STATIC_REFLECTION
916 template<constevalutil::fixed_string... FieldNames, typename T>
917 requires(std::is_class_v<T> && (sizeof...(FieldNames) > 0))
918 simdjson_warn_unused simdjson_inline error_code extract_into(T& out) & noexcept;
919#endif // SIMDJSON_STATIC_REFLECTION
920 simdjson_inline operator document&() const noexcept;
921#if SIMDJSON_EXCEPTIONS
922 template <class T>
923 explicit simdjson_inline operator T() noexcept(false);
924 simdjson_inline operator array() & noexcept(false);
925 simdjson_inline operator object() & noexcept(false);
926 simdjson_inline operator uint64_t() noexcept(false);
927 simdjson_inline operator int64_t() noexcept(false);
928 simdjson_inline operator double() noexcept(false);
929 simdjson_inline operator std::string_view() noexcept(false);
930 simdjson_inline operator raw_json_string() noexcept(false);
931 simdjson_inline operator bool() noexcept(false);
932 simdjson_inline operator value() noexcept(false);
933#endif
934 simdjson_inline simdjson_result<size_t> count_elements() & noexcept;
935 simdjson_inline simdjson_result<size_t> count_fields() & noexcept;
936 simdjson_inline simdjson_result<value> at(size_t index) & noexcept;
937 simdjson_inline simdjson_result<array_iterator> begin() & noexcept;
938 simdjson_inline simdjson_result<array_iterator> end() & noexcept;
939 simdjson_inline simdjson_result<value> find_field(std::string_view key) & noexcept;
940 simdjson_inline simdjson_result<value> find_field(const char *key) & noexcept;
941 simdjson_inline simdjson_result<value> operator[](std::string_view key) & noexcept;
942 simdjson_inline simdjson_result<value> operator[](const char *key) & noexcept;
943 simdjson_result<value> operator[](int) & noexcept = delete;
944 simdjson_inline simdjson_result<value> find_field_unordered(std::string_view key) & noexcept;
945 simdjson_inline simdjson_result<value> find_field_unordered(const char *key) & noexcept;
946
947 simdjson_inline simdjson_result<json_type> type() noexcept;
948 simdjson_inline simdjson_result<bool> is_scalar() noexcept;
949 simdjson_inline simdjson_result<bool> is_string() noexcept;
950
951 simdjson_inline simdjson_result<const char *> current_location() noexcept;
952 simdjson_inline int32_t current_depth() const noexcept;
953 simdjson_inline bool is_negative() noexcept;
954 simdjson_inline simdjson_result<bool> is_integer() noexcept;
955 simdjson_inline simdjson_result<number_type> get_number_type() noexcept;
956 simdjson_inline simdjson_result<number> get_number() noexcept;
957 simdjson_inline simdjson_result<std::string_view> raw_json_token() noexcept;
958 simdjson_inline simdjson_result<value> at_pointer(std::string_view json_pointer) noexcept;
959 simdjson_inline simdjson_result<value> at_path(std::string_view json_path) noexcept;
960 simdjson_inline simdjson_result<std::vector<value>> at_path_with_wildcard(std::string_view json_path) noexcept;
961
962private:
963 document *doc{nullptr};
964};
965} // namespace ondemand
966} // namespace SIMDJSON_IMPLEMENTATION
967} // namespace simdjson
968
969namespace simdjson {
970
971template<>
972struct simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::document> : public SIMDJSON_IMPLEMENTATION::implementation_simdjson_result_base<SIMDJSON_IMPLEMENTATION::ondemand::document> {
973public:
974 simdjson_inline simdjson_result(SIMDJSON_IMPLEMENTATION::ondemand::document &&value) noexcept;
975 simdjson_inline simdjson_result(error_code error) noexcept;
976 simdjson_inline simdjson_result() noexcept = default;
977 simdjson_inline error_code rewind() noexcept;
978
979 simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::array> get_array() & noexcept;
980 simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::object> get_object() & noexcept;
981 simdjson_inline simdjson_result<uint64_t> get_uint64() noexcept;
982 simdjson_inline simdjson_result<uint64_t> get_uint64_in_string() noexcept;
983 simdjson_inline simdjson_result<int64_t> get_int64() noexcept;
984 simdjson_inline simdjson_result<int64_t> get_int64_in_string() noexcept;
985 simdjson_inline simdjson_result<double> get_double() noexcept;
986 simdjson_inline simdjson_result<double> get_double_in_string() noexcept;
987 simdjson_inline simdjson_result<std::string_view> get_string(bool allow_replacement = false) noexcept;
988 template <typename string_type>
989 simdjson_warn_unused simdjson_inline error_code get_string(string_type& receiver, bool allow_replacement = false) noexcept;
990 simdjson_inline simdjson_result<std::string_view> get_wobbly_string() noexcept;
991 simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::raw_json_string> get_raw_json_string() noexcept;
992 simdjson_inline simdjson_result<bool> get_bool() noexcept;
993 simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> get_value() noexcept;
994 simdjson_inline simdjson_result<bool> is_null() noexcept;
995
996 template<typename T> simdjson_inline simdjson_result<T> get() & noexcept;
997 template<typename T> simdjson_deprecated simdjson_inline simdjson_result<T> get() && noexcept;
998
999 template<typename T> simdjson_inline error_code get(T &out) & noexcept;
1000 template<typename T> simdjson_inline error_code get(T &out) && noexcept;
1001#if SIMDJSON_EXCEPTIONS
1002
1003 using SIMDJSON_IMPLEMENTATION::implementation_simdjson_result_base<SIMDJSON_IMPLEMENTATION::ondemand::document>::operator*;
1004 using SIMDJSON_IMPLEMENTATION::implementation_simdjson_result_base<SIMDJSON_IMPLEMENTATION::ondemand::document>::operator->;
1005 template <class T, typename std::enable_if<std::is_same<T, SIMDJSON_IMPLEMENTATION::ondemand::document>::value == false>::type>
1006 explicit simdjson_inline operator T() noexcept(false);
1007 simdjson_inline operator SIMDJSON_IMPLEMENTATION::ondemand::array() & noexcept(false);
1008 simdjson_inline operator SIMDJSON_IMPLEMENTATION::ondemand::object() & noexcept(false);
1009 simdjson_inline operator uint64_t() noexcept(false);
1010 simdjson_inline operator int64_t() noexcept(false);
1011 simdjson_inline operator double() noexcept(false);
1012 simdjson_inline operator std::string_view() noexcept(false);
1013 simdjson_inline operator SIMDJSON_IMPLEMENTATION::ondemand::raw_json_string() noexcept(false);
1014 simdjson_inline operator bool() noexcept(false);
1015 simdjson_inline operator SIMDJSON_IMPLEMENTATION::ondemand::value() noexcept(false);
1016#endif
1017 simdjson_inline simdjson_result<size_t> count_elements() & noexcept;
1018 simdjson_inline simdjson_result<size_t> count_fields() & noexcept;
1019 simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> at(size_t index) & noexcept;
1020 simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::array_iterator> begin() & noexcept;
1021 simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::array_iterator> end() & noexcept;
1022 simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> find_field(std::string_view key) & noexcept;
1023 simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> find_field(const char *key) & noexcept;
1024 simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> operator[](std::string_view key) & noexcept;
1025 simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> operator[](const char *key) & noexcept;
1026 simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> operator[](int) & noexcept = delete;
1027 simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> find_field_unordered(std::string_view key) & noexcept;
1028 simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> find_field_unordered(const char *key) & noexcept;
1029 simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::json_type> type() noexcept;
1030 simdjson_inline simdjson_result<bool> is_scalar() noexcept;
1031 simdjson_inline simdjson_result<bool> is_string() noexcept;
1032 simdjson_inline simdjson_result<const char *> current_location() noexcept;
1033 simdjson_inline int32_t current_depth() const noexcept;
1034 simdjson_inline bool at_end() const noexcept;
1035 simdjson_inline bool is_negative() noexcept;
1036 simdjson_inline simdjson_result<bool> is_integer() noexcept;
1037 simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::number_type> get_number_type() noexcept;
1038 simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::number> get_number() noexcept;
1040 simdjson_inline simdjson_result<std::string_view> raw_json_token() noexcept;
1041
1042 simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> at_pointer(std::string_view json_pointer) noexcept;
1043 simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> at_path(std::string_view json_path) noexcept;
1044 simdjson_inline simdjson_result<std::vector<SIMDJSON_IMPLEMENTATION::ondemand::value>> at_path_with_wildcard(std::string_view json_path) noexcept;
1045#if SIMDJSON_STATIC_REFLECTION
1046 template<constevalutil::fixed_string... FieldNames, typename T>
1047 requires(std::is_class_v<T> && (sizeof...(FieldNames) > 0))
1048 simdjson_warn_unused simdjson_inline error_code extract_into(T& out) & noexcept;
1049#endif // SIMDJSON_STATIC_REFLECTION
1050};
1051
1052
1053} // namespace simdjson
1054
1055
1056
1057namespace simdjson {
1058
1059template<>
1060struct simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::document_reference> : public SIMDJSON_IMPLEMENTATION::implementation_simdjson_result_base<SIMDJSON_IMPLEMENTATION::ondemand::document_reference> {
1061public:
1062 simdjson_inline simdjson_result(SIMDJSON_IMPLEMENTATION::ondemand::document_reference value, error_code error) noexcept;
1063 simdjson_inline simdjson_result() noexcept = default;
1064 simdjson_inline error_code rewind() noexcept;
1065
1066 simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::array> get_array() & noexcept;
1067 simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::object> get_object() & noexcept;
1068 simdjson_inline simdjson_result<uint64_t> get_uint64() noexcept;
1069 simdjson_inline simdjson_result<uint64_t> get_uint64_in_string() noexcept;
1070 simdjson_inline simdjson_result<int64_t> get_int64() noexcept;
1071 simdjson_inline simdjson_result<int64_t> get_int64_in_string() noexcept;
1072 simdjson_inline simdjson_result<double> get_double() noexcept;
1073 simdjson_inline simdjson_result<double> get_double_in_string() noexcept;
1074 simdjson_inline simdjson_result<std::string_view> get_string(bool allow_replacement = false) noexcept;
1075 template <typename string_type>
1076 simdjson_warn_unused simdjson_inline error_code get_string(string_type& receiver, bool allow_replacement = false) noexcept;
1077 simdjson_inline simdjson_result<std::string_view> get_wobbly_string() noexcept;
1078 simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::raw_json_string> get_raw_json_string() noexcept;
1079 simdjson_inline simdjson_result<bool> get_bool() noexcept;
1080 simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> get_value() noexcept;
1081 simdjson_inline simdjson_result<bool> is_null() noexcept;
1082
1083 template<typename T> simdjson_inline simdjson_result<T> get() & noexcept;
1084 template<typename T> simdjson_inline simdjson_result<T> get() && noexcept;
1085
1086 template<typename T> simdjson_inline error_code get(T &out) & noexcept;
1087 template<typename T> simdjson_inline error_code get(T &out) && noexcept;
1088#if SIMDJSON_EXCEPTIONS
1089 template <class T>
1090 explicit simdjson_inline operator T() noexcept(false);
1091 simdjson_inline operator SIMDJSON_IMPLEMENTATION::ondemand::array() & noexcept(false);
1092 simdjson_inline operator SIMDJSON_IMPLEMENTATION::ondemand::object() & noexcept(false);
1093 simdjson_inline operator uint64_t() noexcept(false);
1094 simdjson_inline operator int64_t() noexcept(false);
1095 simdjson_inline operator double() noexcept(false);
1096 simdjson_inline operator std::string_view() noexcept(false);
1097 simdjson_inline operator SIMDJSON_IMPLEMENTATION::ondemand::raw_json_string() noexcept(false);
1098 simdjson_inline operator bool() noexcept(false);
1099 simdjson_inline operator SIMDJSON_IMPLEMENTATION::ondemand::value() noexcept(false);
1100#endif
1101 simdjson_inline simdjson_result<size_t> count_elements() & noexcept;
1102 simdjson_inline simdjson_result<size_t> count_fields() & noexcept;
1103 simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> at(size_t index) & noexcept;
1104 simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::array_iterator> begin() & noexcept;
1105 simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::array_iterator> end() & noexcept;
1106 simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> find_field(std::string_view key) & noexcept;
1107 simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> find_field(const char *key) & noexcept;
1108 simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> operator[](std::string_view key) & noexcept;
1109 simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> operator[](const char *key) & noexcept;
1110 simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> operator[](int) & noexcept = delete;
1111 simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> find_field_unordered(std::string_view key) & noexcept;
1112 simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> find_field_unordered(const char *key) & noexcept;
1113 simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::json_type> type() noexcept;
1114 simdjson_inline simdjson_result<bool> is_scalar() noexcept;
1115 simdjson_inline simdjson_result<bool> is_string() noexcept;
1116 simdjson_inline simdjson_result<const char *> current_location() noexcept;
1117 simdjson_inline simdjson_result<int32_t> current_depth() const noexcept;
1118 simdjson_inline simdjson_result<bool> is_negative() noexcept;
1119 simdjson_inline simdjson_result<bool> is_integer() noexcept;
1120 simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::number_type> get_number_type() noexcept;
1121 simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::number> get_number() noexcept;
1123 simdjson_inline simdjson_result<std::string_view> raw_json_token() noexcept;
1124
1125 simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> at_pointer(std::string_view json_pointer) noexcept;
1126 simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> at_path(std::string_view json_path) noexcept;
1127 simdjson_inline simdjson_result<std::vector<SIMDJSON_IMPLEMENTATION::ondemand::value>> at_path_with_wildcard(std::string_view json_path) noexcept;
1128#if SIMDJSON_STATIC_REFLECTION
1129 template<constevalutil::fixed_string... FieldNames, typename T>
1130 requires(std::is_class_v<T> && (sizeof...(FieldNames) > 0))
1131 simdjson_warn_unused simdjson_inline error_code extract_into(T& out) & noexcept;
1132#endif // SIMDJSON_STATIC_REFLECTION
1133};
1134
1135
1136} // namespace simdjson
1137
1138#endif // SIMDJSON_GENERIC_ONDEMAND_DOCUMENT_H
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::array_iterator
A forward-only JSON array.
Definition array_iterator.h:23
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::array
A forward-only JSON array.
Definition array.h:18
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document_reference
A document_reference is a thin wrapper around a document reference instance.
Definition document.h:819
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document_reference::get
simdjson_warn_unused simdjson_inline error_code get(T &out) &noexcept
Get this value as the given type.
Definition document.h:880
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document_reference::get_uint64
simdjson_inline simdjson_result< uint64_t > get_uint64() noexcept
The document_reference instances are used primarily/solely for streams of JSON documents.
Definition document-inl.h:730
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document_stream
A forward-only stream of documents.
Definition document_stream.h:79
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document
A JSON document.
Definition document.h:24
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::at
simdjson_inline simdjson_result< value > at(size_t index) &noexcept
Get the value at the given index in the array.
Definition document-inl.h:218
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::consume
simdjson_warn_unused simdjson_inline error_code consume() noexcept
Consumes the document.
Definition document-inl.h:248
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::DOCUMENT_DEPTH
static constexpr depth_t DOCUMENT_DEPTH
document depth is always 0
Definition document.h:797
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::current_depth
simdjson_inline int32_t current_depth() const noexcept
Returns the current depth in the document if in bounds.
Definition document-inl.h:45
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::begin
simdjson_inline simdjson_result< array_iterator > begin() &noexcept
Begin array iteration.
Definition document-inl.h:222
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::count_fields
simdjson_inline simdjson_result< size_t > count_fields() &noexcept
This method scans the object and counts the number of key-value pairs.
Definition document-inl.h:211
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::get_string
simdjson_inline simdjson_result< std::string_view > get_string(bool allow_replacement=false) noexcept
Cast this JSON value to a string.
Definition document-inl.h:140
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::get_number
simdjson_warn_unused simdjson_inline simdjson_result< number > get_number() noexcept
Attempt to parse an ondemand::number.
Definition document-inl.h:305
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::get
simdjson_warn_unused simdjson_inline error_code get(T &out) &noexcept
Get this value as the given type.
Definition document.h:232
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::is_alive
bool is_alive() noexcept
Some unrecoverable error conditions may render the document instance unusable.
Definition document-inl.h:54
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::get_bool
simdjson_inline simdjson_result< bool > get_bool() noexcept
Cast this JSON value to a bool.
Definition document-inl.h:153
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::get_object
simdjson_inline simdjson_result< object > get_object() &noexcept
Cast this JSON value to an object.
Definition document-inl.h:109
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::is_string
simdjson_inline simdjson_result< bool > is_string() noexcept
Checks whether the document is a string.
Definition document-inl.h:286
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::get_uint64
simdjson_inline simdjson_result< uint64_t > get_uint64() noexcept
Cast this JSON value to an unsigned integer.
Definition document-inl.h:122
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::is_negative
simdjson_inline bool is_negative() noexcept
Checks whether the document is a negative number.
Definition document-inl.h:293
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::document
simdjson_inline document() noexcept=default
Create a new invalid document.
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::raw_json_token
simdjson_inline simdjson_result< std::string_view > raw_json_token() noexcept
Get the raw JSON for this token.
Definition document-inl.h:310
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::get_uint64_in_string
simdjson_inline simdjson_result< uint64_t > get_uint64_in_string() noexcept
Cast this JSON value (inside string) to an unsigned integer.
Definition document-inl.h:125
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::is_null
simdjson_inline simdjson_result< bool > is_null() noexcept
Checks if this JSON value is null.
Definition document-inl.h:156
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::get_int64
simdjson_inline simdjson_result< int64_t > get_int64() noexcept
Cast this JSON value to a signed integer.
Definition document-inl.h:128
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::at_pointer
simdjson_inline simdjson_result< value > at_pointer(std::string_view json_pointer) noexcept
Get the value associated with the given JSON pointer.
Definition document-inl.h:315
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::type
simdjson_inline simdjson_result< json_type > type() noexcept
Get the type of this JSON value.
Definition document-inl.h:273
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::end
simdjson_inline simdjson_result< array_iterator > end() &noexcept
Sentinel representing the end of the array.
Definition document-inl.h:225
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::string_view
simdjson_inline operator std::string_view() noexcept(false) simdjson_lifetime_bound
Cast this JSON value to a string.
Definition document-inl.h:198
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::get_double_in_string
simdjson_inline simdjson_result< double > get_double_in_string() noexcept
Cast this JSON value (inside string) to a double.
Definition document-inl.h:137
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::at_path
simdjson_inline simdjson_result< value > at_path(std::string_view json_path) noexcept
Get the value associated with the given JSONPath expression.
Definition document-inl.h:333
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::iter
json_iterator iter
Current position in the document.
Definition document.h:796
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::at_path_with_wildcard
simdjson_inline simdjson_result< std::vector< value > > at_path_with_wildcard(std::string_view json_path) noexcept
Get all values matching the given JSONPath expression with wildcard support.
Definition document-inl.h:350
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::get_double
simdjson_inline simdjson_result< double > get_double() noexcept
Cast this JSON value to a double.
Definition document-inl.h:134
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::to_debug_string
std::string to_debug_string() noexcept
Returns debugging information.
Definition document-inl.h:37
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::rewind
void rewind() noexcept
Reset the iterator inside the document instance so we are pointing back at the beginning of the docum...
Definition document-inl.h:33
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::raw_json
simdjson_inline simdjson_result< std::string_view > raw_json() noexcept
Consumes the document and returns a string_view instance corresponding to the document as represented...
Definition document-inl.h:261
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::find_field_unordered
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 document-inl.h:235
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::get_int64_in_string
simdjson_inline simdjson_result< int64_t > get_int64_in_string() noexcept
Cast this JSON value (inside string) to a signed integer.
Definition document-inl.h:131
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::count_elements
simdjson_inline simdjson_result< size_t > count_elements() &noexcept
This method scans the array and counts the number of elements.
Definition document-inl.h:204
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::get_value
simdjson_inline simdjson_result< value > get_value() noexcept
Cast this JSON value to a value when the document is an object or an array.
Definition document-inl.h:70
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::find_field
simdjson_inline simdjson_result< value > find_field(std::string_view key) &noexcept
Look up a field by name on an object (order-sensitive).
Definition document-inl.h:229
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::get_number_type
simdjson_inline simdjson_result< number_type > get_number_type() noexcept
Determine the number type (integer or floating-point number) as quickly as possible.
Definition document-inl.h:301
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::is_scalar
simdjson_inline simdjson_result< bool > is_scalar() noexcept
Checks whether the document is a scalar (string, number, null, Boolean).
Definition document-inl.h:277
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::get_wobbly_string
simdjson_inline simdjson_result< std::string_view > get_wobbly_string() noexcept
Cast this JSON value to a string.
Definition document-inl.h:147
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::at_end
bool at_end() const noexcept
Returns true if this document has been fully parsed.
Definition document-inl.h:49
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::get_array
simdjson_inline simdjson_result< array > get_array() &noexcept
Cast this JSON value to an array.
Definition document-inl.h:105
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::is_integer
simdjson_inline simdjson_result< bool > is_integer() noexcept
Checks whether the document is an integer number.
Definition document-inl.h:297
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::current_location
simdjson_result< const char * > current_location() const noexcept
Returns the current location in the document if in bounds.
Definition document-inl.h:41
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::get
simdjson_inline simdjson_result< T > get() &noexcept
Get this value as the given type.
Definition document.h:186
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document::get_raw_json_string
simdjson_inline simdjson_result< raw_json_string > get_raw_json_string() noexcept
Cast this JSON value to a raw_json_string.
Definition document-inl.h:150
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::field
A JSON field (key/value pair) in an object.
Definition field.h:22
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::object
A forward-only JSON object field iterator.
Definition object.h:21
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::raw_json_string
A string escaped per JSON rules, terminated with quote (").
Definition raw_json_string.h:36
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::value
An ephemeral JSON value returned during iteration.
Definition value.h:22
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::depth_t
int32_t depth_t
Represents the depth of a JSON value (number of nested arrays/objects).
Definition base.h:18
simdjson
The top level simdjson namespace, containing everything the library provides.
Definition base.h:8
simdjson::error_code
error_code
All possible errors returned by simdjson.
Definition error.h:19
simdjson::UNINITIALIZED
@ UNINITIALIZED
unknown error, or uninitialized document
Definition error.h:32
simdjson::SIMDJSON_IMPLEMENTATION::implementation_simdjson_result_base
The result of a simdjson operation that could fail.
Definition implementation_simdjson_result_base.h:35
simdjson::SIMDJSON_IMPLEMENTATION::ondemand::number
A type representing a JSON number.
Definition json_type.h:33
simdjson::simdjson_result
The result of a simdjson operation that could fail.
Definition error.h:280
simdjson::simdjson_result::error
simdjson_inline error_code error() const noexcept
The error.
Definition error-inl.h:168
simdjson::simdjson_result::get
simdjson_warn_unused simdjson_inline error_code get(T &value) &&noexcept
Move the value to the provided variable.
Definition error-inl.h:163