Skip to content
Snippets Groups Projects
json.hpp 624 KiB
Newer Older
  • Learn to ignore specific revisions
  • 14001 14002 14003 14004 14005 14006 14007 14008 14009 14010 14011 14012 14013 14014 14015 14016 14017 14018 14019 14020 14021 14022 14023 14024 14025 14026 14027 14028 14029 14030 14031 14032 14033 14034 14035 14036 14037 14038 14039 14040 14041 14042 14043 14044 14045 14046 14047 14048 14049 14050 14051 14052 14053 14054 14055 14056 14057 14058 14059 14060 14061 14062 14063 14064 14065 14066 14067 14068 14069 14070 14071 14072 14073 14074 14075 14076 14077 14078 14079 14080 14081 14082 14083 14084 14085 14086 14087 14088 14089 14090 14091 14092 14093 14094 14095 14096 14097 14098 14099 14100 14101 14102 14103 14104 14105 14106 14107 14108 14109 14110 14111 14112 14113 14114 14115 14116 14117 14118 14119 14120 14121 14122 14123 14124 14125 14126 14127 14128 14129 14130 14131 14132 14133 14134 14135 14136 14137 14138 14139 14140 14141 14142 14143 14144 14145 14146 14147 14148 14149 14150 14151 14152 14153 14154 14155 14156 14157 14158 14159 14160 14161 14162 14163 14164 14165 14166 14167 14168 14169 14170 14171 14172 14173 14174 14175 14176 14177 14178 14179 14180 14181 14182 14183 14184 14185 14186 14187 14188 14189 14190 14191 14192 14193 14194 14195 14196 14197 14198 14199 14200 14201 14202 14203 14204 14205 14206 14207 14208 14209 14210 14211 14212 14213 14214 14215 14216 14217 14218 14219 14220 14221 14222 14223 14224 14225 14226 14227 14228 14229 14230 14231 14232 14233 14234 14235 14236 14237 14238 14239 14240 14241 14242 14243 14244 14245 14246 14247 14248 14249 14250 14251 14252 14253 14254 14255 14256 14257 14258 14259 14260 14261 14262 14263 14264 14265 14266 14267 14268 14269 14270 14271 14272 14273 14274 14275 14276 14277 14278 14279 14280 14281 14282 14283 14284 14285 14286 14287 14288 14289 14290 14291 14292 14293 14294 14295 14296 14297 14298 14299 14300 14301 14302 14303 14304 14305 14306 14307 14308 14309 14310 14311 14312 14313 14314 14315 14316 14317 14318 14319 14320 14321 14322 14323 14324 14325 14326 14327 14328 14329 14330 14331 14332 14333 14334 14335 14336 14337 14338 14339 14340 14341 14342 14343 14344 14345 14346 14347 14348 14349 14350 14351 14352 14353 14354 14355 14356 14357 14358 14359 14360 14361 14362 14363 14364 14365 14366 14367 14368 14369 14370 14371 14372 14373 14374 14375 14376 14377 14378 14379 14380 14381 14382 14383 14384 14385 14386 14387 14388 14389 14390 14391 14392 14393 14394 14395 14396 14397 14398 14399 14400 14401 14402 14403 14404 14405 14406 14407 14408 14409 14410 14411 14412 14413 14414 14415 14416 14417 14418 14419 14420 14421 14422 14423 14424 14425 14426 14427 14428 14429 14430 14431 14432 14433 14434 14435 14436 14437 14438 14439 14440 14441 14442 14443 14444 14445 14446 14447 14448 14449 14450 14451 14452 14453 14454 14455 14456 14457 14458 14459 14460 14461 14462 14463 14464 14465 14466 14467 14468 14469 14470 14471 14472 14473 14474 14475 14476 14477 14478 14479 14480 14481 14482 14483 14484 14485 14486 14487 14488 14489 14490 14491 14492 14493 14494 14495 14496 14497 14498 14499 14500 14501 14502 14503 14504 14505 14506 14507 14508 14509 14510 14511 14512 14513 14514 14515 14516 14517 14518 14519 14520 14521 14522 14523 14524 14525 14526 14527 14528 14529 14530 14531 14532 14533 14534 14535 14536 14537 14538 14539 14540 14541 14542 14543 14544 14545 14546 14547 14548 14549 14550 14551 14552 14553 14554 14555 14556 14557 14558 14559 14560 14561 14562 14563 14564 14565 14566 14567 14568 14569 14570 14571 14572 14573 14574 14575 14576 14577 14578 14579 14580 14581 14582 14583 14584 14585 14586 14587 14588 14589 14590 14591 14592 14593 14594 14595 14596 14597 14598 14599 14600 14601 14602 14603 14604 14605 14606 14607 14608 14609 14610 14611 14612 14613 14614 14615 14616 14617 14618 14619 14620 14621 14622 14623 14624 14625 14626 14627 14628 14629 14630 14631 14632 14633 14634 14635 14636 14637 14638 14639 14640 14641 14642 14643 14644 14645 14646 14647 14648 14649 14650 14651 14652 14653 14654 14655 14656 14657 14658 14659 14660 14661 14662 14663 14664 14665 14666 14667 14668 14669 14670 14671 14672 14673 14674 14675 14676 14677 14678 14679 14680 14681 14682 14683 14684 14685 14686 14687 14688 14689 14690 14691 14692 14693 14694 14695 14696 14697 14698 14699 14700 14701 14702 14703 14704 14705 14706 14707 14708 14709 14710 14711 14712 14713 14714 14715 14716 14717 14718 14719 14720 14721 14722 14723 14724 14725 14726 14727 14728 14729 14730 14731 14732 14733 14734 14735 14736 14737 14738 14739 14740 14741 14742 14743 14744 14745 14746 14747 14748 14749 14750 14751 14752 14753 14754 14755 14756 14757 14758 14759 14760 14761 14762 14763 14764 14765 14766 14767 14768 14769 14770 14771 14772 14773 14774 14775 14776 14777 14778 14779 14780 14781 14782 14783 14784 14785 14786 14787 14788 14789 14790 14791 14792 14793 14794 14795 14796 14797 14798 14799 14800 14801 14802 14803 14804 14805 14806 14807 14808 14809 14810 14811 14812 14813 14814 14815 14816 14817 14818 14819 14820 14821 14822 14823 14824 14825 14826 14827 14828 14829 14830 14831 14832 14833 14834 14835 14836 14837 14838 14839 14840 14841 14842 14843 14844 14845 14846 14847 14848 14849 14850 14851 14852 14853 14854 14855 14856 14857 14858 14859 14860 14861 14862 14863 14864 14865 14866 14867 14868 14869 14870 14871 14872 14873 14874 14875 14876 14877 14878 14879 14880 14881 14882 14883 14884 14885 14886 14887 14888 14889 14890 14891 14892 14893 14894 14895 14896 14897 14898 14899 14900 14901 14902 14903 14904 14905 14906 14907 14908 14909 14910 14911 14912 14913 14914 14915 14916 14917 14918 14919 14920 14921 14922 14923 14924 14925 14926 14927 14928 14929 14930 14931 14932 14933 14934 14935 14936 14937 14938 14939 14940 14941 14942 14943 14944 14945 14946 14947 14948 14949 14950 14951 14952 14953 14954 14955 14956 14957 14958 14959 14960 14961 14962 14963 14964 14965 14966 14967 14968 14969 14970 14971 14972 14973 14974 14975 14976 14977 14978 14979 14980 14981 14982 14983 14984 14985 14986 14987 14988 14989 14990 14991 14992 14993 14994 14995 14996 14997 14998 14999 15000
    
        @since version 1.0.0
        */
        reference operator[](const typename object_t::key_type& key)
        {
            // implicitly convert null value to an empty object
            if (is_null())
            {
                m_type = value_t::object;
                m_value.object = create<object_t>();
                assert_invariant();
            }
    
            // operator[] only works for objects
            if (JSON_LIKELY(is_object()))
            {
                return m_value.object->operator[](key);
            }
    
            JSON_THROW(type_error::create(305, "cannot use operator[] with " + std::string(type_name())));
        }
    
        /*!
        @brief read-only access specified object element
    
        Returns a const reference to the element at with specified key @a key. No
        bounds checking is performed.
    
        @warning If the element with key @a key does not exist, the behavior is
        undefined.
    
        @param[in] key  key of the element to access
    
        @return const reference to the element at key @a key
    
        @pre The element with key @a key must exist. **This precondition is
             enforced with an assertion.**
    
        @throw type_error.305 if the JSON value is not an object; in that case,
        using the [] operator with a key makes no sense.
    
        @complexity Logarithmic in the size of the container.
    
        @liveexample{The example below shows how object elements can be read using
        the `[]` operator.,operatorarray__key_type_const}
    
        @sa @ref at(const typename object_t::key_type&) for access by reference
        with range checking
        @sa @ref value() for access by value with a default value
    
        @since version 1.0.0
        */
        const_reference operator[](const typename object_t::key_type& key) const
        {
            // const operator[] only works for objects
            if (JSON_LIKELY(is_object()))
            {
                assert(m_value.object->find(key) != m_value.object->end());
                return m_value.object->find(key)->second;
            }
    
            JSON_THROW(type_error::create(305, "cannot use operator[] with " + std::string(type_name())));
        }
    
        /*!
        @brief access specified object element
    
        Returns a reference to the element at with specified key @a key.
    
        @note If @a key is not found in the object, then it is silently added to
        the object and filled with a `null` value to make `key` a valid reference.
        In case the value was `null` before, it is converted to an object.
    
        @param[in] key  key of the element to access
    
        @return reference to the element at key @a key
    
        @throw type_error.305 if the JSON value is not an object or null; in that
        cases, using the [] operator with a key makes no sense.
    
        @complexity Logarithmic in the size of the container.
    
        @liveexample{The example below shows how object elements can be read and
        written using the `[]` operator.,operatorarray__key_type}
    
        @sa @ref at(const typename object_t::key_type&) for access by reference
        with range checking
        @sa @ref value() for access by value with a default value
    
        @since version 1.1.0
        */
        template<typename T>
        reference operator[](T* key)
        {
            // implicitly convert null to object
            if (is_null())
            {
                m_type = value_t::object;
                m_value = value_t::object;
                assert_invariant();
            }
    
            // at only works for objects
            if (JSON_LIKELY(is_object()))
            {
                return m_value.object->operator[](key);
            }
    
            JSON_THROW(type_error::create(305, "cannot use operator[] with " + std::string(type_name())));
        }
    
        /*!
        @brief read-only access specified object element
    
        Returns a const reference to the element at with specified key @a key. No
        bounds checking is performed.
    
        @warning If the element with key @a key does not exist, the behavior is
        undefined.
    
        @param[in] key  key of the element to access
    
        @return const reference to the element at key @a key
    
        @pre The element with key @a key must exist. **This precondition is
             enforced with an assertion.**
    
        @throw type_error.305 if the JSON value is not an object; in that case,
        using the [] operator with a key makes no sense.
    
        @complexity Logarithmic in the size of the container.
    
        @liveexample{The example below shows how object elements can be read using
        the `[]` operator.,operatorarray__key_type_const}
    
        @sa @ref at(const typename object_t::key_type&) for access by reference
        with range checking
        @sa @ref value() for access by value with a default value
    
        @since version 1.1.0
        */
        template<typename T>
        const_reference operator[](T* key) const
        {
            // at only works for objects
            if (JSON_LIKELY(is_object()))
            {
                assert(m_value.object->find(key) != m_value.object->end());
                return m_value.object->find(key)->second;
            }
    
            JSON_THROW(type_error::create(305, "cannot use operator[] with " + std::string(type_name())));
        }
    
        /*!
        @brief access specified object element with default value
    
        Returns either a copy of an object's element at the specified key @a key
        or a given default value if no element with key @a key exists.
    
        The function is basically equivalent to executing
        @code {.cpp}
        try {
            return at(key);
        } catch(out_of_range) {
            return default_value;
        }
        @endcode
    
        @note Unlike @ref at(const typename object_t::key_type&), this function
        does not throw if the given key @a key was not found.
    
        @note Unlike @ref operator[](const typename object_t::key_type& key), this
        function does not implicitly add an element to the position defined by @a
        key. This function is furthermore also applicable to const objects.
    
        @param[in] key  key of the element to access
        @param[in] default_value  the value to return if @a key is not found
    
        @tparam ValueType type compatible to JSON values, for instance `int` for
        JSON integer numbers, `bool` for JSON booleans, or `std::vector` types for
        JSON arrays. Note the type of the expected value at @a key and the default
        value @a default_value must be compatible.
    
        @return copy of the element at key @a key or @a default_value if @a key
        is not found
    
        @throw type_error.306 if the JSON value is not an object; in that case,
        using `value()` with a key makes no sense.
    
        @complexity Logarithmic in the size of the container.
    
        @liveexample{The example below shows how object elements can be queried
        with a default value.,basic_json__value}
    
        @sa @ref at(const typename object_t::key_type&) for access by reference
        with range checking
        @sa @ref operator[](const typename object_t::key_type&) for unchecked
        access by reference
    
        @since version 1.0.0
        */
        template<class ValueType, typename std::enable_if<
                     std::is_convertible<basic_json_t, ValueType>::value, int>::type = 0>
        ValueType value(const typename object_t::key_type& key, const ValueType& default_value) const
        {
            // at only works for objects
            if (JSON_LIKELY(is_object()))
            {
                // if key is found, return value and given default value otherwise
                const auto it = find(key);
                if (it != end())
                {
                    return *it;
                }
    
                return default_value;
            }
    
            JSON_THROW(type_error::create(306, "cannot use value() with " + std::string(type_name())));
        }
    
        /*!
        @brief overload for a default value of type const char*
        @copydoc basic_json::value(const typename object_t::key_type&, ValueType) const
        */
        string_t value(const typename object_t::key_type& key, const char* default_value) const
        {
            return value(key, string_t(default_value));
        }
    
        /*!
        @brief access specified object element via JSON Pointer with default value
    
        Returns either a copy of an object's element at the specified key @a key
        or a given default value if no element with key @a key exists.
    
        The function is basically equivalent to executing
        @code {.cpp}
        try {
            return at(ptr);
        } catch(out_of_range) {
            return default_value;
        }
        @endcode
    
        @note Unlike @ref at(const json_pointer&), this function does not throw
        if the given key @a key was not found.
    
        @param[in] ptr  a JSON pointer to the element to access
        @param[in] default_value  the value to return if @a ptr found no value
    
        @tparam ValueType type compatible to JSON values, for instance `int` for
        JSON integer numbers, `bool` for JSON booleans, or `std::vector` types for
        JSON arrays. Note the type of the expected value at @a key and the default
        value @a default_value must be compatible.
    
        @return copy of the element at key @a key or @a default_value if @a key
        is not found
    
        @throw type_error.306 if the JSON value is not an object; in that case,
        using `value()` with a key makes no sense.
    
        @complexity Logarithmic in the size of the container.
    
        @liveexample{The example below shows how object elements can be queried
        with a default value.,basic_json__value_ptr}
    
        @sa @ref operator[](const json_pointer&) for unchecked access by reference
    
        @since version 2.0.2
        */
        template<class ValueType, typename std::enable_if<
                     std::is_convertible<basic_json_t, ValueType>::value, int>::type = 0>
        ValueType value(const json_pointer& ptr, const ValueType& default_value) const
        {
            // at only works for objects
            if (JSON_LIKELY(is_object()))
            {
                // if pointer resolves a value, return it or use default value
                JSON_TRY
                {
                    return ptr.get_checked(this);
                }
                JSON_CATCH (out_of_range&)
                {
                    return default_value;
                }
            }
    
            JSON_THROW(type_error::create(306, "cannot use value() with " + std::string(type_name())));
        }
    
        /*!
        @brief overload for a default value of type const char*
        @copydoc basic_json::value(const json_pointer&, ValueType) const
        */
        string_t value(const json_pointer& ptr, const char* default_value) const
        {
            return value(ptr, string_t(default_value));
        }
    
        /*!
        @brief access the first element
    
        Returns a reference to the first element in the container. For a JSON
        container `c`, the expression `c.front()` is equivalent to `*c.begin()`.
    
        @return In case of a structured type (array or object), a reference to the
        first element is returned. In case of number, string, or boolean values, a
        reference to the value is returned.
    
        @complexity Constant.
    
        @pre The JSON value must not be `null` (would throw `std::out_of_range`)
        or an empty array or object (undefined behavior, **guarded by
        assertions**).
        @post The JSON value remains unchanged.
    
        @throw invalid_iterator.214 when called on `null` value
    
        @liveexample{The following code shows an example for `front()`.,front}
    
        @sa @ref back() -- access the last element
    
        @since version 1.0.0
        */
        reference front()
        {
            return *begin();
        }
    
        /*!
        @copydoc basic_json::front()
        */
        const_reference front() const
        {
            return *cbegin();
        }
    
        /*!
        @brief access the last element
    
        Returns a reference to the last element in the container. For a JSON
        container `c`, the expression `c.back()` is equivalent to
        @code {.cpp}
        auto tmp = c.end();
        --tmp;
        return *tmp;
        @endcode
    
        @return In case of a structured type (array or object), a reference to the
        last element is returned. In case of number, string, or boolean values, a
        reference to the value is returned.
    
        @complexity Constant.
    
        @pre The JSON value must not be `null` (would throw `std::out_of_range`)
        or an empty array or object (undefined behavior, **guarded by
        assertions**).
        @post The JSON value remains unchanged.
    
        @throw invalid_iterator.214 when called on a `null` value. See example
        below.
    
        @liveexample{The following code shows an example for `back()`.,back}
    
        @sa @ref front() -- access the first element
    
        @since version 1.0.0
        */
        reference back()
        {
            auto tmp = end();
            --tmp;
            return *tmp;
        }
    
        /*!
        @copydoc basic_json::back()
        */
        const_reference back() const
        {
            auto tmp = cend();
            --tmp;
            return *tmp;
        }
    
        /*!
        @brief remove element given an iterator
    
        Removes the element specified by iterator @a pos. The iterator @a pos must
        be valid and dereferenceable. Thus the `end()` iterator (which is valid,
        but is not dereferenceable) cannot be used as a value for @a pos.
    
        If called on a primitive type other than `null`, the resulting JSON value
        will be `null`.
    
        @param[in] pos iterator to the element to remove
        @return Iterator following the last removed element. If the iterator @a
        pos refers to the last element, the `end()` iterator is returned.
    
        @tparam IteratorType an @ref iterator or @ref const_iterator
    
        @post Invalidates iterators and references at or after the point of the
        erase, including the `end()` iterator.
    
        @throw type_error.307 if called on a `null` value; example: `"cannot use
        erase() with null"`
        @throw invalid_iterator.202 if called on an iterator which does not belong
        to the current JSON value; example: `"iterator does not fit current
        value"`
        @throw invalid_iterator.205 if called on a primitive type with invalid
        iterator (i.e., any iterator which is not `begin()`); example: `"iterator
        out of range"`
    
        @complexity The complexity depends on the type:
        - objects: amortized constant
        - arrays: linear in distance between @a pos and the end of the container
        - strings: linear in the length of the string
        - other types: constant
    
        @liveexample{The example shows the result of `erase()` for different JSON
        types.,erase__IteratorType}
    
        @sa @ref erase(IteratorType, IteratorType) -- removes the elements in
        the given range
        @sa @ref erase(const typename object_t::key_type&) -- removes the element
        from an object at the given key
        @sa @ref erase(const size_type) -- removes the element from an array at
        the given index
    
        @since version 1.0.0
        */
        template<class IteratorType, typename std::enable_if<
                     std::is_same<IteratorType, typename basic_json_t::iterator>::value or
                     std::is_same<IteratorType, typename basic_json_t::const_iterator>::value, int>::type
                 = 0>
        IteratorType erase(IteratorType pos)
        {
            // make sure iterator fits the current value
            if (JSON_UNLIKELY(this != pos.m_object))
            {
                JSON_THROW(invalid_iterator::create(202, "iterator does not fit current value"));
            }
    
            IteratorType result = end();
    
            switch (m_type)
            {
                case value_t::boolean:
                case value_t::number_float:
                case value_t::number_integer:
                case value_t::number_unsigned:
                case value_t::string:
                {
                    if (JSON_UNLIKELY(not pos.m_it.primitive_iterator.is_begin()))
                    {
                        JSON_THROW(invalid_iterator::create(205, "iterator out of range"));
                    }
    
                    if (is_string())
                    {
                        AllocatorType<string_t> alloc;
                        std::allocator_traits<decltype(alloc)>::destroy(alloc, m_value.string);
                        std::allocator_traits<decltype(alloc)>::deallocate(alloc, m_value.string, 1);
                        m_value.string = nullptr;
                    }
    
                    m_type = value_t::null;
                    assert_invariant();
                    break;
                }
    
                case value_t::object:
                {
                    result.m_it.object_iterator = m_value.object->erase(pos.m_it.object_iterator);
                    break;
                }
    
                case value_t::array:
                {
                    result.m_it.array_iterator = m_value.array->erase(pos.m_it.array_iterator);
                    break;
                }
    
                default:
                    JSON_THROW(type_error::create(307, "cannot use erase() with " + std::string(type_name())));
            }
    
            return result;
        }
    
        /*!
        @brief remove elements given an iterator range
    
        Removes the element specified by the range `[first; last)`. The iterator
        @a first does not need to be dereferenceable if `first == last`: erasing
        an empty range is a no-op.
    
        If called on a primitive type other than `null`, the resulting JSON value
        will be `null`.
    
        @param[in] first iterator to the beginning of the range to remove
        @param[in] last iterator past the end of the range to remove
        @return Iterator following the last removed element. If the iterator @a
        second refers to the last element, the `end()` iterator is returned.
    
        @tparam IteratorType an @ref iterator or @ref const_iterator
    
        @post Invalidates iterators and references at or after the point of the
        erase, including the `end()` iterator.
    
        @throw type_error.307 if called on a `null` value; example: `"cannot use
        erase() with null"`
        @throw invalid_iterator.203 if called on iterators which does not belong
        to the current JSON value; example: `"iterators do not fit current value"`
        @throw invalid_iterator.204 if called on a primitive type with invalid
        iterators (i.e., if `first != begin()` and `last != end()`); example:
        `"iterators out of range"`
    
        @complexity The complexity depends on the type:
        - objects: `log(size()) + std::distance(first, last)`
        - arrays: linear in the distance between @a first and @a last, plus linear
          in the distance between @a last and end of the container
        - strings: linear in the length of the string
        - other types: constant
    
        @liveexample{The example shows the result of `erase()` for different JSON
        types.,erase__IteratorType_IteratorType}
    
        @sa @ref erase(IteratorType) -- removes the element at a given position
        @sa @ref erase(const typename object_t::key_type&) -- removes the element
        from an object at the given key
        @sa @ref erase(const size_type) -- removes the element from an array at
        the given index
    
        @since version 1.0.0
        */
        template<class IteratorType, typename std::enable_if<
                     std::is_same<IteratorType, typename basic_json_t::iterator>::value or
                     std::is_same<IteratorType, typename basic_json_t::const_iterator>::value, int>::type
                 = 0>
        IteratorType erase(IteratorType first, IteratorType last)
        {
            // make sure iterator fits the current value
            if (JSON_UNLIKELY(this != first.m_object or this != last.m_object))
            {
                JSON_THROW(invalid_iterator::create(203, "iterators do not fit current value"));
            }
    
            IteratorType result = end();
    
            switch (m_type)
            {
                case value_t::boolean:
                case value_t::number_float:
                case value_t::number_integer:
                case value_t::number_unsigned:
                case value_t::string:
                {
                    if (JSON_LIKELY(not first.m_it.primitive_iterator.is_begin()
                                    or not last.m_it.primitive_iterator.is_end()))
                    {
                        JSON_THROW(invalid_iterator::create(204, "iterators out of range"));
                    }
    
                    if (is_string())
                    {
                        AllocatorType<string_t> alloc;
                        std::allocator_traits<decltype(alloc)>::destroy(alloc, m_value.string);
                        std::allocator_traits<decltype(alloc)>::deallocate(alloc, m_value.string, 1);
                        m_value.string = nullptr;
                    }
    
                    m_type = value_t::null;
                    assert_invariant();
                    break;
                }
    
                case value_t::object:
                {
                    result.m_it.object_iterator = m_value.object->erase(first.m_it.object_iterator,
                                                  last.m_it.object_iterator);
                    break;
                }
    
                case value_t::array:
                {
                    result.m_it.array_iterator = m_value.array->erase(first.m_it.array_iterator,
                                                 last.m_it.array_iterator);
                    break;
                }
    
                default:
                    JSON_THROW(type_error::create(307, "cannot use erase() with " + std::string(type_name())));
            }
    
            return result;
        }
    
        /*!
        @brief remove element from a JSON object given a key
    
        Removes elements from a JSON object with the key value @a key.
    
        @param[in] key value of the elements to remove
    
        @return Number of elements removed. If @a ObjectType is the default
        `std::map` type, the return value will always be `0` (@a key was not
        found) or `1` (@a key was found).
    
        @post References and iterators to the erased elements are invalidated.
        Other references and iterators are not affected.
    
        @throw type_error.307 when called on a type other than JSON object;
        example: `"cannot use erase() with null"`
    
        @complexity `log(size()) + count(key)`
    
        @liveexample{The example shows the effect of `erase()`.,erase__key_type}
    
        @sa @ref erase(IteratorType) -- removes the element at a given position
        @sa @ref erase(IteratorType, IteratorType) -- removes the elements in
        the given range
        @sa @ref erase(const size_type) -- removes the element from an array at
        the given index
    
        @since version 1.0.0
        */
        size_type erase(const typename object_t::key_type& key)
        {
            // this erase only works for objects
            if (JSON_LIKELY(is_object()))
            {
                return m_value.object->erase(key);
            }
    
            JSON_THROW(type_error::create(307, "cannot use erase() with " + std::string(type_name())));
        }
    
        /*!
        @brief remove element from a JSON array given an index
    
        Removes element from a JSON array at the index @a idx.
    
        @param[in] idx index of the element to remove
    
        @throw type_error.307 when called on a type other than JSON object;
        example: `"cannot use erase() with null"`
        @throw out_of_range.401 when `idx >= size()`; example: `"array index 17
        is out of range"`
    
        @complexity Linear in distance between @a idx and the end of the container.
    
        @liveexample{The example shows the effect of `erase()`.,erase__size_type}
    
        @sa @ref erase(IteratorType) -- removes the element at a given position
        @sa @ref erase(IteratorType, IteratorType) -- removes the elements in
        the given range
        @sa @ref erase(const typename object_t::key_type&) -- removes the element
        from an object at the given key
    
        @since version 1.0.0
        */
        void erase(const size_type idx)
        {
            // this erase only works for arrays
            if (JSON_LIKELY(is_array()))
            {
                if (JSON_UNLIKELY(idx >= size()))
                {
                    JSON_THROW(out_of_range::create(401, "array index " + std::to_string(idx) + " is out of range"));
                }
    
                m_value.array->erase(m_value.array->begin() + static_cast<difference_type>(idx));
            }
            else
            {
                JSON_THROW(type_error::create(307, "cannot use erase() with " + std::string(type_name())));
            }
        }
    
        /// @}
    
    
        ////////////
        // lookup //
        ////////////
    
        /// @name lookup
        /// @{
    
        /*!
        @brief find an element in a JSON object
    
        Finds an element in a JSON object with key equivalent to @a key. If the
        element is not found or the JSON value is not an object, end() is
        returned.
    
        @note This method always returns @ref end() when executed on a JSON type
              that is not an object.
    
        @param[in] key key value of the element to search for.
    
        @return Iterator to an element with key equivalent to @a key. If no such
        element is found or the JSON value is not an object, past-the-end (see
        @ref end()) iterator is returned.
    
        @complexity Logarithmic in the size of the JSON object.
    
        @liveexample{The example shows how `find()` is used.,find__key_type}
    
        @since version 1.0.0
        */
        template<typename KeyT>
        iterator find(KeyT&& key)
        {
            auto result = end();
    
            if (is_object())
            {
                result.m_it.object_iterator = m_value.object->find(std::forward<KeyT>(key));
            }
    
            return result;
        }
    
        /*!
        @brief find an element in a JSON object
        @copydoc find(KeyT&&)
        */
        template<typename KeyT>
        const_iterator find(KeyT&& key) const
        {
            auto result = cend();
    
            if (is_object())
            {
                result.m_it.object_iterator = m_value.object->find(std::forward<KeyT>(key));
            }
    
            return result;
        }
    
        /*!
        @brief returns the number of occurrences of a key in a JSON object
    
        Returns the number of elements with key @a key. If ObjectType is the
        default `std::map` type, the return value will always be `0` (@a key was
        not found) or `1` (@a key was found).
    
        @note This method always returns `0` when executed on a JSON type that is
              not an object.
    
        @param[in] key key value of the element to count
    
        @return Number of elements with key @a key. If the JSON value is not an
        object, the return value will be `0`.
    
        @complexity Logarithmic in the size of the JSON object.
    
        @liveexample{The example shows how `count()` is used.,count}
    
        @since version 1.0.0
        */
        template<typename KeyT>
        size_type count(KeyT&& key) const
        {
            // return 0 for all nonobject types
            return is_object() ? m_value.object->count(std::forward<KeyT>(key)) : 0;
        }
    
        /// @}
    
    
        ///////////////
        // iterators //
        ///////////////
    
        /// @name iterators
        /// @{
    
        /*!
        @brief returns an iterator to the first element
    
        Returns an iterator to the first element.
    
        @image html range-begin-end.svg "Illustration from cppreference.com"
    
        @return iterator to the first element
    
        @complexity Constant.
    
        @requirement This function helps `basic_json` satisfying the
        [Container](https://en.cppreference.com/w/cpp/named_req/Container)
        requirements:
        - The complexity is constant.
    
        @liveexample{The following code shows an example for `begin()`.,begin}
    
        @sa @ref cbegin() -- returns a const iterator to the beginning
        @sa @ref end() -- returns an iterator to the end
        @sa @ref cend() -- returns a const iterator to the end
    
        @since version 1.0.0
        */
        iterator begin() noexcept
        {
            iterator result(this);
            result.set_begin();
            return result;
        }
    
        /*!
        @copydoc basic_json::cbegin()
        */
        const_iterator begin() const noexcept
        {
            return cbegin();
        }
    
        /*!
        @brief returns a const iterator to the first element
    
        Returns a const iterator to the first element.
    
        @image html range-begin-end.svg "Illustration from cppreference.com"
    
        @return const iterator to the first element
    
        @complexity Constant.
    
        @requirement This function helps `basic_json` satisfying the
        [Container](https://en.cppreference.com/w/cpp/named_req/Container)
        requirements:
        - The complexity is constant.
        - Has the semantics of `const_cast<const basic_json&>(*this).begin()`.
    
        @liveexample{The following code shows an example for `cbegin()`.,cbegin}
    
        @sa @ref begin() -- returns an iterator to the beginning
        @sa @ref end() -- returns an iterator to the end
        @sa @ref cend() -- returns a const iterator to the end
    
        @since version 1.0.0
        */
        const_iterator cbegin() const noexcept
        {
            const_iterator result(this);
            result.set_begin();
            return result;
        }
    
        /*!
        @brief returns an iterator to one past the last element
    
        Returns an iterator to one past the last element.
    
        @image html range-begin-end.svg "Illustration from cppreference.com"
    
        @return iterator one past the last element
    
        @complexity Constant.
    
        @requirement This function helps `basic_json` satisfying the
        [Container](https://en.cppreference.com/w/cpp/named_req/Container)
        requirements:
        - The complexity is constant.
    
        @liveexample{The following code shows an example for `end()`.,end}
    
        @sa @ref cend() -- returns a const iterator to the end
        @sa @ref begin() -- returns an iterator to the beginning
        @sa @ref cbegin() -- returns a const iterator to the beginning
    
        @since version 1.0.0
        */
        iterator end() noexcept
        {
            iterator result(this);
            result.set_end();
            return result;
        }
    
        /*!
        @copydoc basic_json::cend()
        */
        const_iterator end() const noexcept
        {
            return cend();
        }
    
        /*!
        @brief returns a const iterator to one past the last element
    
        Returns a const iterator to one past the last element.
    
        @image html range-begin-end.svg "Illustration from cppreference.com"
    
        @return const iterator one past the last element
    
        @complexity Constant.
    
        @requirement This function helps `basic_json` satisfying the
        [Container](https://en.cppreference.com/w/cpp/named_req/Container)
        requirements:
        - The complexity is constant.
        - Has the semantics of `const_cast<const basic_json&>(*this).end()`.
    
        @liveexample{The following code shows an example for `cend()`.,cend}
    
        @sa @ref end() -- returns an iterator to the end
        @sa @ref begin() -- returns an iterator to the beginning
        @sa @ref cbegin() -- returns a const iterator to the beginning
    
        @since version 1.0.0
        */
        const_iterator cend() const noexcept
        {
            const_iterator result(this);
            result.set_end();
            return result;
        }
    
        /*!
        @brief returns an iterator to the reverse-beginning
    
        Returns an iterator to the reverse-beginning; that is, the last element.
    
        @image html range-rbegin-rend.svg "Illustration from cppreference.com"
    
        @complexity Constant.
    
        @requirement This function helps `basic_json` satisfying the
        [ReversibleContainer](https://en.cppreference.com/w/cpp/named_req/ReversibleContainer)
        requirements:
        - The complexity is constant.
        - Has the semantics of `reverse_iterator(end())`.
    
        @liveexample{The following code shows an example for `rbegin()`.,rbegin}
    
        @sa @ref crbegin() -- returns a const reverse iterator to the beginning
        @sa @ref rend() -- returns a reverse iterator to the end
        @sa @ref crend() -- returns a const reverse iterator to the end
    
        @since version 1.0.0
        */
        reverse_iterator rbegin() noexcept
        {
            return reverse_iterator(end());
        }
    
        /*!
        @copydoc basic_json::crbegin()
        */
        const_reverse_iterator rbegin() const noexcept
        {
            return crbegin();
        }
    
        /*!
        @brief returns an iterator to the reverse-end
    
        Returns an iterator to the reverse-end; that is, one before the first
        element.
    
        @image html range-rbegin-rend.svg "Illustration from cppreference.com"
    
        @complexity Constant.
    
        @requirement This function helps `basic_json` satisfying the
        [ReversibleContainer](https://en.cppreference.com/w/cpp/named_req/ReversibleContainer)
        requirements:
        - The complexity is constant.
        - Has the semantics of `reverse_iterator(begin())`.
    
        @liveexample{The following code shows an example for `rend()`.,rend}
    
        @sa @ref crend() -- returns a const reverse iterator to the end
        @sa @ref rbegin() -- returns a reverse iterator to the beginning
        @sa @ref crbegin() -- returns a const reverse iterator to the beginning
    
        @since version 1.0.0
        */
        reverse_iterator rend() noexcept
        {
            return reverse_iterator(begin());
        }
    
        /*!
        @copydoc basic_json::crend()
        */
        const_reverse_iterator rend() const noexcept
        {
            return crend();
        }
    
        /*!
        @brief returns a const reverse iterator to the last element