mkdocs/docs/api/xml/classiceberg_1_1PositionOutputStream.xml

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.9.8" xml:lang="en-US">
  <compounddef id="classiceberg_1_1PositionOutputStream" kind="class" language="C++" prot="public" abstract="yes">
    <compoundname>iceberg::PositionOutputStream</compoundname>
    <includes refid="file__io_8h" local="no">file_io.h</includes>
    <sectiondef kind="public-func">
      <memberdef kind="function" id="classiceberg_1_1PositionOutputStream_1a5b25b209d5a47e9f0120847487cc18a6" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type></type>
        <definition>virtual iceberg::PositionOutputStream::~PositionOutputStream</definition>
        <argsstring>()=default</argsstring>
        <name>~PositionOutputStream</name>
        <qualifiedname>iceberg::PositionOutputStream::~PositionOutputStream</qualifiedname>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/file_io.h" line="70" column="11"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1PositionOutputStream_1a8a297ee1f7081592e89e04d312608944" prot="public" static="no" const="yes" explicit="no" inline="no" virt="pure-virtual">
        <type><ref refid="namespaceiceberg_1a9d5594e371beb516b0120e07e69d3af6" kindref="member">Result</ref>&lt; int64_t &gt;</type>
        <definition>virtual Result&lt; int64_t &gt; iceberg::PositionOutputStream::Position</definition>
        <argsstring>() const =0</argsstring>
        <name>Position</name>
        <qualifiedname>iceberg::PositionOutputStream::Position</qualifiedname>
        <briefdescription>
<para>Return the current write position. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/file_io.h" line="73" column="18"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1PositionOutputStream_1affe5cd166cca304fbc482246fcf224d9" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="virtual">
        <type><ref refid="namespaceiceberg_1a9d5594e371beb516b0120e07e69d3af6" kindref="member">Result</ref>&lt; int64_t &gt;</type>
        <definition>virtual Result&lt; int64_t &gt; iceberg::PositionOutputStream::StoredLength</definition>
        <argsstring>() const</argsstring>
        <name>StoredLength</name>
        <qualifiedname>iceberg::PositionOutputStream::StoredLength</qualifiedname>
        <briefdescription>
<para>Return the current stored length of the output. </para>
        </briefdescription>
        <detaileddescription>
<para>This can differ from the current position for encrypting streams, and for other non-length-preserving streams. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/file_io.h" line="79" column="18" bodyfile="iceberg/file_io.h" bodystart="79" bodyend="79"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1PositionOutputStream_1a8e4e2b8170e8890315f29f923adca4fd" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
        <type>Status</type>
        <definition>virtual Status iceberg::PositionOutputStream::Write</definition>
        <argsstring>(std::span&lt; const std::byte &gt; data)=0</argsstring>
        <name>Write</name>
        <qualifiedname>iceberg::PositionOutputStream::Write</qualifiedname>
        <param>
          <type>std::span&lt; const std::byte &gt;</type>
          <declname>data</declname>
        </param>
        <briefdescription>
<para>Write all bytes in data at the current position. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/file_io.h" line="82" column="18"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1PositionOutputStream_1af39318871759febda6183d96f12c566a" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
        <type>Status</type>
        <definition>virtual Status iceberg::PositionOutputStream::Flush</definition>
        <argsstring>()=0</argsstring>
        <name>Flush</name>
        <qualifiedname>iceberg::PositionOutputStream::Flush</qualifiedname>
        <briefdescription>
<para>Flush buffered data to the underlying store. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/file_io.h" line="85" column="18"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1PositionOutputStream_1afdc2d172994065da3c356f9652e4ee54" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
        <type>Status</type>
        <definition>virtual Status iceberg::PositionOutputStream::Close</definition>
        <argsstring>()=0</argsstring>
        <name>Close</name>
        <qualifiedname>iceberg::PositionOutputStream::Close</qualifiedname>
        <briefdescription>
<para>Close the stream. Implementations should allow repeated Close calls. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/file_io.h" line="88" column="18"/>
      </memberdef>
    </sectiondef>
    <briefdescription>
<para>Positioned byte stream for writing file contents. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="iceberg/file_io.h" line="68" column="1" bodyfile="iceberg/file_io.h" bodystart="68" bodyend="89"/>
    <listofallmembers>
      <member refid="classiceberg_1_1PositionOutputStream_1afdc2d172994065da3c356f9652e4ee54" prot="public" virt="pure-virtual"><scope>iceberg::PositionOutputStream</scope><name>Close</name></member>
      <member refid="classiceberg_1_1PositionOutputStream_1af39318871759febda6183d96f12c566a" prot="public" virt="pure-virtual"><scope>iceberg::PositionOutputStream</scope><name>Flush</name></member>
      <member refid="classiceberg_1_1PositionOutputStream_1a8a297ee1f7081592e89e04d312608944" prot="public" virt="pure-virtual"><scope>iceberg::PositionOutputStream</scope><name>Position</name></member>
      <member refid="classiceberg_1_1PositionOutputStream_1affe5cd166cca304fbc482246fcf224d9" prot="public" virt="virtual"><scope>iceberg::PositionOutputStream</scope><name>StoredLength</name></member>
      <member refid="classiceberg_1_1PositionOutputStream_1a8e4e2b8170e8890315f29f923adca4fd" prot="public" virt="pure-virtual"><scope>iceberg::PositionOutputStream</scope><name>Write</name></member>
      <member refid="classiceberg_1_1PositionOutputStream_1a5b25b209d5a47e9f0120847487cc18a6" prot="public" virt="virtual"><scope>iceberg::PositionOutputStream</scope><name>~PositionOutputStream</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>