Skip to content

J
json
Unverified Commit e07e8e79 by Niels Lohmann
Options

📝 updated documentation

parent 710f26f9
Showing with 128 additions and 16 deletions
doc/examples/json_pointer__back.cpp 0 → 100644
#include <iostream>
#include <nlohmann/json.hpp>
using json = nlohmann::json;
int main()
{
// different JSON Pointers
json::json_pointer ptr1("/foo");
json::json_pointer ptr2("/foo/0");
// call empty()
std::cout << "last reference token of " << ptr1 << " is " << ptr1.back() << '\n'
<< "last reference token of " << ptr2 << " is " << ptr2.back() << std::endl;
}
doc/examples/json_pointer__back.link 0 → 100644
<a target="_blank" href="https://wandbox.org/permlink/2q7gu0ZAQoMeOaAc"><b>online</b></a>
\ No newline at end of file
doc/examples/json_pointer__back.output 0 → 100644
last reference token of "/foo" is foo
last reference token of "/foo/0" is 0
doc/examples/json_pointer__pop_back.cpp 0 → 100644
#include <iostream>
#include <nlohmann/json.hpp>
using json = nlohmann::json;
int main()
{
// create empty JSON Pointer
json::json_pointer ptr("/foo/bar/baz");
std::cout << ptr << '\n';
// call pop_back()
ptr.pop_back();
std::cout << ptr << '\n';
ptr.pop_back();
std::cout << ptr << '\n';
ptr.pop_back();
std::cout << ptr << '\n';
}
doc/examples/json_pointer__pop_back.link 0 → 100644
<a target="_blank" href="https://wandbox.org/permlink/aFuDbxgbraVszcBX"><b>online</b></a>
\ No newline at end of file
doc/examples/json_pointer__pop_back.output 0 → 100644
"/foo/bar/baz"
"/foo/bar"
"/foo"
""
include/nlohmann/detail/json_pointer.hpp
......@@ -210,7 +210,7 @@ class json_pointer
@return parent of this JSON pointer; in case this JSON pointer is the root,
the root itself is returned
@complexity Constant.
@complexity Linear in the length of the JSON pointer.
@liveexample{The example shows the result of `parent_pointer` for different
JSON Pointers.,json_pointer__parent_pointer}
......@@ -230,19 +230,50 @@ class json_pointer
}
/*!
@brief remove and return last reference token
@brief remove last reference token
@pre not `empty()`
@liveexample{The example shows the usage of `pop_back`.,json_pointer__pop_back}
@complexity Constant.
@throw out_of_range.405 if JSON pointer has no parent
@since version 3.6.0
*/
std::string pop_back()
void pop_back()
{
if (JSON_UNLIKELY(empty()))
{
JSON_THROW(detail::out_of_range::create(405, "JSON pointer has no parent"));
}
auto last = reference_tokens.back();
reference_tokens.pop_back();
return last;
}
/*!
@brief return last reference token
@pre not `empty()`
@return last reference token
@liveexample{The example shows the usage of `back`.,json_pointer__back}
@complexity Constant.
@throw out_of_range.405 if JSON pointer has no parent
@since version 3.6.0
*/
const std::string& back()
{
if (JSON_UNLIKELY(empty()))
{
JSON_THROW(detail::out_of_range::create(405, "JSON pointer has no parent"));
}
return reference_tokens.back();
}
/*!
......@@ -255,7 +286,7 @@ class json_pointer
@liveexample{The example shows the result of `push_back` for different
JSON Pointers.,json_pointer__push_back}
@since version 0.6.0
@since version 3.6.0
*/
void push_back(const std::string& token)
{
......
include/nlohmann/json.hpp
......@@ -7507,7 +7507,8 @@ class basic_json
}
// get reference to parent of JSON pointer ptr
const auto last_path = ptr.pop_back();
const auto last_path = ptr.back();
ptr.pop_back();
basic_json& parent = result[ptr];
switch (parent.m_type)
......@@ -7552,7 +7553,8 @@ class basic_json
const auto operation_remove = [&result](json_pointer & ptr)
{
// get reference to parent of JSON pointer ptr
const auto last_path = ptr.pop_back();
const auto last_path = ptr.back();
ptr.pop_back();
basic_json& parent = result.at(ptr);
// remove child
......
single_include/nlohmann/json.hpp
......@@ -8620,7 +8620,7 @@ class json_pointer
@return parent of this JSON pointer; in case this JSON pointer is the root,
the root itself is returned
@complexity Constant.
@complexity Linear in the length of the JSON pointer.
@liveexample{The example shows the result of `parent_pointer` for different
JSON Pointers.,json_pointer__parent_pointer}
......@@ -8640,19 +8640,50 @@ class json_pointer
}
/*!
@brief remove and return last reference token
@brief remove last reference token
@pre not `empty()`
@liveexample{The example shows the usage of `pop_back`.,json_pointer__pop_back}
@complexity Constant.
@throw out_of_range.405 if JSON pointer has no parent
@since version 3.6.0
*/
std::string pop_back()
void pop_back()
{
if (JSON_UNLIKELY(empty()))
{
JSON_THROW(detail::out_of_range::create(405, "JSON pointer has no parent"));
}
auto last = reference_tokens.back();
reference_tokens.pop_back();
return last;
}
/*!
@brief return last reference token
@pre not `empty()`
@return last reference token
@liveexample{The example shows the usage of `back`.,json_pointer__back}
@complexity Constant.
@throw out_of_range.405 if JSON pointer has no parent
@since version 3.6.0
*/
const std::string& back()
{
if (JSON_UNLIKELY(empty()))
{
JSON_THROW(detail::out_of_range::create(405, "JSON pointer has no parent"));
}
return reference_tokens.back();
}
/*!
......@@ -8665,7 +8696,7 @@ class json_pointer
@liveexample{The example shows the result of `push_back` for different
JSON Pointers.,json_pointer__push_back}
@since version 0.6.0
@since version 3.6.0
*/
void push_back(const std::string& token)
{
......@@ -20241,7 +20272,8 @@ class basic_json
}
// get reference to parent of JSON pointer ptr
const auto last_path = ptr.pop_back();
const auto last_path = ptr.back();
ptr.pop_back();
basic_json& parent = result[ptr];
switch (parent.m_type)
......@@ -20286,7 +20318,8 @@ class basic_json
const auto operation_remove = [&result](json_pointer & ptr)
{
// get reference to parent of JSON pointer ptr
const auto last_path = ptr.pop_back();
const auto last_path = ptr.back();
ptr.pop_back();
basic_json& parent = result.at(ptr);
// remove child
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment