mkdocs/docs/api/puffin_2json__serde__internal_8h.html - iceberg-cpp - Git at Google

 <!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" lang="en-US">
 <head>
 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
 <meta name="generator" content="Doxygen 1.9.8"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
 <title>iceberg-cpp: iceberg/puffin/json_serde_internal.h File 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="search/search.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="search/searchdata.js"></script>
 <script type="text/javascript" src="search/search.js"></script>
 <link href="doxygen.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 id="projectrow">
   <td id="projectalign">
    <div id="projectname">iceberg-cpp
    </div>
   </td>
  </tr>
  </tbody>
 </table>
 </div>
 <!-- end header part -->
 <!-- Generated by Doxygen 1.9.8 -->
 <script type="text/javascript">
 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 var searchBox = new SearchBox("searchBox", "search/",'.html');
 /* @license-end */
 </script>
 <script type="text/javascript" src="menudata.js"></script>
 <script type="text/javascript" src="menu.js"></script>
 <script type="text/javascript">
 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 $(function() {
   initMenu('',true,false,'search.php','Search');
   $(document).ready(function() { init_search(); });
 });
 /* @license-end */
 </script>
 <div id="main-nav"></div>
 <!-- window showing the filter options -->
 <div id="MSearchSelectWindow"
      onmouseover="return searchBox.OnSearchSelectShow()"
      onmouseout="return searchBox.OnSearchSelectHide()"
      onkeydown="return searchBox.OnSearchSelectKey(event)">
 </div>

 <!-- iframe showing the search results (closed by default) -->
 <div id="MSearchResultsWindow">
 <div id="MSearchResults">
 <div class="SRPage">
 <div id="SRIndex">
 <div id="SRResults"></div>
 <div class="SRStatus" id="Loading">Loading...</div>
 <div class="SRStatus" id="Searching">Searching...</div>
 <div class="SRStatus" id="NoMatches">No Matches</div>
 </div>
 </div>
 </div>
 </div>

 <div id="nav-path" class="navpath">
   <ul>
 <li class="navelem"><a class="el" href="dir_f51fe74ea6bc2b1b900619895eaa63be.html">iceberg</a></li><li class="navelem"><a class="el" href="dir_5f8b885c726a45ce475267a26efacb77.html">puffin</a></li>  </ul>
 </div>
 </div><!-- top -->
 <div class="header">
   <div class="summary">
 <a href="#func-members">Functions</a>  </div>
   <div class="headertitle"><div class="title">json_serde_internal.h File Reference</div></div>
 </div><!--header-->
 <div class="contents">
 <div class="textblock"><code>#include &lt;string&gt;</code><br />
 <code>#include &lt;string_view&gt;</code><br />
 <code>#include &lt;nlohmann/json_fwd.hpp&gt;</code><br />
 <code>#include &quot;iceberg/iceberg_data_export.h&quot;</code><br />
 <code>#include &quot;<a class="el" href="puffin_2type__fwd_8h_source.html">iceberg/puffin/type_fwd.h</a>&quot;</code><br />
 <code>#include &quot;iceberg/result.h&quot;</code><br />
 </div>
 <p><a href="puffin_2json__serde__internal_8h_source.html">Go to the source code of this file.</a></p>
 <table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 Functions</h2></td></tr>
 <tr class="memitem:a303f3aa8966ed7614b28d78dcd012aff" id="r_a303f3aa8966ed7614b28d78dcd012aff"><td class="memItemLeft" align="right" valign="top"><a id="a303f3aa8966ed7614b28d78dcd012aff" name="a303f3aa8966ed7614b28d78dcd012aff"></a>
 nlohmann::json&#160;</td><td class="memItemRight" valign="bottom"><b>iceberg::puffin::ToJson</b> (const <a class="el" href="structiceberg_1_1puffin_1_1BlobMetadata.html">BlobMetadata</a> &amp;blob_metadata)</td></tr>
 <tr class="memdesc:a303f3aa8966ed7614b28d78dcd012aff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serialize a <a class="el" href="structiceberg_1_1puffin_1_1BlobMetadata.html" title="Metadata about a blob stored in a Puffin file footer.">BlobMetadata</a> to JSON. <br /></td></tr>
 <tr class="separator:a303f3aa8966ed7614b28d78dcd012aff"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:aea4c53be0331ad885916047e712aa4c2" id="r_aea4c53be0331ad885916047e712aa4c2"><td class="memItemLeft" align="right" valign="top"><a id="aea4c53be0331ad885916047e712aa4c2" name="aea4c53be0331ad885916047e712aa4c2"></a>
 Result&lt; <a class="el" href="structiceberg_1_1puffin_1_1BlobMetadata.html">BlobMetadata</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>iceberg::puffin::BlobMetadataFromJson</b> (const nlohmann::json &amp;json)</td></tr>
 <tr class="memdesc:aea4c53be0331ad885916047e712aa4c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deserialize a <a class="el" href="structiceberg_1_1puffin_1_1BlobMetadata.html" title="Metadata about a blob stored in a Puffin file footer.">BlobMetadata</a> from JSON. <br /></td></tr>
 <tr class="separator:aea4c53be0331ad885916047e712aa4c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ab8789cb0dd4b68833bc23b4312fbb4c2" id="r_ab8789cb0dd4b68833bc23b4312fbb4c2"><td class="memItemLeft" align="right" valign="top"><a id="ab8789cb0dd4b68833bc23b4312fbb4c2" name="ab8789cb0dd4b68833bc23b4312fbb4c2"></a>
 nlohmann::json&#160;</td><td class="memItemRight" valign="bottom"><b>iceberg::puffin::ToJson</b> (const <a class="el" href="structiceberg_1_1puffin_1_1FileMetadata.html">FileMetadata</a> &amp;file_metadata)</td></tr>
 <tr class="memdesc:ab8789cb0dd4b68833bc23b4312fbb4c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serialize a <a class="el" href="structiceberg_1_1puffin_1_1FileMetadata.html" title="Metadata about a Puffin file.">FileMetadata</a> to JSON. <br /></td></tr>
 <tr class="separator:ab8789cb0dd4b68833bc23b4312fbb4c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a85d5f6e43826808afd29b7f634a04853" id="r_a85d5f6e43826808afd29b7f634a04853"><td class="memItemLeft" align="right" valign="top"><a id="a85d5f6e43826808afd29b7f634a04853" name="a85d5f6e43826808afd29b7f634a04853"></a>
 Result&lt; <a class="el" href="structiceberg_1_1puffin_1_1FileMetadata.html">FileMetadata</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>iceberg::puffin::FileMetadataFromJson</b> (const nlohmann::json &amp;json)</td></tr>
 <tr class="memdesc:a85d5f6e43826808afd29b7f634a04853"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deserialize a <a class="el" href="structiceberg_1_1puffin_1_1FileMetadata.html" title="Metadata about a Puffin file.">FileMetadata</a> from JSON. <br /></td></tr>
 <tr class="separator:a85d5f6e43826808afd29b7f634a04853"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:acca7cdf9178ffa5067b3cf07edd592c3" id="r_acca7cdf9178ffa5067b3cf07edd592c3"><td class="memItemLeft" align="right" valign="top"><a id="acca7cdf9178ffa5067b3cf07edd592c3" name="acca7cdf9178ffa5067b3cf07edd592c3"></a>
 std::string&#160;</td><td class="memItemRight" valign="bottom"><b>iceberg::puffin::ToJsonString</b> (const <a class="el" href="structiceberg_1_1puffin_1_1FileMetadata.html">FileMetadata</a> &amp;file_metadata, bool pretty=false)</td></tr>
 <tr class="memdesc:acca7cdf9178ffa5067b3cf07edd592c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serialize a <a class="el" href="structiceberg_1_1puffin_1_1FileMetadata.html" title="Metadata about a Puffin file.">FileMetadata</a> to a JSON string. <br /></td></tr>
 <tr class="separator:acca7cdf9178ffa5067b3cf07edd592c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:aa2e50733bde1e688057e7fee9bd78896" id="r_aa2e50733bde1e688057e7fee9bd78896"><td class="memItemLeft" align="right" valign="top"><a id="aa2e50733bde1e688057e7fee9bd78896" name="aa2e50733bde1e688057e7fee9bd78896"></a>
 Result&lt; <a class="el" href="structiceberg_1_1puffin_1_1FileMetadata.html">FileMetadata</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>iceberg::puffin::FileMetadataFromJsonString</b> (std::string_view json_string)</td></tr>
 <tr class="memdesc:aa2e50733bde1e688057e7fee9bd78896"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deserialize a <a class="el" href="structiceberg_1_1puffin_1_1FileMetadata.html" title="Metadata about a Puffin file.">FileMetadata</a> from a JSON string. <br /></td></tr>
 <tr class="separator:aa2e50733bde1e688057e7fee9bd78896"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 <div class="textblock"><p>JSON serialization/deserialization for Puffin file metadata. </p>
 </div></div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
 Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
 </small></address>
 </body>
 </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" lang="en-US">
	<head>
	<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
	<meta http-equiv="X-UA-Compatible" content="IE=11"/>
	<meta name="generator" content="Doxygen 1.9.8"/>
	<meta name="viewport" content="width=device-width, initial-scale=1"/>
	<title>iceberg-cpp: iceberg/puffin/json_serde_internal.h File 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="search/search.css" rel="stylesheet" type="text/css"/>
	<script type="text/javascript" src="search/searchdata.js"></script>
	<script type="text/javascript" src="search/search.js"></script>
	<link href="doxygen.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 id="projectrow">
	<td id="projectalign">
	<div id="projectname">iceberg-cpp
	</div>
	</td>
	</tr>
	</tbody>
	</table>
	</div>
	<!-- end header part -->
	<!-- Generated by Doxygen 1.9.8 -->
	<script type="text/javascript">
	/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
	var searchBox = new SearchBox("searchBox", "search/",'.html');
	/* @license-end */
	</script>
	<script type="text/javascript" src="menudata.js"></script>
	<script type="text/javascript" src="menu.js"></script>
	<script type="text/javascript">
	/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
	$(function() {
	initMenu('',true,false,'search.php','Search');
	$(document).ready(function() { init_search(); });
	});
	/* @license-end */
	</script>
	<div id="main-nav"></div>
	<!-- window showing the filter options -->
	<div id="MSearchSelectWindow"
	onmouseover="return searchBox.OnSearchSelectShow()"
	onmouseout="return searchBox.OnSearchSelectHide()"
	onkeydown="return searchBox.OnSearchSelectKey(event)">
	</div>

	<!-- iframe showing the search results (closed by default) -->
	<div id="MSearchResultsWindow">
	<div id="MSearchResults">
	<div class="SRPage">
	<div id="SRIndex">
	<div id="SRResults"></div>
	<div class="SRStatus" id="Loading">Loading...</div>
	<div class="SRStatus" id="Searching">Searching...</div>
	<div class="SRStatus" id="NoMatches">No Matches</div>
	</div>
	</div>
	</div>
	</div>

	<div id="nav-path" class="navpath">
	<ul>
	<li class="navelem"><a class="el" href="dir_f51fe74ea6bc2b1b900619895eaa63be.html">iceberg</a></li><li class="navelem"><a class="el" href="dir_5f8b885c726a45ce475267a26efacb77.html">puffin</a></li> </ul>
	</div>
	</div><!-- top -->
	<div class="header">
	<div class="summary">
	<a href="#func-members">Functions</a> </div>
	<div class="headertitle"><div class="title">json_serde_internal.h File Reference</div></div>
	</div><!--header-->
	<div class="contents">
	<div class="textblock"><code>#include <string></code><br />
	<code>#include <string_view></code><br />
	<code>#include <nlohmann/json_fwd.hpp></code><br />
	<code>#include "iceberg/iceberg_data_export.h"</code><br />
	<code>#include "<a class="el" href="puffin_2type__fwd_8h_source.html">iceberg/puffin/type_fwd.h</a>"</code><br />
	<code>#include "iceberg/result.h"</code><br />
	</div>
	<p><a href="puffin_2json__serde__internal_8h_source.html">Go to the source code of this file.</a></p>
	<table class="memberdecls">
	<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
	Functions</h2></td></tr>
	<tr class="memitem:a303f3aa8966ed7614b28d78dcd012aff" id="r_a303f3aa8966ed7614b28d78dcd012aff"><td class="memItemLeft" align="right" valign="top"><a id="a303f3aa8966ed7614b28d78dcd012aff" name="a303f3aa8966ed7614b28d78dcd012aff"></a>
	nlohmann::json </td><td class="memItemRight" valign="bottom"><b>iceberg::puffin::ToJson</b> (const <a class="el" href="structiceberg_1_1puffin_1_1BlobMetadata.html">BlobMetadata</a> &blob_metadata)</td></tr>
	<tr class="memdesc:a303f3aa8966ed7614b28d78dcd012aff"><td class="mdescLeft"> </td><td class="mdescRight">Serialize a <a class="el" href="structiceberg_1_1puffin_1_1BlobMetadata.html" title="Metadata about a blob stored in a Puffin file footer.">BlobMetadata</a> to JSON. <br /></td></tr>
	<tr class="separator:a303f3aa8966ed7614b28d78dcd012aff"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:aea4c53be0331ad885916047e712aa4c2" id="r_aea4c53be0331ad885916047e712aa4c2"><td class="memItemLeft" align="right" valign="top"><a id="aea4c53be0331ad885916047e712aa4c2" name="aea4c53be0331ad885916047e712aa4c2"></a>
	Result< <a class="el" href="structiceberg_1_1puffin_1_1BlobMetadata.html">BlobMetadata</a> > </td><td class="memItemRight" valign="bottom"><b>iceberg::puffin::BlobMetadataFromJson</b> (const nlohmann::json &json)</td></tr>
	<tr class="memdesc:aea4c53be0331ad885916047e712aa4c2"><td class="mdescLeft"> </td><td class="mdescRight">Deserialize a <a class="el" href="structiceberg_1_1puffin_1_1BlobMetadata.html" title="Metadata about a blob stored in a Puffin file footer.">BlobMetadata</a> from JSON. <br /></td></tr>
	<tr class="separator:aea4c53be0331ad885916047e712aa4c2"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:ab8789cb0dd4b68833bc23b4312fbb4c2" id="r_ab8789cb0dd4b68833bc23b4312fbb4c2"><td class="memItemLeft" align="right" valign="top"><a id="ab8789cb0dd4b68833bc23b4312fbb4c2" name="ab8789cb0dd4b68833bc23b4312fbb4c2"></a>
	nlohmann::json </td><td class="memItemRight" valign="bottom"><b>iceberg::puffin::ToJson</b> (const <a class="el" href="structiceberg_1_1puffin_1_1FileMetadata.html">FileMetadata</a> &file_metadata)</td></tr>
	<tr class="memdesc:ab8789cb0dd4b68833bc23b4312fbb4c2"><td class="mdescLeft"> </td><td class="mdescRight">Serialize a <a class="el" href="structiceberg_1_1puffin_1_1FileMetadata.html" title="Metadata about a Puffin file.">FileMetadata</a> to JSON. <br /></td></tr>
	<tr class="separator:ab8789cb0dd4b68833bc23b4312fbb4c2"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:a85d5f6e43826808afd29b7f634a04853" id="r_a85d5f6e43826808afd29b7f634a04853"><td class="memItemLeft" align="right" valign="top"><a id="a85d5f6e43826808afd29b7f634a04853" name="a85d5f6e43826808afd29b7f634a04853"></a>
	Result< <a class="el" href="structiceberg_1_1puffin_1_1FileMetadata.html">FileMetadata</a> > </td><td class="memItemRight" valign="bottom"><b>iceberg::puffin::FileMetadataFromJson</b> (const nlohmann::json &json)</td></tr>
	<tr class="memdesc:a85d5f6e43826808afd29b7f634a04853"><td class="mdescLeft"> </td><td class="mdescRight">Deserialize a <a class="el" href="structiceberg_1_1puffin_1_1FileMetadata.html" title="Metadata about a Puffin file.">FileMetadata</a> from JSON. <br /></td></tr>
	<tr class="separator:a85d5f6e43826808afd29b7f634a04853"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:acca7cdf9178ffa5067b3cf07edd592c3" id="r_acca7cdf9178ffa5067b3cf07edd592c3"><td class="memItemLeft" align="right" valign="top"><a id="acca7cdf9178ffa5067b3cf07edd592c3" name="acca7cdf9178ffa5067b3cf07edd592c3"></a>
	std::string </td><td class="memItemRight" valign="bottom"><b>iceberg::puffin::ToJsonString</b> (const <a class="el" href="structiceberg_1_1puffin_1_1FileMetadata.html">FileMetadata</a> &file_metadata, bool pretty=false)</td></tr>
	<tr class="memdesc:acca7cdf9178ffa5067b3cf07edd592c3"><td class="mdescLeft"> </td><td class="mdescRight">Serialize a <a class="el" href="structiceberg_1_1puffin_1_1FileMetadata.html" title="Metadata about a Puffin file.">FileMetadata</a> to a JSON string. <br /></td></tr>
	<tr class="separator:acca7cdf9178ffa5067b3cf07edd592c3"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:aa2e50733bde1e688057e7fee9bd78896" id="r_aa2e50733bde1e688057e7fee9bd78896"><td class="memItemLeft" align="right" valign="top"><a id="aa2e50733bde1e688057e7fee9bd78896" name="aa2e50733bde1e688057e7fee9bd78896"></a>
	Result< <a class="el" href="structiceberg_1_1puffin_1_1FileMetadata.html">FileMetadata</a> > </td><td class="memItemRight" valign="bottom"><b>iceberg::puffin::FileMetadataFromJsonString</b> (std::string_view json_string)</td></tr>
	<tr class="memdesc:aa2e50733bde1e688057e7fee9bd78896"><td class="mdescLeft"> </td><td class="mdescRight">Deserialize a <a class="el" href="structiceberg_1_1puffin_1_1FileMetadata.html" title="Metadata about a Puffin file.">FileMetadata</a> from a JSON string. <br /></td></tr>
	<tr class="separator:aa2e50733bde1e688057e7fee9bd78896"><td class="memSeparator" colspan="2"> </td></tr>
	</table>
	<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
	<div class="textblock"><p>JSON serialization/deserialization for Puffin file metadata. </p>
	</div></div><!-- contents -->
	<!-- start footer part -->
	<hr class="footer"/><address class="footer"><small>
	Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
	</small></address>
	</body>
	</html>