| <!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::StreamWriter 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_1StreamWriter.html">StreamWriter</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_1StreamWriter-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">avro::StreamWriter Struct Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>A convinience class to write data into an <a class="el" href="classavro_1_1OutputStream.html" title="A no-copy output stream. ">OutputStream</a>. |
| <a href="structavro_1_1StreamWriter.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:a5e20cd787a15c2941c90b6d077c73d14"><td class="memItemLeft" align="right" valign="top"><a id="a5e20cd787a15c2941c90b6d077c73d14"></a> |
|  </td><td class="memItemRight" valign="bottom"><a class="el" href="structavro_1_1StreamWriter.html#a5e20cd787a15c2941c90b6d077c73d14">StreamWriter</a> ()</td></tr> |
| <tr class="memdesc:a5e20cd787a15c2941c90b6d077c73d14"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a writer with no underlying stream. <br /></td></tr> |
| <tr class="separator:a5e20cd787a15c2941c90b6d077c73d14"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9e1685a3f609d96f8da8678ee8036350"><td class="memItemLeft" align="right" valign="top"><a id="a9e1685a3f609d96f8da8678ee8036350"></a> |
|  </td><td class="memItemRight" valign="bottom"><a class="el" href="structavro_1_1StreamWriter.html#a9e1685a3f609d96f8da8678ee8036350">StreamWriter</a> (<a class="el" href="classavro_1_1OutputStream.html">OutputStream</a> &out)</td></tr> |
| <tr class="memdesc:a9e1685a3f609d96f8da8678ee8036350"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new writer with the given underlying stream. <br /></td></tr> |
| <tr class="separator:a9e1685a3f609d96f8da8678ee8036350"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af3aaff674b77d7f98de86597da26b1f3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structavro_1_1StreamWriter.html#af3aaff674b77d7f98de86597da26b1f3">reset</a> (<a class="el" href="classavro_1_1OutputStream.html">OutputStream</a> &os)</td></tr> |
| <tr class="memdesc:af3aaff674b77d7f98de86597da26b1f3"><td class="mdescLeft"> </td><td class="mdescRight">Replaces the current underlying stream with a new one. <a href="#af3aaff674b77d7f98de86597da26b1f3">More...</a><br /></td></tr> |
| <tr class="separator:af3aaff674b77d7f98de86597da26b1f3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8edff3e28052978180a42b2f792eb28d"><td class="memItemLeft" align="right" valign="top"><a id="a8edff3e28052978180a42b2f792eb28d"></a> |
| void </td><td class="memItemRight" valign="bottom"><a class="el" href="structavro_1_1StreamWriter.html#a8edff3e28052978180a42b2f792eb28d">write</a> (uint8_t c)</td></tr> |
| <tr class="memdesc:a8edff3e28052978180a42b2f792eb28d"><td class="mdescLeft"> </td><td class="mdescRight">Writes a single byte. <br /></td></tr> |
| <tr class="separator:a8edff3e28052978180a42b2f792eb28d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a803e4adca5c39eeeb2fb179cdd26123a"><td class="memItemLeft" align="right" valign="top"><a id="a803e4adca5c39eeeb2fb179cdd26123a"></a> |
| void </td><td class="memItemRight" valign="bottom"><a class="el" href="structavro_1_1StreamWriter.html#a803e4adca5c39eeeb2fb179cdd26123a">writeBytes</a> (const uint8_t *b, size_t n)</td></tr> |
| <tr class="memdesc:a803e4adca5c39eeeb2fb179cdd26123a"><td class="mdescLeft"> </td><td class="mdescRight">Writes the specified number of bytes starting at <code>b</code>. <br /></td></tr> |
| <tr class="separator:a803e4adca5c39eeeb2fb179cdd26123a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8163904c80aca61a9a1c35d9b1b4604d"><td class="memItemLeft" align="right" valign="top"><a id="a8163904c80aca61a9a1c35d9b1b4604d"></a> |
| void </td><td class="memItemRight" valign="bottom"><a class="el" href="structavro_1_1StreamWriter.html#a8163904c80aca61a9a1c35d9b1b4604d">flush</a> ()</td></tr> |
| <tr class="memdesc:a8163904c80aca61a9a1c35d9b1b4604d"><td class="mdescLeft"> </td><td class="mdescRight">backs up upto the currently written data and flushes the underlying stream. <br /></td></tr> |
| <tr class="separator:a8163904c80aca61a9a1c35d9b1b4604d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2fbdd9e896bdfb7f704b52243b4f1661"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structavro_1_1StreamWriter.html#a2fbdd9e896bdfb7f704b52243b4f1661">byteCount</a> () const</td></tr> |
| <tr class="memdesc:a2fbdd9e896bdfb7f704b52243b4f1661"><td class="mdescLeft"> </td><td class="mdescRight">Return the number of bytes written so far. <a href="#a2fbdd9e896bdfb7f704b52243b4f1661">More...</a><br /></td></tr> |
| <tr class="separator:a2fbdd9e896bdfb7f704b52243b4f1661"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a93740c70becb0f206a05c5dd1f2a7880"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structavro_1_1StreamWriter.html#a93740c70becb0f206a05c5dd1f2a7880">more</a> ()</td></tr> |
| <tr class="memdesc:a93740c70becb0f206a05c5dd1f2a7880"><td class="mdescLeft"> </td><td class="mdescRight">Gets more space to write to. <a href="#a93740c70becb0f206a05c5dd1f2a7880">More...</a><br /></td></tr> |
| <tr class="separator:a93740c70becb0f206a05c5dd1f2a7880"><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:a18f69b15f00ea780ee61f50c9467e0a7"><td class="memItemLeft" align="right" valign="top"><a id="a18f69b15f00ea780ee61f50c9467e0a7"></a> |
| <a class="el" href="classavro_1_1OutputStream.html">OutputStream</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structavro_1_1StreamWriter.html#a18f69b15f00ea780ee61f50c9467e0a7">out_</a></td></tr> |
| <tr class="memdesc:a18f69b15f00ea780ee61f50c9467e0a7"><td class="mdescLeft"> </td><td class="mdescRight">The underlying output stream for this writer. <br /></td></tr> |
| <tr class="separator:a18f69b15f00ea780ee61f50c9467e0a7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8c0e8d18a3dd81d77dbefe7cf5783986"><td class="memItemLeft" align="right" valign="top"><a id="a8c0e8d18a3dd81d77dbefe7cf5783986"></a> |
| uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="structavro_1_1StreamWriter.html#a8c0e8d18a3dd81d77dbefe7cf5783986">next_</a></td></tr> |
| <tr class="memdesc:a8c0e8d18a3dd81d77dbefe7cf5783986"><td class="mdescLeft"> </td><td class="mdescRight">The next location to write to. <br /></td></tr> |
| <tr class="separator:a8c0e8d18a3dd81d77dbefe7cf5783986"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4f7275c5b1eb184a154760c1cbb192a5"><td class="memItemLeft" align="right" valign="top"><a id="a4f7275c5b1eb184a154760c1cbb192a5"></a> |
| uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="structavro_1_1StreamWriter.html#a4f7275c5b1eb184a154760c1cbb192a5">end_</a></td></tr> |
| <tr class="memdesc:a4f7275c5b1eb184a154760c1cbb192a5"><td class="mdescLeft"> </td><td class="mdescRight">One past the last location one can write to. <br /></td></tr> |
| <tr class="separator:a4f7275c5b1eb184a154760c1cbb192a5"><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 convinience class to write data into an <a class="el" href="classavro_1_1OutputStream.html" title="A no-copy output stream. ">OutputStream</a>. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a2fbdd9e896bdfb7f704b52243b4f1661"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2fbdd9e896bdfb7f704b52243b4f1661">◆ </a></span>byteCount()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int64_t avro::StreamWriter::byteCount </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Return the number of bytes written so far. </p> |
| <p>For a meaningful result, call this after a <a class="el" href="structavro_1_1StreamWriter.html#a8163904c80aca61a9a1c35d9b1b4604d" title="backs up upto the currently written data and flushes the underlying stream. ">flush()</a>. </p> |
| |
| <p class="reference">References <a class="el" href="classavro_1_1OutputStream.html#ab799b7bad4c75b5ade65fa6fd117a4b4">avro::OutputStream::byteCount()</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a93740c70becb0f206a05c5dd1f2a7880"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a93740c70becb0f206a05c5dd1f2a7880">◆ </a></span>more()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void avro::StreamWriter::more </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>Gets more space to write to. </p> |
| <p>Throws an exception it cannot. </p> |
| |
| <p class="reference">References <a class="el" href="classavro_1_1OutputStream.html#a257177c7b0f2e98c523cb2ae68737e18">avro::OutputStream::next()</a>.</p> |
| |
| </div> |
| </div> |
| <a id="af3aaff674b77d7f98de86597da26b1f3"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af3aaff674b77d7f98de86597da26b1f3">◆ </a></span>reset()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void avro::StreamWriter::reset </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classavro_1_1OutputStream.html">OutputStream</a> & </td> |
| <td class="paramname"><em>os</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>Replaces the current underlying stream with a new one. </p> |
| <p>If required, it backs up unused bytes in the previous stream. </p> |
| |
| <p class="reference">References <a class="el" href="classavro_1_1OutputStream.html#a81881efd901311b1fc6610f77791adfe">avro::OutputStream::backup()</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> |
