JSON for Modern C++  3.0.1

◆ erase() [3/4]

template<template< typename, typename, typename... > class ObjectType = std::map, template< typename, typename... > 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 > class AllocatorType = std::allocator, template< typename, typename=void > class JSONSerializer = adl_serializer>
size_type nlohmann::basic_json::erase ( const typename object_t::key_type &  key)
inline

Removes elements from a JSON object with the key value key.

Parameters
[in]keyvalue of the elements to remove
Returns
Number of elements removed. If ObjectType is the default std::map type, the return value will always be 0 (key was not found) or 1 (key was found).
Postcondition
References and iterators to the erased elements are invalidated. Other references and iterators are not affected.
Exceptions
type_error.307when called on a type other than JSON object; example: "cannot use erase() with null"
Complexity log(size()) + count(key)
Example The example shows the effect of erase(). erase__key_type.cpp Output (play with this example erase__key_type.link): erase__key_type.output The example code above can be translated withg++ -std=c++11 -Isrc doc/examples/erase__key_type.cpp -o erase__key_type
See also
erase(IteratorType) – removes the element at a given position
erase(IteratorType, IteratorType) – removes the elements in the given range
erase(const size_type) – removes the element from an array at the given index
Since
version 1.0.0

Definition at line 10900 of file json.hpp.