1549 lines
83 KiB
HTML
1549 lines
83 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::detail::binary_reader< BasicJsonType, InputAdapterType, SAX > 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_1detail_1_1binary__reader.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-attribs">Private Attributes</a> |
|
|
<a href="classnlohmann_1_1detail_1_1binary__reader-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">nlohmann::detail::binary_reader< BasicJsonType, InputAdapterType, SAX > Class Template Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>deserialization of CBOR, MessagePack, and UBJSON values
|
|
<a href="classnlohmann_1_1detail_1_1binary__reader.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:ad7cb69186e01b77ec021e83137461457"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html#ad7cb69186e01b77ec021e83137461457">binary_reader</a> (InputAdapterType &&adapter)</td></tr>
|
|
<tr class="memdesc:ad7cb69186e01b77ec021e83137461457"><td class="mdescLeft"> </td><td class="mdescRight">create a binary reader <a href="classnlohmann_1_1detail_1_1binary__reader.html#ad7cb69186e01b77ec021e83137461457">More...</a><br /></td></tr>
|
|
<tr class="separator:ad7cb69186e01b77ec021e83137461457"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab4afd9ee276bbb15a0f898061aad94dd"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html#ab4afd9ee276bbb15a0f898061aad94dd">sax_parse</a> (const <a class="el" href="namespacenlohmann_1_1detail.html#aa554fc6a11519e4f347deb25a9f0db40">input_format_t</a> format, json_sax_t *sax_, const bool strict=true, const <a class="el" href="namespacenlohmann_1_1detail.html#a58bb1ef1a9ad287a9cfaf1855784d9ac">cbor_tag_handler_t</a> tag_handler=<a class="el" href="namespacenlohmann_1_1detail.html#a58bb1ef1a9ad287a9cfaf1855784d9acacb5e100e5a9a3e7f6d1fd97512215282">cbor_tag_handler_t::error</a>)</td></tr>
|
|
<tr class="separator:ab4afd9ee276bbb15a0f898061aad94dd"><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:abf2051ba57d9ea9b378a2e7c14e22b34"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html#abf2051ba57d9ea9b378a2e7c14e22b34">parse_bson_internal</a> ()</td></tr>
|
|
<tr class="memdesc:abf2051ba57d9ea9b378a2e7c14e22b34"><td class="mdescLeft"> </td><td class="mdescRight">Reads in a BSON-object and passes it to the SAX-parser. <a href="classnlohmann_1_1detail_1_1binary__reader.html#abf2051ba57d9ea9b378a2e7c14e22b34">More...</a><br /></td></tr>
|
|
<tr class="separator:abf2051ba57d9ea9b378a2e7c14e22b34"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a354cbbaaea672c024ac949e1801c4302"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html#a354cbbaaea672c024ac949e1801c4302">get_bson_cstr</a> (string_t &result)</td></tr>
|
|
<tr class="memdesc:a354cbbaaea672c024ac949e1801c4302"><td class="mdescLeft"> </td><td class="mdescRight">Parses a C-style string from the BSON input. <a href="classnlohmann_1_1detail_1_1binary__reader.html#a354cbbaaea672c024ac949e1801c4302">More...</a><br /></td></tr>
|
|
<tr class="separator:a354cbbaaea672c024ac949e1801c4302"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a23921422802aa472360dd05023e20565"><td class="memTemplParams" colspan="2">template<typename NumberType > </td></tr>
|
|
<tr class="memitem:a23921422802aa472360dd05023e20565"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html#a23921422802aa472360dd05023e20565">get_bson_string</a> (const NumberType len, string_t &result)</td></tr>
|
|
<tr class="memdesc:a23921422802aa472360dd05023e20565"><td class="mdescLeft"> </td><td class="mdescRight">Parses a zero-terminated string of length <em>len</em> from the BSON input. <a href="classnlohmann_1_1detail_1_1binary__reader.html#a23921422802aa472360dd05023e20565">More...</a><br /></td></tr>
|
|
<tr class="separator:a23921422802aa472360dd05023e20565"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9940f56290b9278c58772eda2931e599"><td class="memTemplParams" colspan="2">template<typename NumberType > </td></tr>
|
|
<tr class="memitem:a9940f56290b9278c58772eda2931e599"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html#a9940f56290b9278c58772eda2931e599">get_bson_binary</a> (const NumberType len, binary_t &result)</td></tr>
|
|
<tr class="memdesc:a9940f56290b9278c58772eda2931e599"><td class="mdescLeft"> </td><td class="mdescRight">Parses a byte array input of length <em>len</em> from the BSON input. <a href="classnlohmann_1_1detail_1_1binary__reader.html#a9940f56290b9278c58772eda2931e599">More...</a><br /></td></tr>
|
|
<tr class="separator:a9940f56290b9278c58772eda2931e599"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a23bde2450d7a5772bf5051e36ff560a4"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html#a23bde2450d7a5772bf5051e36ff560a4">parse_bson_element_internal</a> (const char_int_type element_type, const std::size_t element_type_parse_position)</td></tr>
|
|
<tr class="memdesc:a23bde2450d7a5772bf5051e36ff560a4"><td class="mdescLeft"> </td><td class="mdescRight">Read a BSON document element of the given <em>element_type</em>. <a href="classnlohmann_1_1detail_1_1binary__reader.html#a23bde2450d7a5772bf5051e36ff560a4">More...</a><br /></td></tr>
|
|
<tr class="separator:a23bde2450d7a5772bf5051e36ff560a4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4e07b75ccb2579d0e738b894f0fd8cf8"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html#a4e07b75ccb2579d0e738b894f0fd8cf8">parse_bson_element_list</a> (const bool is_array)</td></tr>
|
|
<tr class="memdesc:a4e07b75ccb2579d0e738b894f0fd8cf8"><td class="mdescLeft"> </td><td class="mdescRight">Read a BSON element list (as specified in the BSON-spec) <a href="classnlohmann_1_1detail_1_1binary__reader.html#a4e07b75ccb2579d0e738b894f0fd8cf8">More...</a><br /></td></tr>
|
|
<tr class="separator:a4e07b75ccb2579d0e738b894f0fd8cf8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a23eb89a222e22533e9fd43e76722f44f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html#a23eb89a222e22533e9fd43e76722f44f">parse_bson_array</a> ()</td></tr>
|
|
<tr class="memdesc:a23eb89a222e22533e9fd43e76722f44f"><td class="mdescLeft"> </td><td class="mdescRight">Reads an array from the BSON input and passes it to the SAX-parser. <a href="classnlohmann_1_1detail_1_1binary__reader.html#a23eb89a222e22533e9fd43e76722f44f">More...</a><br /></td></tr>
|
|
<tr class="separator:a23eb89a222e22533e9fd43e76722f44f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4e4accd5a2a41bfb2f18a8a0fcc9421c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html#a4e4accd5a2a41bfb2f18a8a0fcc9421c">parse_cbor_internal</a> (const bool get_char, const <a class="el" href="namespacenlohmann_1_1detail.html#a58bb1ef1a9ad287a9cfaf1855784d9ac">cbor_tag_handler_t</a> tag_handler)</td></tr>
|
|
<tr class="separator:a4e4accd5a2a41bfb2f18a8a0fcc9421c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a545a44ae4b3fa2b7a61d9e8517fb7154"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html#a545a44ae4b3fa2b7a61d9e8517fb7154">get_cbor_string</a> (string_t &result)</td></tr>
|
|
<tr class="memdesc:a545a44ae4b3fa2b7a61d9e8517fb7154"><td class="mdescLeft"> </td><td class="mdescRight">reads a CBOR string <a href="classnlohmann_1_1detail_1_1binary__reader.html#a545a44ae4b3fa2b7a61d9e8517fb7154">More...</a><br /></td></tr>
|
|
<tr class="separator:a545a44ae4b3fa2b7a61d9e8517fb7154"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acb001d18095dc5bcf7336ae5122b8340"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html#acb001d18095dc5bcf7336ae5122b8340">get_cbor_binary</a> (binary_t &result)</td></tr>
|
|
<tr class="memdesc:acb001d18095dc5bcf7336ae5122b8340"><td class="mdescLeft"> </td><td class="mdescRight">reads a CBOR byte array <a href="classnlohmann_1_1detail_1_1binary__reader.html#acb001d18095dc5bcf7336ae5122b8340">More...</a><br /></td></tr>
|
|
<tr class="separator:acb001d18095dc5bcf7336ae5122b8340"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3750658328bf3ec3cf23f1626f9ec3af"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html#a3750658328bf3ec3cf23f1626f9ec3af">get_cbor_array</a> (const std::size_t len, const <a class="el" href="namespacenlohmann_1_1detail.html#a58bb1ef1a9ad287a9cfaf1855784d9ac">cbor_tag_handler_t</a> tag_handler)</td></tr>
|
|
<tr class="separator:a3750658328bf3ec3cf23f1626f9ec3af"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a47092a2195bf9cd3cdb4dda67cc404ed"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html#a47092a2195bf9cd3cdb4dda67cc404ed">get_cbor_object</a> (const std::size_t len, const <a class="el" href="namespacenlohmann_1_1detail.html#a58bb1ef1a9ad287a9cfaf1855784d9ac">cbor_tag_handler_t</a> tag_handler)</td></tr>
|
|
<tr class="separator:a47092a2195bf9cd3cdb4dda67cc404ed"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae020385ce9424271d61f85d3842c02cb"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html#ae020385ce9424271d61f85d3842c02cb">parse_msgpack_internal</a> ()</td></tr>
|
|
<tr class="separator:ae020385ce9424271d61f85d3842c02cb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad8cba5585327caa550dd5b6dd25a64f8"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html#ad8cba5585327caa550dd5b6dd25a64f8">get_msgpack_string</a> (string_t &result)</td></tr>
|
|
<tr class="memdesc:ad8cba5585327caa550dd5b6dd25a64f8"><td class="mdescLeft"> </td><td class="mdescRight">reads a MessagePack string <a href="classnlohmann_1_1detail_1_1binary__reader.html#ad8cba5585327caa550dd5b6dd25a64f8">More...</a><br /></td></tr>
|
|
<tr class="separator:ad8cba5585327caa550dd5b6dd25a64f8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a389e550fd397a48121cb82d92bb7475a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html#a389e550fd397a48121cb82d92bb7475a">get_msgpack_binary</a> (binary_t &result)</td></tr>
|
|
<tr class="memdesc:a389e550fd397a48121cb82d92bb7475a"><td class="mdescLeft"> </td><td class="mdescRight">reads a MessagePack byte array <a href="classnlohmann_1_1detail_1_1binary__reader.html#a389e550fd397a48121cb82d92bb7475a">More...</a><br /></td></tr>
|
|
<tr class="separator:a389e550fd397a48121cb82d92bb7475a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0ce1d7066597952efb008aaf578b2bd6"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html#a0ce1d7066597952efb008aaf578b2bd6">get_msgpack_array</a> (const std::size_t len)</td></tr>
|
|
<tr class="separator:a0ce1d7066597952efb008aaf578b2bd6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8bebd21ceef09b6b2562e87861832700"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html#a8bebd21ceef09b6b2562e87861832700">get_msgpack_object</a> (const std::size_t len)</td></tr>
|
|
<tr class="separator:a8bebd21ceef09b6b2562e87861832700"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5a79480d661019b0f3fc615ae12f7de7"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html#a5a79480d661019b0f3fc615ae12f7de7">parse_ubjson_internal</a> (const bool get_char=true)</td></tr>
|
|
<tr class="separator:a5a79480d661019b0f3fc615ae12f7de7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4ae90db51c102e912b7eac83c78733a6"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html#a4ae90db51c102e912b7eac83c78733a6">get_ubjson_string</a> (string_t &result, const bool get_char=true)</td></tr>
|
|
<tr class="memdesc:a4ae90db51c102e912b7eac83c78733a6"><td class="mdescLeft"> </td><td class="mdescRight">reads a UBJSON string <a href="classnlohmann_1_1detail_1_1binary__reader.html#a4ae90db51c102e912b7eac83c78733a6">More...</a><br /></td></tr>
|
|
<tr class="separator:a4ae90db51c102e912b7eac83c78733a6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aba7ba9ec9a52ad2bee8baff70176aa20"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html#aba7ba9ec9a52ad2bee8baff70176aa20">get_ubjson_size_value</a> (std::size_t &result)</td></tr>
|
|
<tr class="separator:aba7ba9ec9a52ad2bee8baff70176aa20"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7b6c2d4c95d56751e233e285a5f1fea7"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html#a7b6c2d4c95d56751e233e285a5f1fea7">get_ubjson_size_type</a> (std::pair< std::size_t, char_int_type > &result)</td></tr>
|
|
<tr class="memdesc:a7b6c2d4c95d56751e233e285a5f1fea7"><td class="mdescLeft"> </td><td class="mdescRight">determine the type and size for a container <a href="classnlohmann_1_1detail_1_1binary__reader.html#a7b6c2d4c95d56751e233e285a5f1fea7">More...</a><br /></td></tr>
|
|
<tr class="separator:a7b6c2d4c95d56751e233e285a5f1fea7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7e5e0b71548d0649ce4f131280d06c33"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html#a7e5e0b71548d0649ce4f131280d06c33">get_ubjson_value</a> (const char_int_type prefix)</td></tr>
|
|
<tr class="separator:a7e5e0b71548d0649ce4f131280d06c33"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afb36cb588b795efa513fc95e949493b7"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html#afb36cb588b795efa513fc95e949493b7">get_ubjson_array</a> ()</td></tr>
|
|
<tr class="separator:afb36cb588b795efa513fc95e949493b7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adcf64ad3207f4bf37a5a31c920a385c3"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html#adcf64ad3207f4bf37a5a31c920a385c3">get_ubjson_object</a> ()</td></tr>
|
|
<tr class="separator:adcf64ad3207f4bf37a5a31c920a385c3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad222095c0b21a87824cb10629299629a"><td class="memItemLeft" align="right" valign="top">char_int_type </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html#ad222095c0b21a87824cb10629299629a">get</a> ()</td></tr>
|
|
<tr class="memdesc:ad222095c0b21a87824cb10629299629a"><td class="mdescLeft"> </td><td class="mdescRight">get next character from the input <a href="classnlohmann_1_1detail_1_1binary__reader.html#ad222095c0b21a87824cb10629299629a">More...</a><br /></td></tr>
|
|
<tr class="separator:ad222095c0b21a87824cb10629299629a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a252c1179651d22c5343bcf0b538ed26a"><td class="memItemLeft" align="right" valign="top">char_int_type </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html#a252c1179651d22c5343bcf0b538ed26a">get_ignore_noop</a> ()</td></tr>
|
|
<tr class="separator:a252c1179651d22c5343bcf0b538ed26a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a540919db22df36512f05a88945c13263"><td class="memTemplParams" colspan="2">template<typename NumberType > </td></tr>
|
|
<tr class="memitem:a540919db22df36512f05a88945c13263"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html#a540919db22df36512f05a88945c13263">get_string</a> (const <a class="el" href="namespacenlohmann_1_1detail.html#aa554fc6a11519e4f347deb25a9f0db40">input_format_t</a> format, const NumberType len, string_t &result)</td></tr>
|
|
<tr class="memdesc:a540919db22df36512f05a88945c13263"><td class="mdescLeft"> </td><td class="mdescRight">create a string by reading characters from the input <a href="classnlohmann_1_1detail_1_1binary__reader.html#a540919db22df36512f05a88945c13263">More...</a><br /></td></tr>
|
|
<tr class="separator:a540919db22df36512f05a88945c13263"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a55e13d567a53234573ab3833c0ca32e9"><td class="memTemplParams" colspan="2">template<typename NumberType > </td></tr>
|
|
<tr class="memitem:a55e13d567a53234573ab3833c0ca32e9"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html#a55e13d567a53234573ab3833c0ca32e9">get_binary</a> (const <a class="el" href="namespacenlohmann_1_1detail.html#aa554fc6a11519e4f347deb25a9f0db40">input_format_t</a> format, const NumberType len, binary_t &result)</td></tr>
|
|
<tr class="memdesc:a55e13d567a53234573ab3833c0ca32e9"><td class="mdescLeft"> </td><td class="mdescRight">create a byte array by reading bytes from the input <a href="classnlohmann_1_1detail_1_1binary__reader.html#a55e13d567a53234573ab3833c0ca32e9">More...</a><br /></td></tr>
|
|
<tr class="separator:a55e13d567a53234573ab3833c0ca32e9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a61a0bd8bbe7b560bd429fa990ba3ba1a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html#a61a0bd8bbe7b560bd429fa990ba3ba1a">unexpect_eof</a> (const <a class="el" href="namespacenlohmann_1_1detail.html#aa554fc6a11519e4f347deb25a9f0db40">input_format_t</a> format, const char *context) const</td></tr>
|
|
<tr class="separator:a61a0bd8bbe7b560bd429fa990ba3ba1a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7d323283c60a0b89ee5eeadf5cb9a5ad"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html#a7d323283c60a0b89ee5eeadf5cb9a5ad">get_token_string</a> () const</td></tr>
|
|
<tr class="separator:a7d323283c60a0b89ee5eeadf5cb9a5ad"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9c413c9a1bade1ce345740f4d69156f0"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html#a9c413c9a1bade1ce345740f4d69156f0">exception_message</a> (const <a class="el" href="namespacenlohmann_1_1detail.html#aa554fc6a11519e4f347deb25a9f0db40">input_format_t</a> format, const std::string &detail, const std::string &context) const</td></tr>
|
|
<tr class="separator:a9c413c9a1bade1ce345740f4d69156f0"><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:a548c770e60f2285a931de4b7333c1ab0"><td class="memItemLeft" align="right" valign="top"><a id="a548c770e60f2285a931de4b7333c1ab0"></a>
|
|
InputAdapterType </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html#a548c770e60f2285a931de4b7333c1ab0">ia</a></td></tr>
|
|
<tr class="memdesc:a548c770e60f2285a931de4b7333c1ab0"><td class="mdescLeft"> </td><td class="mdescRight">input adapter <br /></td></tr>
|
|
<tr class="separator:a548c770e60f2285a931de4b7333c1ab0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab47df98119524e9c7d9ff0b820913883"><td class="memItemLeft" align="right" valign="top"><a id="ab47df98119524e9c7d9ff0b820913883"></a>
|
|
char_int_type </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html#ab47df98119524e9c7d9ff0b820913883">current</a> = std::char_traits<char_type>::eof()</td></tr>
|
|
<tr class="memdesc:ab47df98119524e9c7d9ff0b820913883"><td class="mdescLeft"> </td><td class="mdescRight">the current character <br /></td></tr>
|
|
<tr class="separator:ab47df98119524e9c7d9ff0b820913883"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa03c779d4512b5764895dc341b0ef902"><td class="memItemLeft" align="right" valign="top"><a id="aa03c779d4512b5764895dc341b0ef902"></a>
|
|
std::size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html#aa03c779d4512b5764895dc341b0ef902">chars_read</a> = 0</td></tr>
|
|
<tr class="memdesc:aa03c779d4512b5764895dc341b0ef902"><td class="mdescLeft"> </td><td class="mdescRight">the number of characters read <br /></td></tr>
|
|
<tr class="separator:aa03c779d4512b5764895dc341b0ef902"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad615eba561e265165a80c95061af75b0"><td class="memItemLeft" align="right" valign="top"><a id="ad615eba561e265165a80c95061af75b0"></a>
|
|
const bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html#ad615eba561e265165a80c95061af75b0">is_little_endian</a> = little_endianess()</td></tr>
|
|
<tr class="memdesc:ad615eba561e265165a80c95061af75b0"><td class="mdescLeft"> </td><td class="mdescRight">whether we can assume little endianess <br /></td></tr>
|
|
<tr class="separator:ad615eba561e265165a80c95061af75b0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aba4d89d9d38235f72f60332d6c385222"><td class="memItemLeft" align="right" valign="top"><a id="aba4d89d9d38235f72f60332d6c385222"></a>
|
|
json_sax_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html#aba4d89d9d38235f72f60332d6c385222">sax</a> = nullptr</td></tr>
|
|
<tr class="memdesc:aba4d89d9d38235f72f60332d6c385222"><td class="mdescLeft"> </td><td class="mdescRight">the SAX parser <br /></td></tr>
|
|
<tr class="separator:aba4d89d9d38235f72f60332d6c385222"><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, typename InputAdapterType, typename SAX = json_sax_dom_parser<BasicJsonType>><br />
|
|
class nlohmann::detail::binary_reader< BasicJsonType, InputAdapterType, SAX ></h3>
|
|
|
|
<p>deserialization of CBOR, MessagePack, and UBJSON values </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="ad7cb69186e01b77ec021e83137461457"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad7cb69186e01b77ec021e83137461457">◆ </a></span>binary_reader()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType , typename InputAdapterType , typename SAX = json_sax_dom_parser<BasicJsonType>> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html">nlohmann::detail::binary_reader</a>< BasicJsonType, InputAdapterType, SAX >::<a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html">binary_reader</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">InputAdapterType && </td>
|
|
<td class="paramname"><em>adapter</em></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 a binary reader </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">adapter</td><td>input adapter to read from </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="ab4afd9ee276bbb15a0f898061aad94dd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab4afd9ee276bbb15a0f898061aad94dd">◆ </a></span>sax_parse()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType , typename InputAdapterType , typename SAX = json_sax_dom_parser<BasicJsonType>> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html">nlohmann::detail::binary_reader</a>< BasicJsonType, InputAdapterType, SAX >::sax_parse </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="namespacenlohmann_1_1detail.html#aa554fc6a11519e4f347deb25a9f0db40">input_format_t</a> </td>
|
|
<td class="paramname"><em>format</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">json_sax_t * </td>
|
|
<td class="paramname"><em>sax_</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const bool </td>
|
|
<td class="paramname"><em>strict</em> = <code>true</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="namespacenlohmann_1_1detail.html#a58bb1ef1a9ad287a9cfaf1855784d9ac">cbor_tag_handler_t</a> </td>
|
|
<td class="paramname"><em>tag_handler</em> = <code><a class="el" href="namespacenlohmann_1_1detail.html#a58bb1ef1a9ad287a9cfaf1855784d9acacb5e100e5a9a3e7f6d1fd97512215282">cbor_tag_handler_t::error</a></code> </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> </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">format</td><td>the binary format to parse </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">sax_</td><td>a SAX event processor </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">strict</td><td>whether to expect the input to be consumed completed </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">tag_handler</td><td>how to treat CBOR tags</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abf2051ba57d9ea9b378a2e7c14e22b34"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abf2051ba57d9ea9b378a2e7c14e22b34">◆ </a></span>parse_bson_internal()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType , typename InputAdapterType , typename SAX = json_sax_dom_parser<BasicJsonType>> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html">nlohmann::detail::binary_reader</a>< BasicJsonType, InputAdapterType, SAX >::parse_bson_internal </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 class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reads in a BSON-object and passes it to the SAX-parser. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>whether a valid BSON-value was passed to the SAX parser </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a354cbbaaea672c024ac949e1801c4302"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a354cbbaaea672c024ac949e1801c4302">◆ </a></span>get_bson_cstr()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType , typename InputAdapterType , typename SAX = json_sax_dom_parser<BasicJsonType>> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html">nlohmann::detail::binary_reader</a>< BasicJsonType, InputAdapterType, SAX >::get_bson_cstr </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string_t & </td>
|
|
<td class="paramname"><em>result</em></td><td>)</td>
|
|
<td></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>Parses a C-style string from the BSON input. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in,out]</td><td class="paramname">result</td><td>A reference to the string variable where the read string is to be stored. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the \x00-byte indicating the end of the string was encountered before the EOF; false` indicates an unexpected EOF. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a23921422802aa472360dd05023e20565"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a23921422802aa472360dd05023e20565">◆ </a></span>get_bson_string()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType , typename InputAdapterType , typename SAX = json_sax_dom_parser<BasicJsonType>> </div>
|
|
<div class="memtemplate">
|
|
template<typename NumberType > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html">nlohmann::detail::binary_reader</a>< BasicJsonType, InputAdapterType, SAX >::get_bson_string </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const NumberType </td>
|
|
<td class="paramname"><em>len</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string_t & </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">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Parses a zero-terminated string of length <em>len</em> from the BSON input. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>The length (including the zero-byte at the end) of the string to be read. </td></tr>
|
|
<tr><td class="paramdir">[in,out]</td><td class="paramname">result</td><td>A reference to the string variable where the read string is to be stored. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">NumberType</td><td>The type of the length <em>len</em> </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section pre"><dt>Precondition</dt><dd>len >= 1 </dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the string was successfully parsed </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9940f56290b9278c58772eda2931e599"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9940f56290b9278c58772eda2931e599">◆ </a></span>get_bson_binary()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType , typename InputAdapterType , typename SAX = json_sax_dom_parser<BasicJsonType>> </div>
|
|
<div class="memtemplate">
|
|
template<typename NumberType > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html">nlohmann::detail::binary_reader</a>< BasicJsonType, InputAdapterType, SAX >::get_bson_binary </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const NumberType </td>
|
|
<td class="paramname"><em>len</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">binary_t & </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">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Parses a byte array input of length <em>len</em> from the BSON input. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>The length of the byte array to be read. </td></tr>
|
|
<tr><td class="paramdir">[in,out]</td><td class="paramname">result</td><td>A reference to the binary variable where the read array is to be stored. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">NumberType</td><td>The type of the length <em>len</em> </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section pre"><dt>Precondition</dt><dd>len >= 0 </dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the byte array was successfully parsed </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a23bde2450d7a5772bf5051e36ff560a4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a23bde2450d7a5772bf5051e36ff560a4">◆ </a></span>parse_bson_element_internal()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType , typename InputAdapterType , typename SAX = json_sax_dom_parser<BasicJsonType>> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html">nlohmann::detail::binary_reader</a>< BasicJsonType, InputAdapterType, SAX >::parse_bson_element_internal </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char_int_type </td>
|
|
<td class="paramname"><em>element_type</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::size_t </td>
|
|
<td class="paramname"><em>element_type_parse_position</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">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Read a BSON document element of the given <em>element_type</em>. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">element_type</td><td>The BSON element type, c.f. <a href="http://bsonspec.org/spec.html">http://bsonspec.org/spec.html</a> </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">element_type_parse_position</td><td>The position in the input stream, where the <code>element_type</code> was read. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section warning"><dt>Warning</dt><dd>Not all BSON element types are supported yet. An unsupported <em>element_type</em> will give rise to a parse_error.114: Unsupported BSON record type 0x... </dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>whether a valid BSON-object/array was passed to the SAX parser </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4e07b75ccb2579d0e738b894f0fd8cf8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4e07b75ccb2579d0e738b894f0fd8cf8">◆ </a></span>parse_bson_element_list()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType , typename InputAdapterType , typename SAX = json_sax_dom_parser<BasicJsonType>> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html">nlohmann::detail::binary_reader</a>< BasicJsonType, InputAdapterType, SAX >::parse_bson_element_list </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const bool </td>
|
|
<td class="paramname"><em>is_array</em></td><td>)</td>
|
|
<td></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>Read a BSON element list (as specified in the BSON-spec) </p>
|
|
<p>The same binary layout is used for objects and arrays, hence it must be indicated with the argument <em>is_array</em> which one is expected (true --> array, false --> object).</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">is_array</td><td>Determines if the element list being read is to be treated as an object (<em>is_array</em> == false), or as an array (<em>is_array</em> == true). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>whether a valid BSON-object/array was passed to the SAX parser </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a23eb89a222e22533e9fd43e76722f44f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a23eb89a222e22533e9fd43e76722f44f">◆ </a></span>parse_bson_array()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType , typename InputAdapterType , typename SAX = json_sax_dom_parser<BasicJsonType>> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html">nlohmann::detail::binary_reader</a>< BasicJsonType, InputAdapterType, SAX >::parse_bson_array </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 class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reads an array from the BSON input and passes it to the SAX-parser. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>whether a valid BSON-array was passed to the SAX parser </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4e4accd5a2a41bfb2f18a8a0fcc9421c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4e4accd5a2a41bfb2f18a8a0fcc9421c">◆ </a></span>parse_cbor_internal()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType , typename InputAdapterType , typename SAX = json_sax_dom_parser<BasicJsonType>> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html">nlohmann::detail::binary_reader</a>< BasicJsonType, InputAdapterType, SAX >::parse_cbor_internal </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const bool </td>
|
|
<td class="paramname"><em>get_char</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="namespacenlohmann_1_1detail.html#a58bb1ef1a9ad287a9cfaf1855784d9ac">cbor_tag_handler_t</a> </td>
|
|
<td class="paramname"><em>tag_handler</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">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">get_char</td><td>whether a new character should be retrieved from the input (true) or whether the last read character should be considered instead (false) </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">tag_handler</td><td>how CBOR tags should be treated</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>whether a valid CBOR value was passed to the SAX parser </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a545a44ae4b3fa2b7a61d9e8517fb7154"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a545a44ae4b3fa2b7a61d9e8517fb7154">◆ </a></span>get_cbor_string()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType , typename InputAdapterType , typename SAX = json_sax_dom_parser<BasicJsonType>> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html">nlohmann::detail::binary_reader</a>< BasicJsonType, InputAdapterType, SAX >::get_cbor_string </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string_t & </td>
|
|
<td class="paramname"><em>result</em></td><td>)</td>
|
|
<td></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>reads a CBOR string </p>
|
|
<p>This function first reads starting bytes to determine the expected string length and then copies this number of bytes into a string. Additionally, CBOR's strings with indefinite lengths are supported.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">result</td><td>created string</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>whether string creation completed </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acb001d18095dc5bcf7336ae5122b8340"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acb001d18095dc5bcf7336ae5122b8340">◆ </a></span>get_cbor_binary()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType , typename InputAdapterType , typename SAX = json_sax_dom_parser<BasicJsonType>> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html">nlohmann::detail::binary_reader</a>< BasicJsonType, InputAdapterType, SAX >::get_cbor_binary </td>
|
|
<td>(</td>
|
|
<td class="paramtype">binary_t & </td>
|
|
<td class="paramname"><em>result</em></td><td>)</td>
|
|
<td></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>reads a CBOR byte array </p>
|
|
<p>This function first reads starting bytes to determine the expected byte array length and then copies this number of bytes into the byte array. Additionally, CBOR's byte arrays with indefinite lengths are supported.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">result</td><td>created byte array</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>whether byte array creation completed </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3750658328bf3ec3cf23f1626f9ec3af"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3750658328bf3ec3cf23f1626f9ec3af">◆ </a></span>get_cbor_array()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType , typename InputAdapterType , typename SAX = json_sax_dom_parser<BasicJsonType>> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html">nlohmann::detail::binary_reader</a>< BasicJsonType, InputAdapterType, SAX >::get_cbor_array </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::size_t </td>
|
|
<td class="paramname"><em>len</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="namespacenlohmann_1_1detail.html#a58bb1ef1a9ad287a9cfaf1855784d9ac">cbor_tag_handler_t</a> </td>
|
|
<td class="paramname"><em>tag_handler</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">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">len</td><td>the length of the array or std::size_t(-1) for an array of indefinite size </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">tag_handler</td><td>how CBOR tags should be treated </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>whether array creation completed </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a47092a2195bf9cd3cdb4dda67cc404ed"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a47092a2195bf9cd3cdb4dda67cc404ed">◆ </a></span>get_cbor_object()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType , typename InputAdapterType , typename SAX = json_sax_dom_parser<BasicJsonType>> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html">nlohmann::detail::binary_reader</a>< BasicJsonType, InputAdapterType, SAX >::get_cbor_object </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::size_t </td>
|
|
<td class="paramname"><em>len</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="namespacenlohmann_1_1detail.html#a58bb1ef1a9ad287a9cfaf1855784d9ac">cbor_tag_handler_t</a> </td>
|
|
<td class="paramname"><em>tag_handler</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">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">len</td><td>the length of the object or std::size_t(-1) for an object of indefinite size </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">tag_handler</td><td>how CBOR tags should be treated </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>whether object creation completed </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae020385ce9424271d61f85d3842c02cb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae020385ce9424271d61f85d3842c02cb">◆ </a></span>parse_msgpack_internal()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType , typename InputAdapterType , typename SAX = json_sax_dom_parser<BasicJsonType>> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html">nlohmann::detail::binary_reader</a>< BasicJsonType, InputAdapterType, SAX >::parse_msgpack_internal </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 class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section return"><dt>Returns</dt><dd>whether a valid MessagePack value was passed to the SAX parser </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad8cba5585327caa550dd5b6dd25a64f8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad8cba5585327caa550dd5b6dd25a64f8">◆ </a></span>get_msgpack_string()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType , typename InputAdapterType , typename SAX = json_sax_dom_parser<BasicJsonType>> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html">nlohmann::detail::binary_reader</a>< BasicJsonType, InputAdapterType, SAX >::get_msgpack_string </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string_t & </td>
|
|
<td class="paramname"><em>result</em></td><td>)</td>
|
|
<td></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>reads a MessagePack string </p>
|
|
<p>This function first reads starting bytes to determine the expected string length and then copies this number of bytes into a string.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">result</td><td>created string</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>whether string creation completed </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a389e550fd397a48121cb82d92bb7475a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a389e550fd397a48121cb82d92bb7475a">◆ </a></span>get_msgpack_binary()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType , typename InputAdapterType , typename SAX = json_sax_dom_parser<BasicJsonType>> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html">nlohmann::detail::binary_reader</a>< BasicJsonType, InputAdapterType, SAX >::get_msgpack_binary </td>
|
|
<td>(</td>
|
|
<td class="paramtype">binary_t & </td>
|
|
<td class="paramname"><em>result</em></td><td>)</td>
|
|
<td></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>reads a MessagePack byte array </p>
|
|
<p>This function first reads starting bytes to determine the expected byte array length and then copies this number of bytes into a byte array.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">result</td><td>created byte array</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>whether byte array creation completed </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0ce1d7066597952efb008aaf578b2bd6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0ce1d7066597952efb008aaf578b2bd6">◆ </a></span>get_msgpack_array()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType , typename InputAdapterType , typename SAX = json_sax_dom_parser<BasicJsonType>> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html">nlohmann::detail::binary_reader</a>< BasicJsonType, InputAdapterType, SAX >::get_msgpack_array </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::size_t </td>
|
|
<td class="paramname"><em>len</em></td><td>)</td>
|
|
<td></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="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>the length of the array </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>whether array creation completed </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8bebd21ceef09b6b2562e87861832700"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8bebd21ceef09b6b2562e87861832700">◆ </a></span>get_msgpack_object()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType , typename InputAdapterType , typename SAX = json_sax_dom_parser<BasicJsonType>> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html">nlohmann::detail::binary_reader</a>< BasicJsonType, InputAdapterType, SAX >::get_msgpack_object </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::size_t </td>
|
|
<td class="paramname"><em>len</em></td><td>)</td>
|
|
<td></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="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>the length of the object </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>whether object creation completed </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5a79480d661019b0f3fc615ae12f7de7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5a79480d661019b0f3fc615ae12f7de7">◆ </a></span>parse_ubjson_internal()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType , typename InputAdapterType , typename SAX = json_sax_dom_parser<BasicJsonType>> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html">nlohmann::detail::binary_reader</a>< BasicJsonType, InputAdapterType, SAX >::parse_ubjson_internal </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const bool </td>
|
|
<td class="paramname"><em>get_char</em> = <code>true</code></td><td>)</td>
|
|
<td></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="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">get_char</td><td>whether a new character should be retrieved from the input (true, default) or whether the last read character should be considered instead</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>whether a valid UBJSON value was passed to the SAX parser </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4ae90db51c102e912b7eac83c78733a6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4ae90db51c102e912b7eac83c78733a6">◆ </a></span>get_ubjson_string()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType , typename InputAdapterType , typename SAX = json_sax_dom_parser<BasicJsonType>> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html">nlohmann::detail::binary_reader</a>< BasicJsonType, InputAdapterType, SAX >::get_ubjson_string </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string_t & </td>
|
|
<td class="paramname"><em>result</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const bool </td>
|
|
<td class="paramname"><em>get_char</em> = <code>true</code> </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">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>reads a UBJSON string </p>
|
|
<p>This function is either called after reading the 'S' byte explicitly indicating a string, or in case of an object key where the 'S' byte can be left out.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">result</td><td>created string </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">get_char</td><td>whether a new character should be retrieved from the input (true, default) or whether the last read character should be considered instead</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>whether string creation completed </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aba7ba9ec9a52ad2bee8baff70176aa20"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aba7ba9ec9a52ad2bee8baff70176aa20">◆ </a></span>get_ubjson_size_value()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType , typename InputAdapterType , typename SAX = json_sax_dom_parser<BasicJsonType>> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html">nlohmann::detail::binary_reader</a>< BasicJsonType, InputAdapterType, SAX >::get_ubjson_size_value </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::size_t & </td>
|
|
<td class="paramname"><em>result</em></td><td>)</td>
|
|
<td></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="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">result</td><td>determined size </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>whether size determination completed </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7b6c2d4c95d56751e233e285a5f1fea7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7b6c2d4c95d56751e233e285a5f1fea7">◆ </a></span>get_ubjson_size_type()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType , typename InputAdapterType , typename SAX = json_sax_dom_parser<BasicJsonType>> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html">nlohmann::detail::binary_reader</a>< BasicJsonType, InputAdapterType, SAX >::get_ubjson_size_type </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::pair< std::size_t, char_int_type > & </td>
|
|
<td class="paramname"><em>result</em></td><td>)</td>
|
|
<td></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>determine the type and size for a container </p>
|
|
<p>In the optimized UBJSON format, a type and a size can be provided to allow for a more compact representation.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">result</td><td>pair of the size and the type</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>whether pair creation completed </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7e5e0b71548d0649ce4f131280d06c33"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7e5e0b71548d0649ce4f131280d06c33">◆ </a></span>get_ubjson_value()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType , typename InputAdapterType , typename SAX = json_sax_dom_parser<BasicJsonType>> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html">nlohmann::detail::binary_reader</a>< BasicJsonType, InputAdapterType, SAX >::get_ubjson_value </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char_int_type </td>
|
|
<td class="paramname"><em>prefix</em></td><td>)</td>
|
|
<td></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="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">prefix</td><td>the previously read or set type prefix </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>whether value creation completed </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afb36cb588b795efa513fc95e949493b7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afb36cb588b795efa513fc95e949493b7">◆ </a></span>get_ubjson_array()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType , typename InputAdapterType , typename SAX = json_sax_dom_parser<BasicJsonType>> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html">nlohmann::detail::binary_reader</a>< BasicJsonType, InputAdapterType, SAX >::get_ubjson_array </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 class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section return"><dt>Returns</dt><dd>whether array creation completed </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adcf64ad3207f4bf37a5a31c920a385c3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adcf64ad3207f4bf37a5a31c920a385c3">◆ </a></span>get_ubjson_object()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType , typename InputAdapterType , typename SAX = json_sax_dom_parser<BasicJsonType>> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html">nlohmann::detail::binary_reader</a>< BasicJsonType, InputAdapterType, SAX >::get_ubjson_object </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 class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section return"><dt>Returns</dt><dd>whether object creation completed </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad222095c0b21a87824cb10629299629a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad222095c0b21a87824cb10629299629a">◆ </a></span>get()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType , typename InputAdapterType , typename SAX = json_sax_dom_parser<BasicJsonType>> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">char_int_type <a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html">nlohmann::detail::binary_reader</a>< BasicJsonType, InputAdapterType, SAX >::get </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 class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>get next character from the input </p>
|
|
<p>This function provides the interface to the used input adapter. It does not throw in case the input reached EOF, but returns a -'ve valued <code>std::char_traits<char_type>::eof()</code> in that case.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>character read from the input </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a252c1179651d22c5343bcf0b538ed26a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a252c1179651d22c5343bcf0b538ed26a">◆ </a></span>get_ignore_noop()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType , typename InputAdapterType , typename SAX = json_sax_dom_parser<BasicJsonType>> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">char_int_type <a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html">nlohmann::detail::binary_reader</a>< BasicJsonType, InputAdapterType, SAX >::get_ignore_noop </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 class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section return"><dt>Returns</dt><dd>character read from the input after ignoring all 'N' entries </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a540919db22df36512f05a88945c13263"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a540919db22df36512f05a88945c13263">◆ </a></span>get_string()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType , typename InputAdapterType , typename SAX = json_sax_dom_parser<BasicJsonType>> </div>
|
|
<div class="memtemplate">
|
|
template<typename NumberType > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html">nlohmann::detail::binary_reader</a>< BasicJsonType, InputAdapterType, SAX >::get_string </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="namespacenlohmann_1_1detail.html#aa554fc6a11519e4f347deb25a9f0db40">input_format_t</a> </td>
|
|
<td class="paramname"><em>format</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const NumberType </td>
|
|
<td class="paramname"><em>len</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string_t & </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">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>create a string by reading characters from the input </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">NumberType</td><td>the type of the number </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">format</td><td>the current format (for diagnostics) </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>number of characters to read </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">result</td><td>string created by reading <em>len</em> bytes</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>whether string creation completed</dd></dl>
|
|
<dl class="section note"><dt>Note</dt><dd>We can not reserve <em>len</em> bytes for the result, because <em>len</em> may be too large. Usually, <a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html#a61a0bd8bbe7b560bd429fa990ba3ba1a">unexpect_eof()</a> detects the end of the input before we run out of string memory. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a55e13d567a53234573ab3833c0ca32e9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a55e13d567a53234573ab3833c0ca32e9">◆ </a></span>get_binary()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType , typename InputAdapterType , typename SAX = json_sax_dom_parser<BasicJsonType>> </div>
|
|
<div class="memtemplate">
|
|
template<typename NumberType > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html">nlohmann::detail::binary_reader</a>< BasicJsonType, InputAdapterType, SAX >::get_binary </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="namespacenlohmann_1_1detail.html#aa554fc6a11519e4f347deb25a9f0db40">input_format_t</a> </td>
|
|
<td class="paramname"><em>format</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const NumberType </td>
|
|
<td class="paramname"><em>len</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">binary_t & </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">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>create a byte array by reading bytes from the input </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">NumberType</td><td>the type of the number </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">format</td><td>the current format (for diagnostics) </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>number of bytes to read </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">result</td><td>byte array created by reading <em>len</em> bytes</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>whether byte array creation completed</dd></dl>
|
|
<dl class="section note"><dt>Note</dt><dd>We can not reserve <em>len</em> bytes for the result, because <em>len</em> may be too large. Usually, <a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html#a61a0bd8bbe7b560bd429fa990ba3ba1a">unexpect_eof()</a> detects the end of the input before we run out of memory. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a61a0bd8bbe7b560bd429fa990ba3ba1a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a61a0bd8bbe7b560bd429fa990ba3ba1a">◆ </a></span>unexpect_eof()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType , typename InputAdapterType , typename SAX = json_sax_dom_parser<BasicJsonType>> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html">nlohmann::detail::binary_reader</a>< BasicJsonType, InputAdapterType, SAX >::unexpect_eof </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="namespacenlohmann_1_1detail.html#aa554fc6a11519e4f347deb25a9f0db40">input_format_t</a> </td>
|
|
<td class="paramname"><em>format</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>context</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</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="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">format</td><td>the current format (for diagnostics) </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">context</td><td>further context information (for diagnostics) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>whether the last read character is not EOF </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7d323283c60a0b89ee5eeadf5cb9a5ad"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7d323283c60a0b89ee5eeadf5cb9a5ad">◆ </a></span>get_token_string()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType , typename InputAdapterType , typename SAX = json_sax_dom_parser<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_1detail_1_1binary__reader.html">nlohmann::detail::binary_reader</a>< BasicJsonType, InputAdapterType, SAX >::get_token_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 class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section return"><dt>Returns</dt><dd>a string representation of the last read byte </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9c413c9a1bade1ce345740f4d69156f0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9c413c9a1bade1ce345740f4d69156f0">◆ </a></span>exception_message()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BasicJsonType , typename InputAdapterType , typename SAX = json_sax_dom_parser<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_1detail_1_1binary__reader.html">nlohmann::detail::binary_reader</a>< BasicJsonType, InputAdapterType, SAX >::exception_message </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="namespacenlohmann_1_1detail.html#aa554fc6a11519e4f347deb25a9f0db40">input_format_t</a> </td>
|
|
<td class="paramname"><em>format</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>detail</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>context</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</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="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">format</td><td>the current format </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">detail</td><td>a detailed error message </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">context</td><td>further context information </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>a message string to use in the <a class="el" href="classnlohmann_1_1detail_1_1parse__error.html" title="exception indicating a parse error">parse_error</a> exceptions </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- 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="namespacenlohmann_1_1detail.html">detail</a></li><li class="navelem"><a class="el" href="classnlohmann_1_1detail_1_1binary__reader.html">binary_reader</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>
|