JSON for Modern C++  3.7.0

◆ size()

template<template< typename U, typename V, typename... Args > class ObjectType = std::map, template< typename U, typename... Args > class ArrayType = std::vector, class StringType = std::string, class BooleanType = bool, class NumberIntegerType = std::int64_t, class NumberUnsignedType = std::uint64_t, class NumberFloatType = double, template< typename U > class AllocatorType = std::allocator, template< typename T, typename SFINAE=void > class JSONSerializer = adl_serializer>
size_type nlohmann::basic_json::size ( ) const
inlinenoexcept

Returns the number of elements in a JSON value.

Returns
The return value depends on the different types and is defined as follows:
Value type return value
null 0
boolean 1
string 1
number 1
object result of function object_t::size()
array result of function array_t::size()
Example
The following code calls size() on the different value types.
1 #include <iostream>
2 #include <nlohmann/json.hpp>
3 
4 using json = nlohmann::json;
5 
6 int main()
7 {
8  // create JSON values
9  json j_null;
10  json j_boolean = true;
11  json j_number_integer = 17;
12  json j_number_float = 23.42;
13  json j_object = {{"one", 1}, {"two", 2}};
14  json j_object_empty(json::value_t::object);
15  json j_array = {1, 2, 4, 8, 16};
16  json j_array_empty(json::value_t::array);
17  json j_string = "Hello, world";
18 
19  // call size()
20  std::cout << j_null.size() << '\n';
21  std::cout << j_boolean.size() << '\n';
22  std::cout << j_number_integer.size() << '\n';
23  std::cout << j_number_float.size() << '\n';
24  std::cout << j_object.size() << '\n';
25  std::cout << j_object_empty.size() << '\n';
26  std::cout << j_array.size() << '\n';
27  std::cout << j_array_empty.size() << '\n';
28  std::cout << j_string.size() << '\n';
29 }
basic_json<> json
default JSON class
Definition: json.hpp:2355

Output (play with this example online):
0
1
1
1
2
0
5
0
1
The example code above can be translated with
g++ -std=c++11 -Isingle_include doc/examples/size.cpp -o size 
Complexity
Constant, as long as array_t and object_t satisfy the Container concept; that is, their size() functions have constant complexity.
Iterator validity
No changes.
Exception safety
No-throw guarantee: this function never throws exceptions.
Note
This function does not return the length of a string stored as JSON value - it returns the number of elements in the JSON value which is 1 in the case of a string.
Requirements
This function helps basic_json satisfying the Container requirements:
  • The complexity is constant.
  • Has the semantics of std::distance(begin(), end()).
See also
empty() – checks whether the container is empty
max_size() – returns the maximal number of elements
Since
version 1.0.0

Definition at line 19021 of file json.hpp.