mirror of
https://github.com/nlohmann/json.git
synced 2026-10-03 22:06:59 +01:00
83 lines
1.8 KiB
Markdown
83 lines
1.8 KiB
Markdown
# nlohmann::basic_json::is_string
|
|
|
|
```
|
|
constexpr bool is_string() const noexcept;
|
|
```
|
|
|
|
This function returns `true` if and only if the JSON value is a string.
|
|
|
|
## Return value
|
|
|
|
`true` if type is a string, `false` otherwise.
|
|
|
|
## Exception safety
|
|
|
|
No-throw guarantee: this member function never throws exceptions.
|
|
|
|
## Complexity
|
|
|
|
Constant.
|
|
|
|
## Examples
|
|
|
|
Example
|
|
|
|
The following code exemplifies `is_string()` for all JSON types.
|
|
|
|
```
|
|
#include <iostream>
|
|
#include <nlohmann/json.hpp>
|
|
|
|
using json = nlohmann::json;
|
|
|
|
int main()
|
|
{
|
|
// create JSON values
|
|
json j_null;
|
|
json j_boolean = true;
|
|
json j_number_integer = 17;
|
|
json j_number_float = 23.42;
|
|
json j_number_unsigned_integer = 12345678987654321u;
|
|
json j_object = {{"one", 1}, {"two", 2}};
|
|
json j_array = {1, 2, 4, 8, 16};
|
|
json j_string = "Hello, world";
|
|
json j_binary = json::binary({1, 2, 3});
|
|
|
|
// call is_string()
|
|
std::cout << std::boolalpha;
|
|
std::cout << j_null.is_string() << '\n';
|
|
std::cout << j_boolean.is_string() << '\n';
|
|
std::cout << j_number_integer.is_string() << '\n';
|
|
std::cout << j_number_unsigned_integer.is_string() << '\n';
|
|
std::cout << j_number_float.is_string() << '\n';
|
|
std::cout << j_object.is_string() << '\n';
|
|
std::cout << j_array.is_string() << '\n';
|
|
std::cout << j_string.is_string() << '\n';
|
|
std::cout << j_binary.is_string() << '\n';
|
|
}
|
|
```
|
|
|
|
Output:
|
|
|
|
```
|
|
false
|
|
false
|
|
false
|
|
false
|
|
false
|
|
false
|
|
false
|
|
true
|
|
false
|
|
```
|
|
|
|
## See also
|
|
|
|
- [is_primitive](https://json.nlohmann.me/api/basic_json/is_primitive/index.md) checks whether the JSON value is primitive
|
|
- [type](https://json.nlohmann.me/api/basic_json/type/index.md) returns the type of the JSON value
|
|
- [string_t](https://json.nlohmann.me/api/basic_json/string_t/index.md) the type used to store JSON strings
|
|
|
|
## Version history
|
|
|
|
- Added in version 1.0.0.
|