type_name()

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, class BinaryType = std::vector<std::uint8_t>>

JSON_HEDLEY_RETURNS_NON_NULL const char * nlohmann::basic_json< ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer, BinaryType >::type_name ( ) const

inlinenoexcept

return the type as string

Returns the type name as string to be used in error messages - usually to indicate that a function was called on a wrong JSON type.

Returns

a string representation of a the m_type member:

Value type	return value
null	"null"
boolean	"boolean"
string	"string"
number	"number" (for all number types)
object	"object"
array	"array"
binary	"binary"
discarded	"discarded"

@exceptionsafety No-throw guarantee: this function never throws exceptions.

@complexity Constant.

@liveexample{The following code exemplifies type_name() for all JSON types.,type_name}

See also

see type() – return the type of the JSON value

see operator value_t() – return the type of the JSON value (implicit)

Since

version 1.0.0, public since 2.1.0, const char* and noexcept since 3.0.0

Definition at line 24883 of file json.hpp.

    {
        {
            switch (m_type)
            {
                case value_t::null:
                    return "null";
 
                case value_t::object:
                    return "object";
 
                case value_t::array:
                    return "array";
 
                case value_t::string:
                    return "string";
 
                case value_t::boolean:
                    return "boolean";
 
                case value_t::binary:
                    return "binary";
 
                case value_t::discarded:
                    return "discarded";
 
                case value_t::number_integer:
                case value_t::number_unsigned:
                case value_t::number_float:
                default:
                    return "number";
            }
        }
    }