| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Avro C++: avro::StreamReader Struct 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 style="height: 56px;"> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">Avro C++ |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.13 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| </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"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="namespaceavro.html">avro</a></li><li class="navelem"><a class="el" href="structavro_1_1StreamReader.html">StreamReader</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-attribs">Public Attributes</a> | |
| <a href="structavro_1_1StreamReader-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">avro::StreamReader Struct Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>A convenience class for reading from an <a class="el" href="classavro_1_1InputStream.html" title="A no-copy input stream. ">InputStream</a>. |
| <a href="structavro_1_1StreamReader.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="Stream_8hh_source.html">Stream.hh</a>></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:a1f69076d05b5711cf0695d1a91193737"><td class="memItemLeft" align="right" valign="top"><a id="a1f69076d05b5711cf0695d1a91193737"></a> |
|  </td><td class="memItemRight" valign="bottom"><a class="el" href="structavro_1_1StreamReader.html#a1f69076d05b5711cf0695d1a91193737">StreamReader</a> ()</td></tr> |
| <tr class="memdesc:a1f69076d05b5711cf0695d1a91193737"><td class="mdescLeft"> </td><td class="mdescRight">Constructs an empty reader. <br /></td></tr> |
| <tr class="separator:a1f69076d05b5711cf0695d1a91193737"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad364f5ec1191462b88d75fdc29ddd639"><td class="memItemLeft" align="right" valign="top"><a id="ad364f5ec1191462b88d75fdc29ddd639"></a> |
|  </td><td class="memItemRight" valign="bottom"><a class="el" href="structavro_1_1StreamReader.html#ad364f5ec1191462b88d75fdc29ddd639">StreamReader</a> (<a class="el" href="classavro_1_1InputStream.html">InputStream</a> &in)</td></tr> |
| <tr class="memdesc:ad364f5ec1191462b88d75fdc29ddd639"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a reader with the given underlying stream. <br /></td></tr> |
| <tr class="separator:ad364f5ec1191462b88d75fdc29ddd639"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a293c20163efcc2d0380fab80f3c82058"><td class="memItemLeft" align="right" valign="top"><a id="a293c20163efcc2d0380fab80f3c82058"></a> |
| void </td><td class="memItemRight" valign="bottom"><a class="el" href="structavro_1_1StreamReader.html#a293c20163efcc2d0380fab80f3c82058">reset</a> (<a class="el" href="classavro_1_1InputStream.html">InputStream</a> &is)</td></tr> |
| <tr class="memdesc:a293c20163efcc2d0380fab80f3c82058"><td class="mdescLeft"> </td><td class="mdescRight">Replaces the current input stream with the given one after backing up the original one if required. <br /></td></tr> |
| <tr class="separator:a293c20163efcc2d0380fab80f3c82058"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ace1b429f51df3702a33d2991031ac2f8"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structavro_1_1StreamReader.html#ace1b429f51df3702a33d2991031ac2f8">read</a> ()</td></tr> |
| <tr class="memdesc:ace1b429f51df3702a33d2991031ac2f8"><td class="mdescLeft"> </td><td class="mdescRight">Read just one byte from the underlying stream. <a href="#ace1b429f51df3702a33d2991031ac2f8">More...</a><br /></td></tr> |
| <tr class="separator:ace1b429f51df3702a33d2991031ac2f8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae2f45670ed6815c76103245665f0ee25"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structavro_1_1StreamReader.html#ae2f45670ed6815c76103245665f0ee25">readBytes</a> (uint8_t *b, size_t n)</td></tr> |
| <tr class="memdesc:ae2f45670ed6815c76103245665f0ee25"><td class="mdescLeft"> </td><td class="mdescRight">Reads the given number of bytes from the underlying stream. <a href="#ae2f45670ed6815c76103245665f0ee25">More...</a><br /></td></tr> |
| <tr class="separator:ae2f45670ed6815c76103245665f0ee25"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a25be160ee9e5fd541c0004066376c4ac"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structavro_1_1StreamReader.html#a25be160ee9e5fd541c0004066376c4ac">skipBytes</a> (size_t n)</td></tr> |
| <tr class="memdesc:a25be160ee9e5fd541c0004066376c4ac"><td class="mdescLeft"> </td><td class="mdescRight">Skips the given number of bytes. <a href="#a25be160ee9e5fd541c0004066376c4ac">More...</a><br /></td></tr> |
| <tr class="separator:a25be160ee9e5fd541c0004066376c4ac"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af255c4f8690be489a0b623328e1cee76"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structavro_1_1StreamReader.html#af255c4f8690be489a0b623328e1cee76">fill</a> ()</td></tr> |
| <tr class="memdesc:af255c4f8690be489a0b623328e1cee76"><td class="mdescLeft"> </td><td class="mdescRight">Get as many byes from the underlying stream as possible in a single chunk. <a href="#af255c4f8690be489a0b623328e1cee76">More...</a><br /></td></tr> |
| <tr class="separator:af255c4f8690be489a0b623328e1cee76"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9501052d3dbbf54070f565bc0f0d644a"><td class="memItemLeft" align="right" valign="top"><a id="a9501052d3dbbf54070f565bc0f0d644a"></a> |
| void </td><td class="memItemRight" valign="bottom"><a class="el" href="structavro_1_1StreamReader.html#a9501052d3dbbf54070f565bc0f0d644a">more</a> ()</td></tr> |
| <tr class="memdesc:a9501052d3dbbf54070f565bc0f0d644a"><td class="mdescLeft"> </td><td class="mdescRight">Tries to get more data and if it cannot, throws an exception. <br /></td></tr> |
| <tr class="separator:a9501052d3dbbf54070f565bc0f0d644a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad87f4fb3d42428965766169da50a7487"><td class="memItemLeft" align="right" valign="top"><a id="ad87f4fb3d42428965766169da50a7487"></a> |
| bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structavro_1_1StreamReader.html#ad87f4fb3d42428965766169da50a7487">hasMore</a> ()</td></tr> |
| <tr class="memdesc:ad87f4fb3d42428965766169da50a7487"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if and only if the end of stream is not reached. <br /></td></tr> |
| <tr class="separator:ad87f4fb3d42428965766169da50a7487"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8c31fc602f068368d7a0e91eea71c4de"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structavro_1_1StreamReader.html#a8c31fc602f068368d7a0e91eea71c4de">drain</a> (bool unRead)</td></tr> |
| <tr class="memdesc:a8c31fc602f068368d7a0e91eea71c4de"><td class="mdescLeft"> </td><td class="mdescRight">Returns unused bytes back to the underlying stream. <a href="#a8c31fc602f068368d7a0e91eea71c4de">More...</a><br /></td></tr> |
| <tr class="separator:a8c31fc602f068368d7a0e91eea71c4de"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> |
| Public Attributes</h2></td></tr> |
| <tr class="memitem:ac496ab63c9b3d68c60e8e5697cdd3008"><td class="memItemLeft" align="right" valign="top"><a id="ac496ab63c9b3d68c60e8e5697cdd3008"></a> |
| <a class="el" href="classavro_1_1InputStream.html">InputStream</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structavro_1_1StreamReader.html#ac496ab63c9b3d68c60e8e5697cdd3008">in_</a></td></tr> |
| <tr class="memdesc:ac496ab63c9b3d68c60e8e5697cdd3008"><td class="mdescLeft"> </td><td class="mdescRight">The underlying input stream. <br /></td></tr> |
| <tr class="separator:ac496ab63c9b3d68c60e8e5697cdd3008"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac404aa90132b520e7c45cec577d18d94"><td class="memItemLeft" align="right" valign="top"><a id="ac404aa90132b520e7c45cec577d18d94"></a> |
| const uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="structavro_1_1StreamReader.html#ac404aa90132b520e7c45cec577d18d94">next_</a></td></tr> |
| <tr class="memdesc:ac404aa90132b520e7c45cec577d18d94"><td class="mdescLeft"> </td><td class="mdescRight">The next location to read from. <br /></td></tr> |
| <tr class="separator:ac404aa90132b520e7c45cec577d18d94"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a463de69a6b09caa9cb8467b75ecfd710"><td class="memItemLeft" align="right" valign="top"><a id="a463de69a6b09caa9cb8467b75ecfd710"></a> |
| const uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="structavro_1_1StreamReader.html#a463de69a6b09caa9cb8467b75ecfd710">end_</a></td></tr> |
| <tr class="memdesc:a463de69a6b09caa9cb8467b75ecfd710"><td class="mdescLeft"> </td><td class="mdescRight">One past the last valid location. <br /></td></tr> |
| <tr class="separator:a463de69a6b09caa9cb8467b75ecfd710"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>A convenience class for reading from an <a class="el" href="classavro_1_1InputStream.html" title="A no-copy input stream. ">InputStream</a>. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a8c31fc602f068368d7a0e91eea71c4de"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8c31fc602f068368d7a0e91eea71c4de">◆ </a></span>drain()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void avro::StreamReader::drain </td> |
| <td>(</td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>unRead</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns unused bytes back to the underlying stream. </p> |
| <p>If unRead is true the last byte read is also pushed back. </p> |
| |
| <p class="reference">References <a class="el" href="classavro_1_1InputStream.html#a03f9cfac5f7a0141bfe7d6cc4bc7a0d0">avro::InputStream::backup()</a>.</p> |
| |
| </div> |
| </div> |
| <a id="af255c4f8690be489a0b623328e1cee76"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af255c4f8690be489a0b623328e1cee76">◆ </a></span>fill()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool avro::StreamReader::fill </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get as many byes from the underlying stream as possible in a single chunk. </p> |
| <dl class="section return"><dt>Returns</dt><dd>true if some data could be obtained. False is no more data is available on the stream. </dd></dl> |
| |
| <p class="reference">References <a class="el" href="classavro_1_1InputStream.html#a87767c15b0661981d24f7a42bfcef6b5">avro::InputStream::next()</a>.</p> |
| |
| </div> |
| </div> |
| <a id="ace1b429f51df3702a33d2991031ac2f8"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ace1b429f51df3702a33d2991031ac2f8">◆ </a></span>read()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">uint8_t avro::StreamReader::read </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Read just one byte from the underlying stream. </p> |
| <p>If there are no more data, throws an exception. </p> |
| |
| </div> |
| </div> |
| <a id="ae2f45670ed6815c76103245665f0ee25"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae2f45670ed6815c76103245665f0ee25">◆ </a></span>readBytes()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void avro::StreamReader::readBytes </td> |
| <td>(</td> |
| <td class="paramtype">uint8_t * </td> |
| <td class="paramname"><em>b</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">size_t </td> |
| <td class="paramname"><em>n</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> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Reads the given number of bytes from the underlying stream. </p> |
| <p>If there are not that many bytes, throws an exception. </p> |
| |
| </div> |
| </div> |
| <a id="a25be160ee9e5fd541c0004066376c4ac"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a25be160ee9e5fd541c0004066376c4ac">◆ </a></span>skipBytes()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void avro::StreamReader::skipBytes </td> |
| <td>(</td> |
| <td class="paramtype">size_t </td> |
| <td class="paramname"><em>n</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Skips the given number of bytes. </p> |
| <p>Of there are not so that many bytes, throws an exception. </p> |
| |
| <p class="reference">References <a class="el" href="classavro_1_1InputStream.html#a4ec852f779fc68dea8fef197ec3eef1d">avro::InputStream::skip()</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this struct was generated from the following file:<ul> |
| <li>api/<a class="el" href="Stream_8hh_source.html">Stream.hh</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.13 |
| </small></address> |
| </body> |
| </html> |
