| <!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>datasketches-cpp: serde< T, Enable > Struct 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="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">datasketches-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="namespacedatasketches.html">datasketches</a></li><li class="navelem"><a class="el" href="structdatasketches_1_1serde.html">serde</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="structdatasketches_1_1serde-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">serde< T, Enable > Struct Template Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Interface for serializing and deserializing items. |
| <a href="structdatasketches_1_1serde.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="serde_8hpp_source.html">serde.hpp</a>></code></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a6c83e1b2b2ec0c10698a155e60ef2b4c" id="r_a6c83e1b2b2ec0c10698a155e60ef2b4c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structdatasketches_1_1serde.html#a6c83e1b2b2ec0c10698a155e60ef2b4c">serialize</a> (std::ostream &os, const T *items, unsigned num) const</td></tr> |
| <tr class="memdesc:a6c83e1b2b2ec0c10698a155e60ef2b4c"><td class="mdescLeft"> </td><td class="mdescRight">Stream serialization. <br /></td></tr> |
| <tr class="separator:a6c83e1b2b2ec0c10698a155e60ef2b4c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6a54156811a53ef44ac95b507e51c96a" id="r_a6a54156811a53ef44ac95b507e51c96a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structdatasketches_1_1serde.html#a6a54156811a53ef44ac95b507e51c96a">deserialize</a> (std::istream &is, T *items, unsigned num) const</td></tr> |
| <tr class="memdesc:a6a54156811a53ef44ac95b507e51c96a"><td class="mdescLeft"> </td><td class="mdescRight">Stream deserialization. <br /></td></tr> |
| <tr class="separator:a6a54156811a53ef44ac95b507e51c96a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8cf20deb8d752971876e996135c26eaa" id="r_a8cf20deb8d752971876e996135c26eaa"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structdatasketches_1_1serde.html#a8cf20deb8d752971876e996135c26eaa">serialize</a> (void *ptr, size_t capacity, const T *items, unsigned num) const</td></tr> |
| <tr class="memdesc:a8cf20deb8d752971876e996135c26eaa"><td class="mdescLeft"> </td><td class="mdescRight">Raw bytes serialization. <br /></td></tr> |
| <tr class="separator:a8cf20deb8d752971876e996135c26eaa"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a45678998333722fab5dd1e278ac27ef5" id="r_a45678998333722fab5dd1e278ac27ef5"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structdatasketches_1_1serde.html#a45678998333722fab5dd1e278ac27ef5">deserialize</a> (const void *ptr, size_t capacity, T *items, unsigned num) const</td></tr> |
| <tr class="memdesc:a45678998333722fab5dd1e278ac27ef5"><td class="mdescLeft"> </td><td class="mdescRight">Raw bytes deserialization. <br /></td></tr> |
| <tr class="separator:a45678998333722fab5dd1e278ac27ef5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3291383cf9767a56e84b1a0ef5da178e" id="r_a3291383cf9767a56e84b1a0ef5da178e"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structdatasketches_1_1serde.html#a3291383cf9767a56e84b1a0ef5da178e">size_of_item</a> (const T &item) const</td></tr> |
| <tr class="memdesc:a3291383cf9767a56e84b1a0ef5da178e"><td class="mdescLeft"> </td><td class="mdescRight">Size of the given item. <br /></td></tr> |
| <tr class="separator:a3291383cf9767a56e84b1a0ef5da178e"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><div class="compoundTemplParams">template<typename T, typename Enable = void><br /> |
| struct datasketches::serde< T, Enable ></div><p>Interface for serializing and deserializing items. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a6c83e1b2b2ec0c10698a155e60ef2b4c" name="a6c83e1b2b2ec0c10698a155e60ef2b4c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6c83e1b2b2ec0c10698a155e60ef2b4c">◆ </a></span>serialize() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename T , typename Enable = void> </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void serialize </td> |
| <td>(</td> |
| <td class="paramtype">std::ostream & </td> |
| <td class="paramname"><em>os</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const T * </td> |
| <td class="paramname"><em>items</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">unsigned </td> |
| <td class="paramname"><em>num</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Stream serialization. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">os</td><td>output stream </td></tr> |
| <tr><td class="paramname">items</td><td>pointer to array of items </td></tr> |
| <tr><td class="paramname">num</td><td>number of items </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a6a54156811a53ef44ac95b507e51c96a" name="a6a54156811a53ef44ac95b507e51c96a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6a54156811a53ef44ac95b507e51c96a">◆ </a></span>deserialize() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename T , typename Enable = void> </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void deserialize </td> |
| <td>(</td> |
| <td class="paramtype">std::istream & </td> |
| <td class="paramname"><em>is</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">T * </td> |
| <td class="paramname"><em>items</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">unsigned </td> |
| <td class="paramname"><em>num</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Stream deserialization. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">is</td><td>input stream </td></tr> |
| <tr><td class="paramname">items</td><td>pointer to array of items (items in the array are allocated but not initialized) </td></tr> |
| <tr><td class="paramname">num</td><td>number of items </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a8cf20deb8d752971876e996135c26eaa" name="a8cf20deb8d752971876e996135c26eaa"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8cf20deb8d752971876e996135c26eaa">◆ </a></span>serialize() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename T , typename Enable = void> </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">size_t serialize </td> |
| <td>(</td> |
| <td class="paramtype">void * </td> |
| <td class="paramname"><em>ptr</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">size_t </td> |
| <td class="paramname"><em>capacity</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const T * </td> |
| <td class="paramname"><em>items</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">unsigned </td> |
| <td class="paramname"><em>num</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Raw bytes serialization. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">ptr</td><td>pointer to output buffer </td></tr> |
| <tr><td class="paramname">capacity</td><td>size of the buffer in bytes </td></tr> |
| <tr><td class="paramname">items</td><td>pointer to array of items </td></tr> |
| <tr><td class="paramname">num</td><td>number of items </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a45678998333722fab5dd1e278ac27ef5" name="a45678998333722fab5dd1e278ac27ef5"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a45678998333722fab5dd1e278ac27ef5">◆ </a></span>deserialize() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename T , typename Enable = void> </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">size_t deserialize </td> |
| <td>(</td> |
| <td class="paramtype">const void * </td> |
| <td class="paramname"><em>ptr</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">size_t </td> |
| <td class="paramname"><em>capacity</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">T * </td> |
| <td class="paramname"><em>items</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">unsigned </td> |
| <td class="paramname"><em>num</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Raw bytes deserialization. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">ptr</td><td>pointer to input buffer </td></tr> |
| <tr><td class="paramname">capacity</td><td>size of the buffer in bytes </td></tr> |
| <tr><td class="paramname">items</td><td>pointer to array of items (items in the array are allocated but not initialized) </td></tr> |
| <tr><td class="paramname">num</td><td>number of items </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a3291383cf9767a56e84b1a0ef5da178e" name="a3291383cf9767a56e84b1a0ef5da178e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3291383cf9767a56e84b1a0ef5da178e">◆ </a></span>size_of_item()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename T , typename Enable = void> </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">size_t size_of_item </td> |
| <td>(</td> |
| <td class="paramtype">const T & </td> |
| <td class="paramname"><em>item</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Size of the given item. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">item</td><td>to be sized </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>size of the given item in bytes </dd></dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this struct was generated from the following file:<ul> |
| <li>common/include/<a class="el" href="serde_8hpp_source.html">serde.hpp</a></li> |
| </ul> |
| </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> |
