simdjson  3.11.0
Ridiculously Fast JSON
array.h
1 #ifndef SIMDJSON_GENERIC_ONDEMAND_ARRAY_H
2 
3 #ifndef SIMDJSON_CONDITIONAL_INCLUDE
4 #define SIMDJSON_GENERIC_ONDEMAND_ARRAY_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 
17 class array {
18 public:
24  simdjson_inline array() noexcept = default;
25 
31  simdjson_inline simdjson_result<array_iterator> begin() noexcept;
37  simdjson_inline simdjson_result<array_iterator> end() noexcept;
53  simdjson_inline simdjson_result<size_t> count_elements() & noexcept;
63  simdjson_inline simdjson_result<bool> is_empty() & noexcept;
74  inline simdjson_result<bool> reset() & noexcept;
103  inline simdjson_result<value> at_pointer(std::string_view json_pointer) noexcept;
104 
118  inline simdjson_result<value> at_path(std::string_view json_path) noexcept;
119 
124  simdjson_inline simdjson_result<std::string_view> raw_json() noexcept;
125 
133  simdjson_inline simdjson_result<value> at(size_t index) noexcept;
134 protected:
138  simdjson_inline error_code consume() noexcept;
139 
147  static simdjson_inline simdjson_result<array> start(value_iterator &iter) noexcept;
156  static simdjson_inline simdjson_result<array> start_root(value_iterator &iter) noexcept;
165  static simdjson_inline simdjson_result<array> started(value_iterator &iter) noexcept;
166 
174  simdjson_inline array(const value_iterator &iter) noexcept;
175 
181  value_iterator iter{};
182 
183  friend class value;
184  friend class document;
185  friend struct simdjson_result<value>;
186  friend struct simdjson_result<array>;
187  friend class array_iterator;
188 };
189 
190 } // namespace ondemand
191 } // namespace SIMDJSON_IMPLEMENTATION
192 } // namespace simdjson
193 
194 namespace simdjson {
195 
196 template<>
197 struct simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::array> : public SIMDJSON_IMPLEMENTATION::implementation_simdjson_result_base<SIMDJSON_IMPLEMENTATION::ondemand::array> {
198 public:
200  simdjson_inline simdjson_result(error_code error) noexcept;
201  simdjson_inline simdjson_result() noexcept = default;
202 
205  inline simdjson_result<size_t> count_elements() & noexcept;
206  inline simdjson_result<bool> is_empty() & noexcept;
207  inline simdjson_result<bool> reset() & noexcept;
208  simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> at(size_t index) noexcept;
209  simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> at_pointer(std::string_view json_pointer) noexcept;
210  simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> at_path(std::string_view json_path) noexcept;
211  simdjson_inline simdjson_result<std::string_view> raw_json() noexcept;
212 
213 };
214 
215 } // namespace simdjson
216 
217 #endif // SIMDJSON_GENERIC_ONDEMAND_ARRAY_H
simdjson_inline simdjson_result< value > at(size_t index) noexcept
Get the value at the given index.
Definition: array-inl.h:173
value_iterator iter
Iterator marking current position.
Definition: array.h:181
simdjson_inline simdjson_result< bool > is_empty() &noexcept
This method scans the beginning of the array and checks whether the array is empty.
Definition: array-inl.h:120
simdjson_result< value > at_pointer(std::string_view json_pointer) noexcept
Get the value associated with the given JSON pointer.
Definition: array-inl.h:131
static simdjson_inline simdjson_result< array > start(value_iterator &iter) noexcept
Begin array iteration.
Definition: array-inl.h:61
simdjson_inline simdjson_result< array_iterator > begin() noexcept
Begin array iteration.
Definition: array-inl.h:79
simdjson_inline array() noexcept=default
Create a new invalid array.
simdjson_inline error_code consume() noexcept
Go to the end of the array, no matter where you are right now.
Definition: array-inl.h:88
simdjson_inline simdjson_result< size_t > count_elements() &noexcept
This method scans the array and counts the number of elements.
Definition: array-inl.h:107
simdjson_result< value > at_path(std::string_view json_path) noexcept
Get the value associated with the given JSONPath expression.
Definition: array-inl.h:167
static simdjson_inline simdjson_result< array > start_root(value_iterator &iter) noexcept
Begin array iteration from the root.
Definition: array-inl.h:68
static simdjson_inline simdjson_result< array > started(value_iterator &iter) noexcept
Begin array iteration.
Definition: array-inl.h:73
simdjson_inline simdjson_result< std::string_view > raw_json() noexcept
Consumes the array and returns a string_view instance corresponding to the array as represented in JS...
Definition: array-inl.h:94
simdjson_inline simdjson_result< array_iterator > end() noexcept
Sentinel representing the end of the array.
Definition: array-inl.h:85
simdjson_result< bool > reset() &noexcept
Reset the iterator so that we are pointing back at the beginning of the array.
Definition: array-inl.h:127
An ephemeral JSON value returned during iteration.
Definition: value.h:21
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 simdjson operation that could fail.
Definition: error.h:215
simdjson_inline error_code error() const noexcept
The error.
Definition: error-inl.h:131
simdjson_inline T & value() &noexcept(false)
Get the result value.