docs: correct erase() empty-range and initializer-list move documentation (#6122)

Signed-off-by: Niels Lohmann <mail@nlohmann.me>
This commit is contained in:
Shubham Shakti authored and GitHub committed 2026-11-18 08:56:46 +01:00
1 parent 2951790d40
commit 0ac14610d6
3 files changed
+13 -7

No files matched your search

@@ -265,7 +265,9 @@ basic_json(basic_json&& other) noexcept;
4. Depends on the called constructor. For types directly supported by the library (i.e., all types for which no 4. Depends on the called constructor. For types directly supported by the library (i.e., all types for which no
`to_json()` function was provided), a strong guarantee holds: if an exception is thrown, there are no changes to any `to_json()` function was provided), a strong guarantee holds: if an exception is thrown, there are no changes to any
JSON value. JSON value.
5. Strong guarantee: if an exception is thrown, there are no changes to any JSON value. 5. Strong guarantee: if an exception is thrown, there are no changes to any JSON value. Values that are moved into
`init` (e.g., `a` in `#!cpp json::object({std::move(a), 5})`) are moved when the initializer list is created,
before the constructor runs, and stay moved-from if it throws.
6. Strong guarantee: if an exception is thrown, there are no changes to any JSON value. 6. Strong guarantee: if an exception is thrown, there are no changes to any JSON value.
7. Strong guarantee: if an exception is thrown, there are no changes to any JSON value. 7. Strong guarantee: if an exception is thrown, there are no changes to any JSON value.
8. Strong guarantee: if an exception is thrown, there are no changes to any JSON value. 8. Strong guarantee: if an exception is thrown, there are no changes to any JSON value.
+7 -5
View File
@@ -26,10 +26,12 @@ void erase(const size_type idx);
If called on a primitive type other than `#!json null`, the resulting JSON value will be `#!json null`. If called on a primitive type other than `#!json null`, the resulting JSON value will be `#!json null`.
2. Remove an element range specified by `[first; last)` from a JSON value. The iterator `first` does not need to be 2. Remove an element range specified by `[first; last)` from a JSON value. For arrays and objects, the iterator `first`
dereferenceable if `first == last`: erasing an empty range is a no-op. 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 `#!json null`, the resulting JSON value will be `#!json null`. If called on a primitive type other than `#!json null`, the range must be `[begin(); end())`, and the resulting JSON
value will be `#!json null`. Any other range, including the empty ranges `[begin(); begin())` and
`[end(); end())`, throws [`invalid_iterator.204`](../../home/exceptions.md#jsonexceptioninvalid_iterator204).
3. Removes an element from a JSON object by key. 3. Removes an element from a JSON object by key.
@@ -93,8 +95,8 @@ Strong exception safety: if an exception occurs, the original value stays intact
- Throws [`invalid_iterator.203`](../../home/exceptions.md#jsonexceptioninvalid_iterator203) if called on iterators - Throws [`invalid_iterator.203`](../../home/exceptions.md#jsonexceptioninvalid_iterator203) if called on iterators
which does not belong to the current JSON value; example: `"iterators do not fit current value"` which does not belong to the current JSON value; example: `"iterators do not fit current value"`
- Throws [`invalid_iterator.204`](../../home/exceptions.md#jsonexceptioninvalid_iterator204) if called on a - Throws [`invalid_iterator.204`](../../home/exceptions.md#jsonexceptioninvalid_iterator204) if called on a
primitive type with invalid iterators (i.e., if `first != begin()` and `last != end()`); example: `"iterators out primitive type with invalid iterators (i.e., if `first != begin()` or `last != end()`, which includes the empty
of range"` ranges `[begin(); begin())` and `[end(); end())`); example: `"iterators out of range"`
3. The function can throw the following exceptions: 3. The function can throw the following exceptions:
- Throws [`type_error.307`](../../home/exceptions.md#jsonexceptiontype_error307) when called on a type other than - Throws [`type_error.307`](../../home/exceptions.md#jsonexceptiontype_error307) when called on a type other than
JSON object; example: `"cannot use erase() with null"` JSON object; example: `"cannot use erase() with null"`
+3 -1
View File
@@ -18,7 +18,9 @@ JSON object value
## Exception safety ## Exception safety
Strong guarantee: if an exception is thrown, there are no changes in the JSON value. Strong guarantee: if an exception is thrown, there are no changes in the JSON value. Values that are moved into `init`
(e.g., `a` in `#!cpp json::object({std::move(a), 5})`) are moved when the initializer list is created, before this
function runs, and stay moved-from if it throws.
## Exceptions ## Exceptions