simdjson 4.2.2
Ridiculously Fast JSON
Loading...
Searching...
No Matches
error.h
1#ifndef SIMDJSON_ERROR_H
2#define SIMDJSON_ERROR_H
3
4#include "simdjson/base.h"
5
6#include <string>
7#include <ostream>
8
9namespace simdjson {
10
55
62 inline bool is_fatal(error_code error) noexcept;
63
81inline const char *error_message(error_code error) noexcept;
82
86inline std::ostream& operator<<(std::ostream& out, error_code error) noexcept;
87
91struct simdjson_error : public std::exception {
96 simdjson_error(error_code error) noexcept : _error{error} { }
98 const char *what() const noexcept override { return error_message(error()); }
100 error_code error() const noexcept { return _error; }
101private:
103 error_code _error;
104};
105
106namespace internal {
107
132template<typename T>
133struct simdjson_result_base : protected std::pair<T, error_code> {
134
138 simdjson_inline simdjson_result_base() noexcept;
139
143 simdjson_inline simdjson_result_base(error_code error) noexcept;
144
148 simdjson_inline simdjson_result_base(T &&value) noexcept;
149
153 simdjson_inline simdjson_result_base(T &&value, error_code error) noexcept;
154
161 simdjson_inline void tie(T &value, error_code &error) && noexcept;
162
168 simdjson_inline error_code get(T &value) && noexcept;
169
173 simdjson_inline error_code error() const noexcept;
174
178 simdjson_inline bool has_value() const noexcept;
179#if SIMDJSON_EXCEPTIONS
180
186 simdjson_inline T& operator*() & noexcept(false);
187 simdjson_inline T&& operator*() && noexcept(false);
193 simdjson_inline T* operator->() noexcept(false);
194 simdjson_inline const T* operator->() const noexcept(false);
195
201 simdjson_inline T& value() & noexcept(false);
202
208 simdjson_inline T&& value() && noexcept(false);
209
215 simdjson_inline T&& take_value() && noexcept(false);
216
222 simdjson_inline operator T&&() && noexcept(false);
223
224#endif // SIMDJSON_EXCEPTIONS
225
244 simdjson_inline const T& value_unsafe() const& noexcept;
245
266 simdjson_inline T&& value_unsafe() && noexcept;
267
268 using value_type = T;
269 using error_type = error_code;
270}; // struct simdjson_result_base
271
272} // namespace internal
273
279template<typename T>
280struct simdjson_result : public internal::simdjson_result_base<T> {
281
285 simdjson_inline simdjson_result() noexcept;
289 simdjson_inline simdjson_result(T &&value) noexcept;
293 simdjson_inline simdjson_result(error_code error_code) noexcept;
297 simdjson_inline simdjson_result(T &&value, error_code error) noexcept;
298
305 simdjson_inline void tie(T &value, error_code &error) && noexcept;
306
312 simdjson_warn_unused simdjson_inline error_code get(T &value) && noexcept;
313
319 template <typename U = T>
320 simdjson_warn_unused simdjson_inline error_code get(std::string &value) && noexcept {
321 static_assert(std::is_same<U, std::string_view>::value, "SFINAE");
322 std::string_view v;
323 error_code error = std::forward<simdjson_result<T>>(*this).get(v);
324 if (!error) {
325 value.assign(v.data(), v.size());
326 }
327 return error;
328 }
329
333 simdjson_inline error_code error() const noexcept;
334
335
336
337#if SIMDJSON_EXCEPTIONS
338 using internal::simdjson_result_base<T>::operator*;
339 using internal::simdjson_result_base<T>::operator->;
345 simdjson_inline T& value() & noexcept(false);
346
352 simdjson_inline T&& value() && noexcept(false);
353
359 simdjson_inline T&& take_value() && noexcept(false);
360
366 simdjson_inline operator T&&() && noexcept(false);
367#endif // SIMDJSON_EXCEPTIONS
368
373 simdjson_inline const T& value_unsafe() const& noexcept;
374
379 simdjson_inline T&& value_unsafe() && noexcept;
380
381 using value_type = T;
382 using error_type = error_code;
383}; // struct simdjson_result
384
385#if SIMDJSON_EXCEPTIONS
386
387template<typename T>
388inline std::ostream& operator<<(std::ostream& out, simdjson_result<T> value) { return out << value.value(); }
389#endif // SIMDJSON_EXCEPTIONS
390
391#ifndef SIMDJSON_DISABLE_DEPRECATED_API
395using ErrorValues [[deprecated("This is an alias and will be removed, use error_code instead")]] = error_code;
396
400[[deprecated("Error codes should be stored and returned as `error_code`, use `error_message()` instead.")]]
401inline const std::string error_message(int error) noexcept;
402#endif // SIMDJSON_DISABLE_DEPRECATED_API
403} // namespace simdjson
404
405#endif // SIMDJSON_ERROR_H
The top level simdjson namespace, containing everything the library provides.
Definition base.h:8
const char * error_message(error_code error) noexcept
It is the convention throughout the code that the macro SIMDJSON_DEVELOPMENT_CHECKS determines whethe...
Definition error-inl.h:25
error_code
All possible errors returned by simdjson.
Definition error.h:19
@ SCALAR_DOCUMENT_AS_VALUE
A scalar document is treated as a value.
Definition error.h:49
@ DEPTH_ERROR
Your document exceeds the user-specified depth limitation.
Definition error.h:24
@ UNCLOSED_STRING
missing quote at the end
Definition error.h:35
@ INCORRECT_TYPE
JSON element has a different type than user expected.
Definition error.h:37
@ CAPACITY
This parser can't support a document that big.
Definition error.h:21
@ OUT_OF_ORDER_ITERATION
tried to iterate an array or object out of order (checked when SIMDJSON_DEVELOPMENT_CHECKS=1)
Definition error.h:46
@ UTF8_ERROR
the input is not valid UTF-8
Definition error.h:31
@ OUT_OF_CAPACITY
The capacity was exceeded, we cannot allocate enough memory.
Definition error.h:52
@ OUT_OF_BOUNDS
Attempted to access location outside of document.
Definition error.h:50
@ TAPE_ERROR
Something went wrong, this is a generic error. Fatal/unrecoverable error.
Definition error.h:23
@ NO_SUCH_FIELD
JSON field not found in object.
Definition error.h:40
@ UNSUPPORTED_ARCHITECTURE
unsupported architecture
Definition error.h:36
@ N_ATOM_ERROR
Problem while parsing an atom starting with the letter 'n'.
Definition error.h:28
@ NUM_ERROR_CODES
Placeholder for end of error code list.
Definition error.h:53
@ EMPTY
no structural element found
Definition error.h:33
@ INVALID_URI_FRAGMENT
Invalid URI fragment.
Definition error.h:43
@ INDEX_OUT_OF_BOUNDS
JSON array index too large.
Definition error.h:39
@ NUMBER_OUT_OF_RANGE
JSON number does not fit in 64 bits.
Definition error.h:38
@ STRING_ERROR
Problem while parsing a string.
Definition error.h:25
@ MEMALLOC
Error allocating memory, most likely out of memory.
Definition error.h:22
@ SUCCESS
No error.
Definition error.h:20
@ T_ATOM_ERROR
Problem while parsing an atom starting with the letter 't'.
Definition error.h:26
@ TRAILING_CONTENT
Unexpected trailing content in the JSON input.
Definition error.h:51
@ INCOMPLETE_ARRAY_OR_OBJECT
The document ends early. Fatal/unrecoverable error.
Definition error.h:48
@ UNEXPECTED_ERROR
indicative of a bug in simdjson
Definition error.h:44
@ UNINITIALIZED
unknown error, or uninitialized document
Definition error.h:32
@ UNESCAPED_CHARS
found unescaped characters in a string.
Definition error.h:34
@ IO_ERROR
Error reading a file.
Definition error.h:41
@ NUMBER_ERROR
Problem while parsing a number.
Definition error.h:29
@ BIGINT_ERROR
The integer value exceeds 64 bits.
Definition error.h:30
@ F_ATOM_ERROR
Problem while parsing an atom starting with the letter 'f'.
Definition error.h:27
@ PARSER_IN_USE
parser is already in use.
Definition error.h:45
@ INSUFFICIENT_PADDING
The JSON doesn't have enough padding for simdjson to safely parse it.
Definition error.h:47
@ INVALID_JSON_POINTER
Invalid JSON pointer syntax.
Definition error.h:42
bool is_fatal(error_code error) noexcept
Some errors are fatal and invalidate the document.
Definition error-inl.h:10
Exception thrown when an exception-supporting simdjson method is called.
Definition error.h:91
const char * what() const noexcept override
The error message.
Definition error.h:98
error_code error() const noexcept
The error code.
Definition error.h:100
simdjson_error(error_code error) noexcept
Create an exception from a simdjson error code.
Definition error.h:96
The result of a simdjson operation that could fail.
Definition error.h:280
simdjson_warn_unused simdjson_inline error_code get(std::string &value) &&noexcept
Copy the value to a provided std::string, only enabled for std::string_view.
Definition error.h:320