📝 added exception 403 to documentation of at (#888)
The at function throws json::out_of_range.403 when a nonexistent object key is provided (just like the usual at function). This was not documented and users could assume json::out_of_range.404 would be thrown instead. - Updated documentation. - Added example code.
This commit is contained in:
parent
184e9c6aa7
commit
3113a52a7d
8 changed files with 38 additions and 3 deletions
|
|
@ -456,7 +456,6 @@ Exceptions have ids 5xx.
|
|||
name / id | example message | description
|
||||
------------------------------ | --------------- | -------------------------
|
||||
json.exception.other_error.501 | unsuccessful: {"op":"test","path":"/baz", "value":"bar"} | A JSON Patch operation 'test' failed. The unsuccessful operation is also printed.
|
||||
json.exception.other_error.502 | invalid object size for conversion | Some conversions to user-defined types impose constraints on the object size (e.g. std::pair)
|
||||
|
||||
@sa @ref exception for the base class of the library exceptions
|
||||
@sa @ref parse_error for exceptions indicating a parse error
|
||||
|
|
@ -13721,6 +13720,9 @@ class basic_json
|
|||
pointer @a ptr. As `at` provides checked access (and no elements are
|
||||
implicitly inserted), the index '-' is always invalid. See example below.
|
||||
|
||||
@throw out_of_range.403 if the JSON pointer describes a key of an object
|
||||
which cannot be found. See example below.
|
||||
|
||||
@throw out_of_range.404 if the JSON pointer @a ptr can not be resolved.
|
||||
See example below.
|
||||
|
||||
|
|
@ -13761,6 +13763,9 @@ class basic_json
|
|||
pointer @a ptr. As `at` provides checked access (and no elements are
|
||||
implicitly inserted), the index '-' is always invalid. See example below.
|
||||
|
||||
@throw out_of_range.403 if the JSON pointer describes a key of an object
|
||||
which cannot be found. See example below.
|
||||
|
||||
@throw out_of_range.404 if the JSON pointer @a ptr can not be resolved.
|
||||
See example below.
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue