Skip to content

Commit 696b0e2

Browse files
committed
Fixing issue 961
1 parent aa4340e commit 696b0e2

File tree

4 files changed

+31
-32
lines changed

4 files changed

+31
-32
lines changed

doc/basics.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,8 +77,7 @@ Once you have an element, you can navigate it with idiomatic C++ iterators, oper
7777

7878
* **Extracting Values:** You can cast a JSON element to a native type: `double(element)` or
7979
`double x = json_element`. This works for double, uint64_t, int64_t, bool,
80-
dom::object and dom::array. An exception is thrown if the cast is not possible. You can also use is<*typename*>() to test if it is a
81-
given type, or use the `type()` method: e.g., `element.type() == dom::element_type::DOUBLE`. Instead of casting, you can use get<*typename*>() to get the value: casts and get<*typename*>() can be used interchangeably. You can use a variant usage of get<*typename*>() with error codes to avoid exceptions: e.g.,
80+
dom::object and dom::array. An exception is thrown if the cast is not possible. You can also use is<*typename*>() to test if it is a given type, or use the equivalent without templates (`is_uint64()`, `is_uint64()`, `is_number()`, `is_double()`, , `is_bool()`, `is_integer()`, `is_string()`, `is_array()`, `is_object()`) or use the `type()` method: e.g., `element.type() == dom::element_type::DOUBLE`. Instead of casting, you can use get<*typename*>() to get the value: casts and get<*typename*>() can be used interchangeably. You can also use equivalent functions without templates: e.g., `get_string()`, `get_int64()`, `get_uint64()`, `get_double()` and `get_bool()`. You can use a variant usage of get<*typename*>() with error codes to avoid exceptions: e.g.,
8281
```c++
8382
simdjson::error_code error;
8483
simdjson::padded_string numberstring = "1.2"_padded; // our JSON input ("1.2")

include/simdjson/dom/element.h

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ class element {
9090
* Returns INCORRECT_TYPE if the JSON element is not an integer, or NUMBER_OUT_OF_RANGE
9191
* if it is negative.
9292
*/
93-
inline simdjson_result<int64_t> get_int64_t() const noexcept;
93+
inline simdjson_result<int64_t> get_int64() const noexcept;
9494
/**
9595
* Cast this element to an unsigned integer.
9696
*
@@ -100,7 +100,7 @@ class element {
100100
* Returns INCORRECT_TYPE if the JSON element is not an integer, or NUMBER_OUT_OF_RANGE
101101
* if it is too large.
102102
*/
103-
inline simdjson_result<uint64_t> get_uint64_t() const noexcept;
103+
inline simdjson_result<uint64_t> get_uint64() const noexcept;
104104
/**
105105
* Cast this element to an double floating-point.
106106
*
@@ -143,13 +143,13 @@ class element {
143143
*
144144
* Equivalent to is<int64_t>().
145145
*/
146-
inline bool is_int64_t() const noexcept;
146+
inline bool is_int64() const noexcept;
147147
/**
148148
* Whether this element is a json number that fits in an unsigned 64-bit integer.
149149
*
150150
* Equivalent to is<uint64_t>().
151151
*/
152-
inline bool is_uint64_t() const noexcept;
152+
inline bool is_uint64() const noexcept;
153153
/**
154154
* Whether this element is a json number that fits in a double.
155155
*
@@ -484,16 +484,16 @@ struct simdjson_result<dom::element> : public internal::simdjson_result_base<dom
484484
really_inline simdjson_result<dom::object> get_object() const noexcept;
485485
really_inline simdjson_result<const char *> get_c_str() const noexcept;
486486
really_inline simdjson_result<std::string_view> get_string() const noexcept;
487-
really_inline simdjson_result<int64_t> get_int64_t() const noexcept;
488-
really_inline simdjson_result<uint64_t> get_uint64_t() const noexcept;
487+
really_inline simdjson_result<int64_t> get_int64() const noexcept;
488+
really_inline simdjson_result<uint64_t> get_uint64() const noexcept;
489489
really_inline simdjson_result<double> get_double() const noexcept;
490490
really_inline simdjson_result<bool> get_bool() const noexcept;
491491

492492
really_inline simdjson_result<bool> is_array() const noexcept;
493493
really_inline simdjson_result<bool> is_object() const noexcept;
494494
really_inline simdjson_result<bool> is_string() const noexcept;
495-
really_inline simdjson_result<bool> is_int64_t() const noexcept;
496-
really_inline simdjson_result<bool> is_uint64_t() const noexcept;
495+
really_inline simdjson_result<bool> is_int64() const noexcept;
496+
really_inline simdjson_result<bool> is_uint64() const noexcept;
497497
really_inline simdjson_result<bool> is_double() const noexcept;
498498
really_inline simdjson_result<bool> is_bool() const noexcept;
499499
really_inline simdjson_result<bool> is_null() const noexcept;

include/simdjson/inline/element.h

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -55,13 +55,13 @@ really_inline simdjson_result<std::string_view> simdjson_result<dom::element>::g
5555
if (error()) { return error(); }
5656
return first.get_string();
5757
}
58-
really_inline simdjson_result<int64_t> simdjson_result<dom::element>::get_int64_t() const noexcept {
58+
really_inline simdjson_result<int64_t> simdjson_result<dom::element>::get_int64() const noexcept {
5959
if (error()) { return error(); }
60-
return first.get_int64_t();
60+
return first.get_int64();
6161
}
62-
really_inline simdjson_result<uint64_t> simdjson_result<dom::element>::get_uint64_t() const noexcept {
62+
really_inline simdjson_result<uint64_t> simdjson_result<dom::element>::get_uint64() const noexcept {
6363
if (error()) { return error(); }
64-
return first.get_uint64_t();
64+
return first.get_uint64();
6565
}
6666
really_inline simdjson_result<double> simdjson_result<dom::element>::get_double() const noexcept {
6767
if (error()) { return error(); }
@@ -84,13 +84,13 @@ really_inline simdjson_result<bool> simdjson_result<dom::element>::is_string() c
8484
if (error()) { return error(); }
8585
return first.is_string();
8686
}
87-
really_inline simdjson_result<bool> simdjson_result<dom::element>::is_int64_t() const noexcept {
87+
really_inline simdjson_result<bool> simdjson_result<dom::element>::is_int64() const noexcept {
8888
if (error()) { return error(); }
89-
return first.is_int64_t();
89+
return first.is_int64();
9090
}
91-
really_inline simdjson_result<bool> simdjson_result<dom::element>::is_uint64_t() const noexcept {
91+
really_inline simdjson_result<bool> simdjson_result<dom::element>::is_uint64() const noexcept {
9292
if (error()) { return error(); }
93-
return first.is_uint64_t();
93+
return first.is_uint64();
9494
}
9595
really_inline simdjson_result<bool> simdjson_result<dom::element>::is_double() const noexcept {
9696
if (error()) { return error(); }
@@ -207,7 +207,7 @@ inline simdjson_result<std::string_view> element::get_string() const noexcept {
207207
return INCORRECT_TYPE;
208208
}
209209
}
210-
inline simdjson_result<uint64_t> element::get_uint64_t() const noexcept {
210+
inline simdjson_result<uint64_t> element::get_uint64() const noexcept {
211211
if(unlikely(!tape.is_uint64())) { // branch rarely taken
212212
if(tape.is_int64()) {
213213
int64_t result = tape.next_tape_value<int64_t>();
@@ -220,7 +220,7 @@ inline simdjson_result<uint64_t> element::get_uint64_t() const noexcept {
220220
}
221221
return tape.next_tape_value<int64_t>();
222222
}
223-
inline simdjson_result<int64_t> element::get_int64_t() const noexcept {
223+
inline simdjson_result<int64_t> element::get_int64() const noexcept {
224224
if(unlikely(!tape.is_int64())) { // branch rarely taken
225225
if(tape.is_uint64()) {
226226
uint64_t result = tape.next_tape_value<uint64_t>();
@@ -293,16 +293,16 @@ template<> inline simdjson_result<array> element::get<array>() const noexcept {
293293
template<> inline simdjson_result<object> element::get<object>() const noexcept { return get_object(); }
294294
template<> inline simdjson_result<const char *> element::get<const char *>() const noexcept { return get_c_str(); }
295295
template<> inline simdjson_result<std::string_view> element::get<std::string_view>() const noexcept { return get_string(); }
296-
template<> inline simdjson_result<int64_t> element::get<int64_t>() const noexcept { return get_int64_t(); }
297-
template<> inline simdjson_result<uint64_t> element::get<uint64_t>() const noexcept { return get_uint64_t(); }
296+
template<> inline simdjson_result<int64_t> element::get<int64_t>() const noexcept { return get_int64(); }
297+
template<> inline simdjson_result<uint64_t> element::get<uint64_t>() const noexcept { return get_uint64(); }
298298
template<> inline simdjson_result<double> element::get<double>() const noexcept { return get_double(); }
299299
template<> inline simdjson_result<bool> element::get<bool>() const noexcept { return get_bool(); }
300300

301301
inline bool element::is_array() const noexcept { return is<array>(); }
302302
inline bool element::is_object() const noexcept { return is<object>(); }
303303
inline bool element::is_string() const noexcept { return is<std::string_view>(); }
304-
inline bool element::is_int64_t() const noexcept { return is<int64_t>(); }
305-
inline bool element::is_uint64_t() const noexcept { return is<uint64_t>(); }
304+
inline bool element::is_int64() const noexcept { return is<int64_t>(); }
305+
inline bool element::is_uint64() const noexcept { return is<uint64_t>(); }
306306
inline bool element::is_double() const noexcept { return is<double>(); }
307307
inline bool element::is_bool() const noexcept { return is<bool>(); }
308308

tests/cast_tester.h

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -229,35 +229,35 @@ template<> simdjson_result<array> cast_tester<array>::named_get(element element)
229229
template<> simdjson_result<object> cast_tester<object>::named_get(element element) { return element.get_object(); }
230230
template<> simdjson_result<const char *> cast_tester<const char *>::named_get(element element) { return element.get_c_str(); }
231231
template<> simdjson_result<std::string_view> cast_tester<std::string_view>::named_get(element element) { return element.get_string(); }
232-
template<> simdjson_result<uint64_t> cast_tester<uint64_t>::named_get(element element) { return element.get_uint64_t(); }
233-
template<> simdjson_result<int64_t> cast_tester<int64_t>::named_get(element element) { return element.get_int64_t(); }
232+
template<> simdjson_result<uint64_t> cast_tester<uint64_t>::named_get(element element) { return element.get_uint64(); }
233+
template<> simdjson_result<int64_t> cast_tester<int64_t>::named_get(element element) { return element.get_int64(); }
234234
template<> simdjson_result<double> cast_tester<double>::named_get(element element) { return element.get_double(); }
235235
template<> simdjson_result<bool> cast_tester<bool>::named_get(element element) { return element.get_bool(); }
236236

237237
template<> simdjson_result<array> cast_tester<array>::named_get(simdjson_result<element> element) { return element.get_array(); }
238238
template<> simdjson_result<object> cast_tester<object>::named_get(simdjson_result<element> element) { return element.get_object(); }
239239
template<> simdjson_result<const char *> cast_tester<const char *>::named_get(simdjson_result<element> element) { return element.get_c_str(); }
240240
template<> simdjson_result<std::string_view> cast_tester<std::string_view>::named_get(simdjson_result<element> element) { return element.get_string(); }
241-
template<> simdjson_result<uint64_t> cast_tester<uint64_t>::named_get(simdjson_result<element> element) { return element.get_uint64_t(); }
242-
template<> simdjson_result<int64_t> cast_tester<int64_t>::named_get(simdjson_result<element> element) { return element.get_int64_t(); }
241+
template<> simdjson_result<uint64_t> cast_tester<uint64_t>::named_get(simdjson_result<element> element) { return element.get_uint64(); }
242+
template<> simdjson_result<int64_t> cast_tester<int64_t>::named_get(simdjson_result<element> element) { return element.get_int64(); }
243243
template<> simdjson_result<double> cast_tester<double>::named_get(simdjson_result<element> element) { return element.get_double(); }
244244
template<> simdjson_result<bool> cast_tester<bool>::named_get(simdjson_result<element> element) { return element.get_bool(); }
245245

246246
template<> bool cast_tester<array>::named_is(element element) { return element.is_array(); }
247247
template<> bool cast_tester<object>::named_is(element element) { return element.is_object(); }
248248
template<> bool cast_tester<const char *>::named_is(element element) { return element.is_string(); }
249249
template<> bool cast_tester<std::string_view>::named_is(element element) { return element.is_string(); }
250-
template<> bool cast_tester<uint64_t>::named_is(element element) { return element.is_uint64_t(); }
251-
template<> bool cast_tester<int64_t>::named_is(element element) { return element.is_int64_t(); }
250+
template<> bool cast_tester<uint64_t>::named_is(element element) { return element.is_uint64(); }
251+
template<> bool cast_tester<int64_t>::named_is(element element) { return element.is_int64(); }
252252
template<> bool cast_tester<double>::named_is(element element) { return element.is_double(); }
253253
template<> bool cast_tester<bool>::named_is(element element) { return element.is_bool(); }
254254

255255
template<> simdjson_result<bool> cast_tester<array>::named_is(simdjson_result<element> element) { return element.is_array(); }
256256
template<> simdjson_result<bool> cast_tester<object>::named_is(simdjson_result<element> element) { return element.is_object(); }
257257
template<> simdjson_result<bool> cast_tester<const char *>::named_is(simdjson_result<element> element) { return element.is_string(); }
258258
template<> simdjson_result<bool> cast_tester<std::string_view>::named_is(simdjson_result<element> element) { return element.is_string(); }
259-
template<> simdjson_result<bool> cast_tester<uint64_t>::named_is(simdjson_result<element> element) { return element.is_uint64_t(); }
260-
template<> simdjson_result<bool> cast_tester<int64_t>::named_is(simdjson_result<element> element) { return element.is_int64_t(); }
259+
template<> simdjson_result<bool> cast_tester<uint64_t>::named_is(simdjson_result<element> element) { return element.is_uint64(); }
260+
template<> simdjson_result<bool> cast_tester<int64_t>::named_is(simdjson_result<element> element) { return element.is_int64(); }
261261
template<> simdjson_result<bool> cast_tester<double>::named_is(simdjson_result<element> element) { return element.is_double(); }
262262
template<> simdjson_result<bool> cast_tester<bool>::named_is(simdjson_result<element> element) { return element.is_bool(); }
263263

0 commit comments

Comments
 (0)