blob: cfc2d4d4023506de5472c51c9bb6f6b1887fb980 [file]
<!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::test::StdPositionOutputStream Class 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"><b>iceberg</b></li><li class="navelem"><b>test</b></li><li class="navelem"><a class="el" href="classiceberg_1_1test_1_1StdPositionOutputStream.html">StdPositionOutputStream</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classiceberg_1_1test_1_1StdPositionOutputStream-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::test::StdPositionOutputStream Class Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for iceberg::test::StdPositionOutputStream:</div>
<div class="dyncontent">
<div class="center">
<img src="classiceberg_1_1test_1_1StdPositionOutputStream.png" usemap="#iceberg::test::StdPositionOutputStream_map" alt=""/>
<map id="iceberg::test::StdPositionOutputStream_map" name="iceberg::test::StdPositionOutputStream_map">
<area href="classiceberg_1_1PositionOutputStream.html" title="Positioned byte stream for writing file contents." alt="iceberg::PositionOutputStream" shape="rect" coords="0,0,224,24"/>
</map>
</div></div>
<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:ad96b064c2488b805c55b8cdc7324009c" id="r_ad96b064c2488b805c55b8cdc7324009c"><td class="memItemLeft" align="right" valign="top"><a id="ad96b064c2488b805c55b8cdc7324009c" name="ad96b064c2488b805c55b8cdc7324009c"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>StdPositionOutputStream</b> (std::string location)</td></tr>
<tr class="separator:ad96b064c2488b805c55b8cdc7324009c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0290597909ff1b4569f294e201609fd6" id="r_a0290597909ff1b4569f294e201609fd6"><td class="memItemLeft" align="right" valign="top"><a id="a0290597909ff1b4569f294e201609fd6" name="a0290597909ff1b4569f294e201609fd6"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>is_open</b> () const</td></tr>
<tr class="separator:a0290597909ff1b4569f294e201609fd6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6bc8e1bf108788599c8e8f43540af127" id="r_a6bc8e1bf108788599c8e8f43540af127"><td class="memItemLeft" align="right" valign="top">Result&lt; int64_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1test_1_1StdPositionOutputStream.html#a6bc8e1bf108788599c8e8f43540af127">Position</a> () const override</td></tr>
<tr class="memdesc:a6bc8e1bf108788599c8e8f43540af127"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the current write position. <br /></td></tr>
<tr class="separator:a6bc8e1bf108788599c8e8f43540af127"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a313f8300dca717765dc9cc5d73aaf6a2" id="r_a313f8300dca717765dc9cc5d73aaf6a2"><td class="memItemLeft" align="right" valign="top">Status&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1test_1_1StdPositionOutputStream.html#a313f8300dca717765dc9cc5d73aaf6a2">Write</a> (std::span&lt; const std::byte &gt; data) override</td></tr>
<tr class="memdesc:a313f8300dca717765dc9cc5d73aaf6a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write all bytes in data at the current position. <br /></td></tr>
<tr class="separator:a313f8300dca717765dc9cc5d73aaf6a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad868890f010ae1da2a9928d4003eb65e" id="r_ad868890f010ae1da2a9928d4003eb65e"><td class="memItemLeft" align="right" valign="top">Status&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1test_1_1StdPositionOutputStream.html#ad868890f010ae1da2a9928d4003eb65e">Flush</a> () override</td></tr>
<tr class="memdesc:ad868890f010ae1da2a9928d4003eb65e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flush buffered data to the underlying store. <br /></td></tr>
<tr class="separator:ad868890f010ae1da2a9928d4003eb65e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afd03afc5920ea55a104b561e6cfd695e" id="r_afd03afc5920ea55a104b561e6cfd695e"><td class="memItemLeft" align="right" valign="top">Status&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1test_1_1StdPositionOutputStream.html#afd03afc5920ea55a104b561e6cfd695e">Close</a> () override</td></tr>
<tr class="memdesc:afd03afc5920ea55a104b561e6cfd695e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Close the stream. Implementations should allow repeated Close calls. <br /></td></tr>
<tr class="separator:afd03afc5920ea55a104b561e6cfd695e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="afd03afc5920ea55a104b561e6cfd695e" name="afd03afc5920ea55a104b561e6cfd695e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afd03afc5920ea55a104b561e6cfd695e">&#9670;&#160;</a></span>Close()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Status iceberg::test::StdPositionOutputStream::Close </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">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Close the stream. Implementations should allow repeated Close calls. </p>
<p>Implements <a class="el" href="classiceberg_1_1PositionOutputStream.html#afdc2d172994065da3c356f9652e4ee54">iceberg::PositionOutputStream</a>.</p>
</div>
</div>
<a id="ad868890f010ae1da2a9928d4003eb65e" name="ad868890f010ae1da2a9928d4003eb65e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad868890f010ae1da2a9928d4003eb65e">&#9670;&#160;</a></span>Flush()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Status iceberg::test::StdPositionOutputStream::Flush </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">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Flush buffered data to the underlying store. </p>
<p>Implements <a class="el" href="classiceberg_1_1PositionOutputStream.html#af39318871759febda6183d96f12c566a">iceberg::PositionOutputStream</a>.</p>
</div>
</div>
<a id="a6bc8e1bf108788599c8e8f43540af127" name="a6bc8e1bf108788599c8e8f43540af127"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6bc8e1bf108788599c8e8f43540af127">&#9670;&#160;</a></span>Position()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Result&lt; int64_t &gt; iceberg::test::StdPositionOutputStream::Position </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">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the current write position. </p>
<p>Implements <a class="el" href="classiceberg_1_1PositionOutputStream.html#a8a297ee1f7081592e89e04d312608944">iceberg::PositionOutputStream</a>.</p>
</div>
</div>
<a id="a313f8300dca717765dc9cc5d73aaf6a2" name="a313f8300dca717765dc9cc5d73aaf6a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a313f8300dca717765dc9cc5d73aaf6a2">&#9670;&#160;</a></span>Write()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Status iceberg::test::StdPositionOutputStream::Write </td>
<td>(</td>
<td class="paramtype">std::span&lt; const std::byte &gt;&#160;</td>
<td class="paramname"><em>data</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Write all bytes in data at the current position. </p>
<p>Implements <a class="el" href="classiceberg_1_1PositionOutputStream.html#a8e4e2b8170e8890315f29f923adca4fd">iceberg::PositionOutputStream</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>iceberg/test/<a class="el" href="std__io_8h_source.html">std_io.h</a></li>
</ul>
</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>