1405 lines
75 KiB
HTML
1405 lines
75 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.17"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Renderd7-nightly: nlohmann::json_pointer< BasicJsonType > Class Template Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="docsn.css" rel="stylesheet" type="text/css"/>
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">Renderd7-nightly
|
|
 <span id="projectnumber">v0.7.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.17 -->
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('classnlohmann_1_1json__pointer.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pri-methods">Private Member Functions</a> |
|
|
<a href="#pri-static-methods">Static Private Member Functions</a> |
|
|
<a href="#pri-attribs">Private Attributes</a> |
|
|
<a href="#friends">Friends</a> |
|
|
<a href="classnlohmann_1_1json__pointer-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">nlohmann::json_pointer< BasicJsonType > Class Template Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>JSON Pointer.
|
|
<a href="classnlohmann_1_1json__pointer.html#details">More...</a></p>
|
|
|
|
<p><code>#include <json.hpp></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a7f32d7c62841f0c4a6784cf741a6e4f8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1json__pointer.html#a7f32d7c62841f0c4a6784cf741a6e4f8">json_pointer</a> (const std::string &s="")</td></tr>
|
|
<tr class="memdesc:a7f32d7c62841f0c4a6784cf741a6e4f8"><td class="mdescLeft"> </td><td class="mdescRight">create JSON pointer <a href="classnlohmann_1_1json__pointer.html#a7f32d7c62841f0c4a6784cf741a6e4f8">More...</a><br /></td></tr>
|
|
<tr class="separator:a7f32d7c62841f0c4a6784cf741a6e4f8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3d4b15d32d096e3776c5d2c773b524f5"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1json__pointer.html#a3d4b15d32d096e3776c5d2c773b524f5">to_string</a> () const</td></tr>
|
|
<tr class="memdesc:a3d4b15d32d096e3776c5d2c773b524f5"><td class="mdescLeft"> </td><td class="mdescRight">return a string representation of the JSON pointer <a href="classnlohmann_1_1json__pointer.html#a3d4b15d32d096e3776c5d2c773b524f5">More...</a><br /></td></tr>
|
|
<tr class="separator:a3d4b15d32d096e3776c5d2c773b524f5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae9015c658f99cf3d48a8563accc79988"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1json__pointer.html#ae9015c658f99cf3d48a8563accc79988">operator std::string</a> () const</td></tr>
|
|
<tr class="memdesc:ae9015c658f99cf3d48a8563accc79988"><td class="mdescLeft"> </td><td class="mdescRight">return a string representation of the JSON pointer <a href="classnlohmann_1_1json__pointer.html#ae9015c658f99cf3d48a8563accc79988">More...</a><br /></td></tr>
|
|
<tr class="separator:ae9015c658f99cf3d48a8563accc79988"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7395bd0af29ac23fd3f21543c935cdfa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnlohmann_1_1json__pointer.html">json_pointer</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1json__pointer.html#a7395bd0af29ac23fd3f21543c935cdfa">operator/=</a> (const <a class="el" href="classnlohmann_1_1json__pointer.html">json_pointer</a> &ptr)</td></tr>
|
|
<tr class="memdesc:a7395bd0af29ac23fd3f21543c935cdfa"><td class="mdescLeft"> </td><td class="mdescRight">append another JSON pointer at the end of this JSON pointer <a href="classnlohmann_1_1json__pointer.html#a7395bd0af29ac23fd3f21543c935cdfa">More...</a><br /></td></tr>
|
|
<tr class="separator:a7395bd0af29ac23fd3f21543c935cdfa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abdd21567b2b1d69329af0f520335e68b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnlohmann_1_1json__pointer.html">json_pointer</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1json__pointer.html#abdd21567b2b1d69329af0f520335e68b">operator/=</a> (std::string token)</td></tr>
|
|
<tr class="memdesc:abdd21567b2b1d69329af0f520335e68b"><td class="mdescLeft"> </td><td class="mdescRight">append an unescaped reference token at the end of this JSON pointer <a href="classnlohmann_1_1json__pointer.html#abdd21567b2b1d69329af0f520335e68b">More...</a><br /></td></tr>
|
|
<tr class="separator:abdd21567b2b1d69329af0f520335e68b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7de51480324eb1c5a89ed552cd699875"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnlohmann_1_1json__pointer.html">json_pointer</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1json__pointer.html#a7de51480324eb1c5a89ed552cd699875">operator/=</a> (std::size_t array_idx)</td></tr>
|
|
<tr class="memdesc:a7de51480324eb1c5a89ed552cd699875"><td class="mdescLeft"> </td><td class="mdescRight">append an array index at the end of this JSON pointer <a href="classnlohmann_1_1json__pointer.html#a7de51480324eb1c5a89ed552cd699875">More...</a><br /></td></tr>
|
|
<tr class="separator:a7de51480324eb1c5a89ed552cd699875"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afdaacce1edb7145e0434e014f0e8685a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnlohmann_1_1json__pointer.html">json_pointer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1json__pointer.html#afdaacce1edb7145e0434e014f0e8685a">parent_pointer</a> () const</td></tr>
|
|
<tr class="memdesc:afdaacce1edb7145e0434e014f0e8685a"><td class="mdescLeft"> </td><td class="mdescRight">returns the parent of this JSON pointer <a href="classnlohmann_1_1json__pointer.html#afdaacce1edb7145e0434e014f0e8685a">More...</a><br /></td></tr>
|
|
<tr class="separator:afdaacce1edb7145e0434e014f0e8685a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4b1ee4d511ca195bed896a3da47e264c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1json__pointer.html#a4b1ee4d511ca195bed896a3da47e264c">pop_back</a> ()</td></tr>
|
|
<tr class="memdesc:a4b1ee4d511ca195bed896a3da47e264c"><td class="mdescLeft"> </td><td class="mdescRight">remove last reference token <a href="classnlohmann_1_1json__pointer.html#a4b1ee4d511ca195bed896a3da47e264c">More...</a><br /></td></tr>
|
|
<tr class="separator:a4b1ee4d511ca195bed896a3da47e264c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a213bc67c32a30c68ac6bf06f5195d482"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1json__pointer.html#a213bc67c32a30c68ac6bf06f5195d482">back</a> () const</td></tr>
|
|
<tr class="memdesc:a213bc67c32a30c68ac6bf06f5195d482"><td class="mdescLeft"> </td><td class="mdescRight">return last reference token <a href="classnlohmann_1_1json__pointer.html#a213bc67c32a30c68ac6bf06f5195d482">More...</a><br /></td></tr>
|
|
<tr class="separator:a213bc67c32a30c68ac6bf06f5195d482"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a697d12b5bd6205f8866691b166b7c7dc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1json__pointer.html#a697d12b5bd6205f8866691b166b7c7dc">push_back</a> (const std::string &token)</td></tr>
|
|
<tr class="memdesc:a697d12b5bd6205f8866691b166b7c7dc"><td class="mdescLeft"> </td><td class="mdescRight">append an unescaped token at the end of the reference pointer <a href="classnlohmann_1_1json__pointer.html#a697d12b5bd6205f8866691b166b7c7dc">More...</a><br /></td></tr>
|
|
<tr class="separator:a697d12b5bd6205f8866691b166b7c7dc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac228b13596d3c34185da9fe61b570194"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1json__pointer.html#ac228b13596d3c34185da9fe61b570194">push_back</a> (std::string &&token)</td></tr>
|
|
<tr class="memdesc:ac228b13596d3c34185da9fe61b570194"><td class="mdescLeft"> </td><td class="mdescRight">append an unescaped token at the end of the reference pointer <a href="classnlohmann_1_1json__pointer.html#ac228b13596d3c34185da9fe61b570194">More...</a><br /></td></tr>
|
|
<tr class="separator:ac228b13596d3c34185da9fe61b570194"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a649252bda4a2e75a0915b11a25d8bcc3"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1json__pointer.html#a649252bda4a2e75a0915b11a25d8bcc3">empty</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a649252bda4a2e75a0915b11a25d8bcc3"><td class="mdescLeft"> </td><td class="mdescRight">return whether pointer points to the root document <a href="classnlohmann_1_1json__pointer.html#a649252bda4a2e75a0915b11a25d8bcc3">More...</a><br /></td></tr>
|
|
<tr class="separator:a649252bda4a2e75a0915b11a25d8bcc3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
|
|
Private Member Functions</h2></td></tr>
|
|
<tr class="memitem:a583c726016f440ffe65553935c101ff5"><td class="memItemLeft" align="right" valign="top">BasicJsonType & </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1json__pointer.html#a583c726016f440ffe65553935c101ff5">get_and_create</a> (BasicJsonType &j) const</td></tr>
|
|
<tr class="memdesc:a583c726016f440ffe65553935c101ff5"><td class="mdescLeft"> </td><td class="mdescRight">create and return a reference to the pointed to value <a href="classnlohmann_1_1json__pointer.html#a583c726016f440ffe65553935c101ff5">More...</a><br /></td></tr>
|
|
<tr class="separator:a583c726016f440ffe65553935c101ff5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a577512ee6b7f030e8872b4d29fa5c3e5"><td class="memItemLeft" align="right" valign="top">BasicJsonType & </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1json__pointer.html#a577512ee6b7f030e8872b4d29fa5c3e5">get_unchecked</a> (BasicJsonType *ptr) const</td></tr>
|
|
<tr class="memdesc:a577512ee6b7f030e8872b4d29fa5c3e5"><td class="mdescLeft"> </td><td class="mdescRight">return a reference to the pointed to value <a href="classnlohmann_1_1json__pointer.html#a577512ee6b7f030e8872b4d29fa5c3e5">More...</a><br /></td></tr>
|
|
<tr class="separator:a577512ee6b7f030e8872b4d29fa5c3e5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a366d68a67e40d86676d3bdb52e167294"><td class="memItemLeft" align="right" valign="top">BasicJsonType & </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1json__pointer.html#a366d68a67e40d86676d3bdb52e167294">get_checked</a> (BasicJsonType *ptr) const</td></tr>
|
|
<tr class="separator:a366d68a67e40d86676d3bdb52e167294"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad6a01f8e1556eef68e5a49b33fef1548"><td class="memItemLeft" align="right" valign="top">const BasicJsonType & </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1json__pointer.html#ad6a01f8e1556eef68e5a49b33fef1548">get_unchecked</a> (const BasicJsonType *ptr) const</td></tr>
|
|
<tr class="memdesc:ad6a01f8e1556eef68e5a49b33fef1548"><td class="mdescLeft"> </td><td class="mdescRight">return a const reference to the pointed to value <a href="classnlohmann_1_1json__pointer.html#ad6a01f8e1556eef68e5a49b33fef1548">More...</a><br /></td></tr>
|
|
<tr class="separator:ad6a01f8e1556eef68e5a49b33fef1548"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a55a5bbbc3007e479607304a3e8cb9bf5"><td class="memItemLeft" align="right" valign="top">const BasicJsonType & </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1json__pointer.html#a55a5bbbc3007e479607304a3e8cb9bf5">get_checked</a> (const BasicJsonType *ptr) const</td></tr>
|
|
<tr class="separator:a55a5bbbc3007e479607304a3e8cb9bf5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a90d38e45e2d3add52d824bc55da8f772"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1json__pointer.html#a90d38e45e2d3add52d824bc55da8f772">contains</a> (const BasicJsonType *ptr) const</td></tr>
|
|
<tr class="separator:a90d38e45e2d3add52d824bc55da8f772"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-static-methods"></a>
|
|
Static Private Member Functions</h2></td></tr>
|
|
<tr class="memitem:ae28e4b79b9d4fac9e6dca29f47f946fa"><td class="memItemLeft" align="right" valign="top">static BasicJsonType::size_type </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1json__pointer.html#ae28e4b79b9d4fac9e6dca29f47f946fa">array_index</a> (const std::string &s)</td></tr>
|
|
<tr class="separator:ae28e4b79b9d4fac9e6dca29f47f946fa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae01c32c6a071c2e5198d5dfcce290e50"><td class="memItemLeft" align="right" valign="top">static std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1json__pointer.html#ae01c32c6a071c2e5198d5dfcce290e50">split</a> (const std::string &reference_string)</td></tr>
|
|
<tr class="memdesc:ae01c32c6a071c2e5198d5dfcce290e50"><td class="mdescLeft"> </td><td class="mdescRight">split the string input to reference tokens <a href="classnlohmann_1_1json__pointer.html#ae01c32c6a071c2e5198d5dfcce290e50">More...</a><br /></td></tr>
|
|
<tr class="separator:ae01c32c6a071c2e5198d5dfcce290e50"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa7649d30da9fc10b0e20704a27aea2a9"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1json__pointer.html#aa7649d30da9fc10b0e20704a27aea2a9">replace_substring</a> (std::string &s, const std::string &f, const std::string &t)</td></tr>
|
|
<tr class="memdesc:aa7649d30da9fc10b0e20704a27aea2a9"><td class="mdescLeft"> </td><td class="mdescRight">replace all occurrences of a substring by another string <a href="classnlohmann_1_1json__pointer.html#aa7649d30da9fc10b0e20704a27aea2a9">More...</a><br /></td></tr>
|
|
<tr class="separator:aa7649d30da9fc10b0e20704a27aea2a9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8abf3577f9a0087f29a233893cdc73ad"><td class="memItemLeft" align="right" valign="top"><a id="a8abf3577f9a0087f29a233893cdc73ad"></a>
|
|
static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1json__pointer.html#a8abf3577f9a0087f29a233893cdc73ad">escape</a> (std::string s)</td></tr>
|
|
<tr class="memdesc:a8abf3577f9a0087f29a233893cdc73ad"><td class="mdescLeft"> </td><td class="mdescRight">escape "~" to "~0" and "/" to "~1" <br /></td></tr>
|
|
<tr class="separator:a8abf3577f9a0087f29a233893cdc73ad"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab85442d5fbcc289b79beeefc2175446f"><td class="memItemLeft" align="right" valign="top"><a id="ab85442d5fbcc289b79beeefc2175446f"></a>
|
|
static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1json__pointer.html#ab85442d5fbcc289b79beeefc2175446f">unescape</a> (std::string &s)</td></tr>
|
|
<tr class="memdesc:ab85442d5fbcc289b79beeefc2175446f"><td class="mdescLeft"> </td><td class="mdescRight">unescape "~1" to tilde and "~0" to slash (order is important!) <br /></td></tr>
|
|
<tr class="separator:ab85442d5fbcc289b79beeefc2175446f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab0d7759d0caa6a0c0187916da28e6ee7"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1json__pointer.html#ab0d7759d0caa6a0c0187916da28e6ee7">flatten</a> (const std::string &reference_string, const BasicJsonType &value, BasicJsonType &result)</td></tr>
|
|
<tr class="separator:ab0d7759d0caa6a0c0187916da28e6ee7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a920065221e3c81676c3211c100d024a7"><td class="memItemLeft" align="right" valign="top">static BasicJsonType </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1json__pointer.html#a920065221e3c81676c3211c100d024a7">unflatten</a> (const BasicJsonType &value)</td></tr>
|
|
<tr class="separator:a920065221e3c81676c3211c100d024a7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
|
|
Private Attributes</h2></td></tr>
|
|
<tr class="memitem:a07a990a6838de4f38ee9d881e7b9fd61"><td class="memItemLeft" align="right" valign="top"><a id="a07a990a6838de4f38ee9d881e7b9fd61"></a>
|
|
std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1json__pointer.html#a07a990a6838de4f38ee9d881e7b9fd61">reference_tokens</a></td></tr>
|
|
<tr class="memdesc:a07a990a6838de4f38ee9d881e7b9fd61"><td class="mdescLeft"> </td><td class="mdescRight">the reference tokens <br /></td></tr>
|
|
<tr class="separator:a07a990a6838de4f38ee9d881e7b9fd61"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
|
|
Friends</h2></td></tr>
|
|
<tr class="memitem:a90a11fe6c7f37b1746a3ff9cb24b0d53"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnlohmann_1_1json__pointer.html">json_pointer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1json__pointer.html#a90a11fe6c7f37b1746a3ff9cb24b0d53">operator/</a> (const <a class="el" href="classnlohmann_1_1json__pointer.html">json_pointer</a> &lhs, const <a class="el" href="classnlohmann_1_1json__pointer.html">json_pointer</a> &rhs)</td></tr>
|
|
<tr class="memdesc:a90a11fe6c7f37b1746a3ff9cb24b0d53"><td class="mdescLeft"> </td><td class="mdescRight">create a new JSON pointer by appending the right JSON pointer at the end of the left JSON pointer <a href="classnlohmann_1_1json__pointer.html#a90a11fe6c7f37b1746a3ff9cb24b0d53">More...</a><br /></td></tr>
|
|
<tr class="separator:a90a11fe6c7f37b1746a3ff9cb24b0d53"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a926c9065dbed1bedc17857a813f7a46f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnlohmann_1_1json__pointer.html">json_pointer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1json__pointer.html#a926c9065dbed1bedc17857a813f7a46f">operator/</a> (const <a class="el" href="classnlohmann_1_1json__pointer.html">json_pointer</a> &ptr, std::string token)</td></tr>
|
|
<tr class="memdesc:a926c9065dbed1bedc17857a813f7a46f"><td class="mdescLeft"> </td><td class="mdescRight">create a new JSON pointer by appending the unescaped token at the end of the JSON pointer <a href="classnlohmann_1_1json__pointer.html#a926c9065dbed1bedc17857a813f7a46f">More...</a><br /></td></tr>
|
|
<tr class="separator:a926c9065dbed1bedc17857a813f7a46f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af5a4bc4f82113c271c9a0cd4d3b5f31c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnlohmann_1_1json__pointer.html">json_pointer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1json__pointer.html#af5a4bc4f82113c271c9a0cd4d3b5f31c">operator/</a> (const <a class="el" href="classnlohmann_1_1json__pointer.html">json_pointer</a> &ptr, std::size_t array_idx)</td></tr>
|
|
<tr class="memdesc:af5a4bc4f82113c271c9a0cd4d3b5f31c"><td class="mdescLeft"> </td><td class="mdescRight">create a new JSON pointer by appending the array-index-token at the end of the JSON pointer <a href="classnlohmann_1_1json__pointer.html#af5a4bc4f82113c271c9a0cd4d3b5f31c">More...</a><br /></td></tr>
|
|
<tr class="separator:af5a4bc4f82113c271c9a0cd4d3b5f31c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4667ef558c8c3f8a646bfda0c6654653"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1json__pointer.html#a4667ef558c8c3f8a646bfda0c6654653">operator==</a> (<a class="el" href="classnlohmann_1_1json__pointer.html">json_pointer</a> const &lhs, <a class="el" href="classnlohmann_1_1json__pointer.html">json_pointer</a> const &rhs) noexcept</td></tr>
|
|
<tr class="memdesc:a4667ef558c8c3f8a646bfda0c6654653"><td class="mdescLeft"> </td><td class="mdescRight">compares two JSON pointers for equality <a href="classnlohmann_1_1json__pointer.html#a4667ef558c8c3f8a646bfda0c6654653">More...</a><br /></td></tr>
|
|
<tr class="separator:a4667ef558c8c3f8a646bfda0c6654653"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6779edcf28e6f018a3bbb29c0b4b5e1e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1json__pointer.html#a6779edcf28e6f018a3bbb29c0b4b5e1e">operator!=</a> (<a class="el" href="classnlohmann_1_1json__pointer.html">json_pointer</a> const &lhs, <a class="el" href="classnlohmann_1_1json__pointer.html">json_pointer</a> const &rhs) noexcept</td></tr>
|
|
<tr class="memdesc:a6779edcf28e6f018a3bbb29c0b4b5e1e"><td class="mdescLeft"> </td><td class="mdescRight">compares two JSON pointers for inequality <a href="classnlohmann_1_1json__pointer.html#a6779edcf28e6f018a3bbb29c0b4b5e1e">More...</a><br /></td></tr>
|
|
<tr class="separator:a6779edcf28e6f018a3bbb29c0b4b5e1e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><h3>template<typename BasicJsonType><br />
|
|
class nlohmann::json_pointer< BasicJsonType ></h3>
|
|
|
|
<p>JSON Pointer. </p>
|
|
<p>A JSON pointer defines a string syntax for identifying a specific value within a JSON document. It can be used with functions <code>at</code> and <code>operator[]</code>. Furthermore, JSON pointers are the base for JSON patches.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a href="https://tools.ietf.org/html/rfc6901">RFC 6901</a></dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>version 2.0.0 </dd></dl>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a7f32d7c62841f0c4a6784cf741a6e4f8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7f32d7c62841f0c4a6784cf741a6e4f8">◆ </a></span>json_pointer()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classnlohmann_1_1json__pointer.html">nlohmann::json_pointer</a>< BasicJsonType >::<a class="el" href="classnlohmann_1_1json__pointer.html">json_pointer</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>s</em> = <code>""</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>create JSON pointer </p>
|
|
<p>Create a JSON pointer according to the syntax described in <a href="https://tools.ietf.org/html/rfc6901#section-3">Section 3 of RFC6901</a>.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">s</td><td>string representing the JSON pointer; if omitted, the empty string is assumed which references the whole JSON value</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname">parse_error.107</td><td>if the given JSON pointer <em>s</em> is nonempty and does not begin with a slash (<code>/</code>); see example below</td></tr>
|
|
<tr><td class="paramname">parse_error.108</td><td>if a tilde (<code>~</code>) in the given JSON pointer <em>s</em> is not followed by <code>0</code> (representing <code>~</code>) or <code>1</code> (representing <code>/</code>); see example below</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>@liveexample{The example shows the construction several valid JSON pointers as well as the exceptional behavior.,<a class="el" href="classnlohmann_1_1json__pointer.html" title="JSON Pointer.">json_pointer</a>}</p>
|
|
<dl class="section since"><dt>Since</dt><dd>version 2.0.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a3d4b15d32d096e3776c5d2c773b524f5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3d4b15d32d096e3776c5d2c773b524f5">◆ </a></span>to_string()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string <a class="el" href="classnlohmann_1_1json__pointer.html">nlohmann::json_pointer</a>< BasicJsonType >::to_string </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>return a string representation of the JSON pointer </p>
|
|
<dl class="section invariant"><dt>Invariant</dt><dd>For each JSON pointer <code>ptr</code>, it holds: <div class="fragment"><div class="line">ptr == <a class="code" href="classnlohmann_1_1json__pointer.html#a7f32d7c62841f0c4a6784cf741a6e4f8">json_pointer</a>(ptr.to_string());</div>
|
|
</div><!-- fragment --></dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>a string representation of the JSON pointer</dd></dl>
|
|
<p>@liveexample{The example shows the result of <code>to_string</code>.,json_pointer__to_string}</p>
|
|
<dl class="section since"><dt>Since</dt><dd>version 2.0.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae9015c658f99cf3d48a8563accc79988"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae9015c658f99cf3d48a8563accc79988">◆ </a></span>operator std::string()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classnlohmann_1_1json__pointer.html">nlohmann::json_pointer</a>< BasicJsonType >::operator std::string </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>return a string representation of the JSON pointer </p>
|
|
<dl class="section invariant"><dt>Invariant</dt><dd>For each JSON pointer <code>ptr</code>, it holds: <div class="fragment"><div class="line">ptr == <a class="code" href="classnlohmann_1_1json__pointer.html#a7f32d7c62841f0c4a6784cf741a6e4f8">json_pointer</a>(ptr.to_string());</div>
|
|
</div><!-- fragment --></dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>a string representation of the JSON pointer</dd></dl>
|
|
<p>@liveexample{The example shows the result of <code>to_string</code>.,json_pointer__to_string}</p>
|
|
<dl class="section since"><dt>Since</dt><dd>version 2.0.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7395bd0af29ac23fd3f21543c935cdfa"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7395bd0af29ac23fd3f21543c935cdfa">◆ </a></span>operator/=() <span class="overload">[1/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classnlohmann_1_1json__pointer.html">json_pointer</a>& <a class="el" href="classnlohmann_1_1json__pointer.html">nlohmann::json_pointer</a>< BasicJsonType >::operator/= </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classnlohmann_1_1json__pointer.html">json_pointer</a>< BasicJsonType > & </td>
|
|
<td class="paramname"><em>ptr</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>append another JSON pointer at the end of this JSON pointer </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ptr</td><td>JSON pointer to append </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>JSON pointer with <em>ptr</em> appended</dd></dl>
|
|
<p>@liveexample{The example shows the usage of <code>operator/=</code>.,json_pointer__operator_add}</p>
|
|
<p>@complexity Linear in the length of <em>ptr</em>.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classnlohmann_1_1json__pointer.html#abdd21567b2b1d69329af0f520335e68b">operator/=(std::string)</a> to append a reference token </dd>
|
|
<dd>
|
|
<a class="el" href="classnlohmann_1_1json__pointer.html#a7de51480324eb1c5a89ed552cd699875">operator/=(std::size_t)</a> to append an array index </dd>
|
|
<dd>
|
|
<a class="el" href="classnlohmann_1_1json__pointer.html#a90a11fe6c7f37b1746a3ff9cb24b0d53">operator/(const json_pointer&, const json_pointer&)</a> for a binary operator</dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>version 3.6.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abdd21567b2b1d69329af0f520335e68b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abdd21567b2b1d69329af0f520335e68b">◆ </a></span>operator/=() <span class="overload">[2/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classnlohmann_1_1json__pointer.html">json_pointer</a>& <a class="el" href="classnlohmann_1_1json__pointer.html">nlohmann::json_pointer</a>< BasicJsonType >::operator/= </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::string </td>
|
|
<td class="paramname"><em>token</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>append an unescaped reference token at the end of this JSON pointer </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">token</td><td>reference token to append </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>JSON pointer with <em>token</em> appended without escaping <em>token</em> </dd></dl>
|
|
<p>@liveexample{The example shows the usage of <code>operator/=</code>.,json_pointer__operator_add}</p>
|
|
<p>@complexity Amortized constant.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classnlohmann_1_1json__pointer.html#a7395bd0af29ac23fd3f21543c935cdfa">operator/=(const json_pointer&)</a> to append a JSON pointer </dd>
|
|
<dd>
|
|
<a class="el" href="classnlohmann_1_1json__pointer.html#a7de51480324eb1c5a89ed552cd699875">operator/=(std::size_t)</a> to append an array index </dd>
|
|
<dd>
|
|
<a class="el" href="classnlohmann_1_1json__pointer.html#af5a4bc4f82113c271c9a0cd4d3b5f31c">operator/(const json_pointer&, std::size_t)</a> for a binary operator</dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>version 3.6.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7de51480324eb1c5a89ed552cd699875"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7de51480324eb1c5a89ed552cd699875">◆ </a></span>operator/=() <span class="overload">[3/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classnlohmann_1_1json__pointer.html">json_pointer</a>& <a class="el" href="classnlohmann_1_1json__pointer.html">nlohmann::json_pointer</a>< BasicJsonType >::operator/= </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::size_t </td>
|
|
<td class="paramname"><em>array_idx</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>append an array index at the end of this JSON pointer </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">array_idx</td><td>array index to append </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>JSON pointer with <em>array_idx</em> appended</dd></dl>
|
|
<p>@liveexample{The example shows the usage of <code>operator/=</code>.,json_pointer__operator_add}</p>
|
|
<p>@complexity Amortized constant.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classnlohmann_1_1json__pointer.html#a7395bd0af29ac23fd3f21543c935cdfa">operator/=(const json_pointer&)</a> to append a JSON pointer </dd>
|
|
<dd>
|
|
<a class="el" href="classnlohmann_1_1json__pointer.html#abdd21567b2b1d69329af0f520335e68b">operator/=(std::string)</a> to append a reference token </dd>
|
|
<dd>
|
|
<a class="el" href="classnlohmann_1_1json__pointer.html#a926c9065dbed1bedc17857a813f7a46f">operator/(const json_pointer&, std::string)</a> for a binary operator</dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>version 3.6.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afdaacce1edb7145e0434e014f0e8685a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afdaacce1edb7145e0434e014f0e8685a">◆ </a></span>parent_pointer()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classnlohmann_1_1json__pointer.html">json_pointer</a> <a class="el" href="classnlohmann_1_1json__pointer.html">nlohmann::json_pointer</a>< BasicJsonType >::parent_pointer </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>returns the parent of this JSON pointer </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>parent of this JSON pointer; in case this JSON pointer is the root, the root itself is returned</dd></dl>
|
|
<p>@complexity Linear in the length of the JSON pointer.</p>
|
|
<p>@liveexample{The example shows the result of <code>parent_pointer</code> for different JSON Pointers.,json_pointer__parent_pointer}</p>
|
|
<dl class="section since"><dt>Since</dt><dd>version 3.6.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4b1ee4d511ca195bed896a3da47e264c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4b1ee4d511ca195bed896a3da47e264c">◆ </a></span>pop_back()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classnlohmann_1_1json__pointer.html">nlohmann::json_pointer</a>< BasicJsonType >::pop_back </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>remove last reference token </p>
|
|
<dl class="section pre"><dt>Precondition</dt><dd>not <code><a class="el" href="classnlohmann_1_1json__pointer.html#a649252bda4a2e75a0915b11a25d8bcc3" title="return whether pointer points to the root document">empty()</a></code></dd></dl>
|
|
<p>@liveexample{The example shows the usage of <code>pop_back</code>.,json_pointer__pop_back}</p>
|
|
<p>@complexity Constant.</p>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname">out_of_range.405</td><td>if JSON pointer has no parent</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section since"><dt>Since</dt><dd>version 3.6.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a213bc67c32a30c68ac6bf06f5195d482"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a213bc67c32a30c68ac6bf06f5195d482">◆ </a></span>back()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const std::string& <a class="el" href="classnlohmann_1_1json__pointer.html">nlohmann::json_pointer</a>< BasicJsonType >::back </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>return last reference token </p>
|
|
<dl class="section pre"><dt>Precondition</dt><dd>not <code><a class="el" href="classnlohmann_1_1json__pointer.html#a649252bda4a2e75a0915b11a25d8bcc3" title="return whether pointer points to the root document">empty()</a></code> </dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>last reference token</dd></dl>
|
|
<p>@liveexample{The example shows the usage of <code>back</code>.,json_pointer__back}</p>
|
|
<p>@complexity Constant.</p>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname">out_of_range.405</td><td>if JSON pointer has no parent</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section since"><dt>Since</dt><dd>version 3.6.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a697d12b5bd6205f8866691b166b7c7dc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a697d12b5bd6205f8866691b166b7c7dc">◆ </a></span>push_back() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classnlohmann_1_1json__pointer.html">nlohmann::json_pointer</a>< BasicJsonType >::push_back </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>token</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>append an unescaped token at the end of the reference pointer </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">token</td><td>token to add</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>@complexity Amortized constant.</p>
|
|
<p>@liveexample{The example shows the result of <code>push_back</code> for different JSON Pointers.,json_pointer__push_back}</p>
|
|
<dl class="section since"><dt>Since</dt><dd>version 3.6.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac228b13596d3c34185da9fe61b570194"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac228b13596d3c34185da9fe61b570194">◆ </a></span>push_back() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classnlohmann_1_1json__pointer.html">nlohmann::json_pointer</a>< BasicJsonType >::push_back </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::string && </td>
|
|
<td class="paramname"><em>token</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>append an unescaped token at the end of the reference pointer </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">token</td><td>token to add</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>@complexity Amortized constant.</p>
|
|
<p>@liveexample{The example shows the result of <code>push_back</code> for different JSON Pointers.,json_pointer__push_back}</p>
|
|
<dl class="section since"><dt>Since</dt><dd>version 3.6.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a649252bda4a2e75a0915b11a25d8bcc3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a649252bda4a2e75a0915b11a25d8bcc3">◆ </a></span>empty()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classnlohmann_1_1json__pointer.html">nlohmann::json_pointer</a>< BasicJsonType >::empty </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>return whether pointer points to the root document </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>true iff the JSON pointer points to the root document</dd></dl>
|
|
<p>@complexity Constant.</p>
|
|
<p>@exceptionsafety No-throw guarantee: this function never throws exceptions.</p>
|
|
<p>@liveexample{The example shows the result of <code>empty</code> for different JSON Pointers.,json_pointer__empty}</p>
|
|
<dl class="section since"><dt>Since</dt><dd>version 3.6.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae28e4b79b9d4fac9e6dca29f47f946fa"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae28e4b79b9d4fac9e6dca29f47f946fa">◆ </a></span>array_index()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static BasicJsonType::size_type <a class="el" href="classnlohmann_1_1json__pointer.html">nlohmann::json_pointer</a>< BasicJsonType >::array_index </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>s</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">s</td><td>reference token to be converted into an array index</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>integer representation of <em>s</em> </dd></dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname">parse_error.106</td><td>if an array index begins with '0' </td></tr>
|
|
<tr><td class="paramname">parse_error.109</td><td>if an array index begins not with a digit </td></tr>
|
|
<tr><td class="paramname">out_of_range.404</td><td>if string <em>s</em> could not be converted to an integer </td></tr>
|
|
<tr><td class="paramname">out_of_range.410</td><td>if an array index exceeds size_type </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a583c726016f440ffe65553935c101ff5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a583c726016f440ffe65553935c101ff5">◆ </a></span>get_and_create()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">BasicJsonType& <a class="el" href="classnlohmann_1_1json__pointer.html">nlohmann::json_pointer</a>< BasicJsonType >::get_and_create </td>
|
|
<td>(</td>
|
|
<td class="paramtype">BasicJsonType & </td>
|
|
<td class="paramname"><em>j</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>create and return a reference to the pointed to value </p>
|
|
<p>@complexity Linear in the number of reference tokens.</p>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname">parse_error.109</td><td>if array index is not a number </td></tr>
|
|
<tr><td class="paramname">type_error.313</td><td>if value cannot be unflattened </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a577512ee6b7f030e8872b4d29fa5c3e5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a577512ee6b7f030e8872b4d29fa5c3e5">◆ </a></span>get_unchecked() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">BasicJsonType& <a class="el" href="classnlohmann_1_1json__pointer.html">nlohmann::json_pointer</a>< BasicJsonType >::get_unchecked </td>
|
|
<td>(</td>
|
|
<td class="paramtype">BasicJsonType * </td>
|
|
<td class="paramname"><em>ptr</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>return a reference to the pointed to value </p>
|
|
<dl class="section note"><dt>Note</dt><dd>This version does not throw if a value is not present, but tries to create nested values instead. For instance, calling this function with pointer <code>"/this/that"</code> on a null value is equivalent to calling <code>operator[]("this").operator[]("that")</code> on that value, effectively changing the null value to an object.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ptr</td><td>a JSON value</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>reference to the JSON value pointed to by the JSON pointer</dd></dl>
|
|
<p>@complexity Linear in the length of the JSON pointer.</p>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname">parse_error.106</td><td>if an array index begins with '0' </td></tr>
|
|
<tr><td class="paramname">parse_error.109</td><td>if an array index was not a number </td></tr>
|
|
<tr><td class="paramname">out_of_range.404</td><td>if the JSON pointer can not be resolved </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a366d68a67e40d86676d3bdb52e167294"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a366d68a67e40d86676d3bdb52e167294">◆ </a></span>get_checked() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">BasicJsonType& <a class="el" href="classnlohmann_1_1json__pointer.html">nlohmann::json_pointer</a>< BasicJsonType >::get_checked </td>
|
|
<td>(</td>
|
|
<td class="paramtype">BasicJsonType * </td>
|
|
<td class="paramname"><em>ptr</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname">parse_error.106</td><td>if an array index begins with '0' </td></tr>
|
|
<tr><td class="paramname">parse_error.109</td><td>if an array index was not a number </td></tr>
|
|
<tr><td class="paramname">out_of_range.402</td><td>if the array index '-' is used </td></tr>
|
|
<tr><td class="paramname">out_of_range.404</td><td>if the JSON pointer can not be resolved </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad6a01f8e1556eef68e5a49b33fef1548"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad6a01f8e1556eef68e5a49b33fef1548">◆ </a></span>get_unchecked() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const BasicJsonType& <a class="el" href="classnlohmann_1_1json__pointer.html">nlohmann::json_pointer</a>< BasicJsonType >::get_unchecked </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const BasicJsonType * </td>
|
|
<td class="paramname"><em>ptr</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>return a const reference to the pointed to value </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ptr</td><td>a JSON value</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>const reference to the JSON value pointed to by the JSON pointer</dd></dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname">parse_error.106</td><td>if an array index begins with '0' </td></tr>
|
|
<tr><td class="paramname">parse_error.109</td><td>if an array index was not a number </td></tr>
|
|
<tr><td class="paramname">out_of_range.402</td><td>if the array index '-' is used </td></tr>
|
|
<tr><td class="paramname">out_of_range.404</td><td>if the JSON pointer can not be resolved </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a55a5bbbc3007e479607304a3e8cb9bf5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a55a5bbbc3007e479607304a3e8cb9bf5">◆ </a></span>get_checked() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const BasicJsonType& <a class="el" href="classnlohmann_1_1json__pointer.html">nlohmann::json_pointer</a>< BasicJsonType >::get_checked </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const BasicJsonType * </td>
|
|
<td class="paramname"><em>ptr</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname">parse_error.106</td><td>if an array index begins with '0' </td></tr>
|
|
<tr><td class="paramname">parse_error.109</td><td>if an array index was not a number </td></tr>
|
|
<tr><td class="paramname">out_of_range.402</td><td>if the array index '-' is used </td></tr>
|
|
<tr><td class="paramname">out_of_range.404</td><td>if the JSON pointer can not be resolved </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a90d38e45e2d3add52d824bc55da8f772"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a90d38e45e2d3add52d824bc55da8f772">◆ </a></span>contains()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classnlohmann_1_1json__pointer.html">nlohmann::json_pointer</a>< BasicJsonType >::contains </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const BasicJsonType * </td>
|
|
<td class="paramname"><em>ptr</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname">parse_error.106</td><td>if an array index begins with '0' </td></tr>
|
|
<tr><td class="paramname">parse_error.109</td><td>if an array index was not a number </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae01c32c6a071c2e5198d5dfcce290e50"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae01c32c6a071c2e5198d5dfcce290e50">◆ </a></span>split()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static std::vector<std::string> <a class="el" href="classnlohmann_1_1json__pointer.html">nlohmann::json_pointer</a>< BasicJsonType >::split </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>reference_string</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>split the string input to reference tokens </p>
|
|
<dl class="section note"><dt>Note</dt><dd>This function is only called by the <a class="el" href="classnlohmann_1_1json__pointer.html" title="JSON Pointer.">json_pointer</a> constructor. All exceptions below are documented there.</dd></dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname">parse_error.107</td><td>if the pointer is not empty or begins with '/' </td></tr>
|
|
<tr><td class="paramname">parse_error.108</td><td>if character '~' is not followed by '0' or '1' </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa7649d30da9fc10b0e20704a27aea2a9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa7649d30da9fc10b0e20704a27aea2a9">◆ </a></span>replace_substring()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void <a class="el" href="classnlohmann_1_1json__pointer.html">nlohmann::json_pointer</a>< BasicJsonType >::replace_substring </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::string & </td>
|
|
<td class="paramname"><em>s</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>f</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>t</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>replace all occurrences of a substring by another string </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in,out]</td><td class="paramname">s</td><td>the string to manipulate; changed so that all occurrences of <em>f</em> are replaced with <em>t</em> </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">f</td><td>the substring to replace with <em>t</em> </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">t</td><td>the string to replace <em>f</em> </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section pre"><dt>Precondition</dt><dd>The search string <em>f</em> must not be empty. <b>This precondition is enforced with an assertion.</b></dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>version 2.0.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab0d7759d0caa6a0c0187916da28e6ee7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab0d7759d0caa6a0c0187916da28e6ee7">◆ </a></span>flatten()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void <a class="el" href="classnlohmann_1_1json__pointer.html">nlohmann::json_pointer</a>< BasicJsonType >::flatten </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>reference_string</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const BasicJsonType & </td>
|
|
<td class="paramname"><em>value</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">BasicJsonType & </td>
|
|
<td class="paramname"><em>result</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">reference_string</td><td>the reference string to the current value </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>the value to consider </td></tr>
|
|
<tr><td class="paramdir">[in,out]</td><td class="paramname">result</td><td>the result object to insert values to</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section note"><dt>Note</dt><dd>Empty objects or arrays are flattened to <code>null</code>. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a920065221e3c81676c3211c100d024a7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a920065221e3c81676c3211c100d024a7">◆ </a></span>unflatten()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static BasicJsonType <a class="el" href="classnlohmann_1_1json__pointer.html">nlohmann::json_pointer</a>< BasicJsonType >::unflatten </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const BasicJsonType & </td>
|
|
<td class="paramname"><em>value</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>flattened JSON</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>unflattened JSON</dd></dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname">parse_error.109</td><td>if array index is not a number </td></tr>
|
|
<tr><td class="paramname">type_error.314</td><td>if value is not an object </td></tr>
|
|
<tr><td class="paramname">type_error.315</td><td>if object values are not primitive </td></tr>
|
|
<tr><td class="paramname">type_error.313</td><td>if value cannot be unflattened </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Friends And Related Function Documentation</h2>
|
|
<a id="a90a11fe6c7f37b1746a3ff9cb24b0d53"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a90a11fe6c7f37b1746a3ff9cb24b0d53">◆ </a></span>operator/ <span class="overload">[1/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classnlohmann_1_1json__pointer.html">json_pointer</a> operator/ </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classnlohmann_1_1json__pointer.html">json_pointer</a>< BasicJsonType > & </td>
|
|
<td class="paramname"><em>lhs</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classnlohmann_1_1json__pointer.html">json_pointer</a>< BasicJsonType > & </td>
|
|
<td class="paramname"><em>rhs</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>create a new JSON pointer by appending the right JSON pointer at the end of the left JSON pointer </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">lhs</td><td>JSON pointer </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">rhs</td><td>JSON pointer </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>a new JSON pointer with <em>rhs</em> appended to <em>lhs</em> </dd></dl>
|
|
<p>@liveexample{The example shows the usage of <code>operator/</code>.,json_pointer__operator_add_binary}</p>
|
|
<p>@complexity Linear in the length of <em>lhs</em> and <em>rhs</em>.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classnlohmann_1_1json__pointer.html#a7395bd0af29ac23fd3f21543c935cdfa">operator/=(const json_pointer&)</a> to append a JSON pointer</dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>version 3.6.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a926c9065dbed1bedc17857a813f7a46f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a926c9065dbed1bedc17857a813f7a46f">◆ </a></span>operator/ <span class="overload">[2/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classnlohmann_1_1json__pointer.html">json_pointer</a> operator/ </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classnlohmann_1_1json__pointer.html">json_pointer</a>< BasicJsonType > & </td>
|
|
<td class="paramname"><em>ptr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::string </td>
|
|
<td class="paramname"><em>token</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>create a new JSON pointer by appending the unescaped token at the end of the JSON pointer </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ptr</td><td>JSON pointer </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">token</td><td>reference token </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>a new JSON pointer with unescaped <em>token</em> appended to <em>ptr</em> </dd></dl>
|
|
<p>@liveexample{The example shows the usage of <code>operator/</code>.,json_pointer__operator_add_binary}</p>
|
|
<p>@complexity Linear in the length of <em>ptr</em>.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classnlohmann_1_1json__pointer.html#abdd21567b2b1d69329af0f520335e68b">operator/=(std::string)</a> to append a reference token</dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>version 3.6.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af5a4bc4f82113c271c9a0cd4d3b5f31c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af5a4bc4f82113c271c9a0cd4d3b5f31c">◆ </a></span>operator/ <span class="overload">[3/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classnlohmann_1_1json__pointer.html">json_pointer</a> operator/ </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classnlohmann_1_1json__pointer.html">json_pointer</a>< BasicJsonType > & </td>
|
|
<td class="paramname"><em>ptr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::size_t </td>
|
|
<td class="paramname"><em>array_idx</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>create a new JSON pointer by appending the array-index-token at the end of the JSON pointer </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ptr</td><td>JSON pointer </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">array_idx</td><td>array index </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>a new JSON pointer with <em>array_idx</em> appended to <em>ptr</em> </dd></dl>
|
|
<p>@liveexample{The example shows the usage of <code>operator/</code>.,json_pointer__operator_add_binary}</p>
|
|
<p>@complexity Linear in the length of <em>ptr</em>.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classnlohmann_1_1json__pointer.html#a7de51480324eb1c5a89ed552cd699875">operator/=(std::size_t)</a> to append an array index</dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>version 3.6.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4667ef558c8c3f8a646bfda0c6654653"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4667ef558c8c3f8a646bfda0c6654653">◆ </a></span>operator==</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool operator== </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classnlohmann_1_1json__pointer.html">json_pointer</a>< BasicJsonType > const & </td>
|
|
<td class="paramname"><em>lhs</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classnlohmann_1_1json__pointer.html">json_pointer</a>< BasicJsonType > const & </td>
|
|
<td class="paramname"><em>rhs</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>compares two JSON pointers for equality </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">lhs</td><td>JSON pointer to compare </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">rhs</td><td>JSON pointer to compare </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>whether <em>lhs</em> is equal to <em>rhs</em> </dd></dl>
|
|
<p>@complexity Linear in the length of the JSON pointer</p>
|
|
<p>@exceptionsafety No-throw guarantee: this function never throws exceptions. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6779edcf28e6f018a3bbb29c0b4b5e1e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6779edcf28e6f018a3bbb29c0b4b5e1e">◆ </a></span>operator!=</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool operator!= </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classnlohmann_1_1json__pointer.html">json_pointer</a>< BasicJsonType > const & </td>
|
|
<td class="paramname"><em>lhs</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classnlohmann_1_1json__pointer.html">json_pointer</a>< BasicJsonType > const & </td>
|
|
<td class="paramname"><em>rhs</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>compares two JSON pointers for inequality </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">lhs</td><td>JSON pointer to compare </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">rhs</td><td>JSON pointer to compare </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>whether <em>lhs</em> is not equal <em>rhs</em> </dd></dl>
|
|
<p>@complexity Linear in the length of the JSON pointer</p>
|
|
<p>@exceptionsafety No-throw guarantee: this function never throws exceptions. </p>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<div class="ttc" id="aclassnlohmann_1_1json__pointer_html_a7f32d7c62841f0c4a6784cf741a6e4f8"><div class="ttname"><a href="classnlohmann_1_1json__pointer.html#a7f32d7c62841f0c4a6784cf741a6e4f8">nlohmann::json_pointer::json_pointer</a></div><div class="ttdeci">json_pointer(const std::string &s="")</div><div class="ttdoc">create JSON pointer</div><div class="ttdef"><b>Definition:</b> json.hpp:11582</div></div>
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="namespacenlohmann.html">nlohmann</a></li><li class="navelem"><a class="el" href="classnlohmann_1_1json__pointer.html">json_pointer</a></li>
|
|
<li class="footer">Generated by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|