api/xml/classiceberg_1_1test_1_1StdPositionOutputStream.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_1test_1_1StdPositionOutputStream" kind="class" language="C++" prot="public">
    <compoundname>iceberg::test::StdPositionOutputStream</compoundname>
    <basecompoundref refid="classiceberg_1_1PositionOutputStream" prot="public" virt="non-virtual">iceberg::PositionOutputStream</basecompoundref>
    <sectiondef kind="private-attrib">
      <memberdef kind="variable" id="classiceberg_1_1test_1_1StdPositionOutputStream_1affaa0af6349c529325406fe85ee7a2df" prot="private" static="no" mutable="no">
        <type>std::string</type>
        <definition>std::string iceberg::test::StdPositionOutputStream::location_</definition>
        <argsstring></argsstring>
        <name>location_</name>
        <qualifiedname>iceberg::test::StdPositionOutputStream::location_</qualifiedname>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/test/std_io.h" line="205" column="15" bodyfile="iceberg/test/std_io.h" bodystart="205" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classiceberg_1_1test_1_1StdPositionOutputStream_1a5b31b214ad5e481bf03ced5c2880267d" prot="private" static="no" mutable="yes">
        <type>std::ofstream</type>
        <definition>std::ofstream iceberg::test::StdPositionOutputStream::file_</definition>
        <argsstring></argsstring>
        <name>file_</name>
        <qualifiedname>iceberg::test::StdPositionOutputStream::file_</qualifiedname>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/test/std_io.h" line="206" column="25" bodyfile="iceberg/test/std_io.h" bodystart="206" bodyend="-1"/>
      </memberdef>
    </sectiondef>
    <sectiondef kind="public-func">
      <memberdef kind="function" id="classiceberg_1_1test_1_1StdPositionOutputStream_1ad96b064c2488b805c55b8cdc7324009c" prot="public" static="no" const="no" explicit="yes" inline="yes" virt="non-virtual">
        <type></type>
        <definition>iceberg::test::StdPositionOutputStream::StdPositionOutputStream</definition>
        <argsstring>(std::string location)</argsstring>
        <name>StdPositionOutputStream</name>
        <qualifiedname>iceberg::test::StdPositionOutputStream::StdPositionOutputStream</qualifiedname>
        <param>
          <type>std::string</type>
          <declname>location</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/test/std_io.h" line="159" column="12" bodyfile="iceberg/test/std_io.h" bodystart="159" bodyend="161"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1test_1_1StdPositionOutputStream_1a0290597909ff1b4569f294e201609fd6" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
        <type>bool</type>
        <definition>bool iceberg::test::StdPositionOutputStream::is_open</definition>
        <argsstring>() const</argsstring>
        <name>is_open</name>
        <qualifiedname>iceberg::test::StdPositionOutputStream::is_open</qualifiedname>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/test/std_io.h" line="163" column="8" bodyfile="iceberg/test/std_io.h" bodystart="163" bodyend="163"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1test_1_1StdPositionOutputStream_1a6bc8e1bf108788599c8e8f43540af127" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="virtual">
        <type>Result&lt; int64_t &gt;</type>
        <definition>Result&lt; int64_t &gt; iceberg::test::StdPositionOutputStream::Position</definition>
        <argsstring>() const override</argsstring>
        <name>Position</name>
        <qualifiedname>iceberg::test::StdPositionOutputStream::Position</qualifiedname>
        <reimplements refid="classiceberg_1_1PositionOutputStream_1a8a297ee1f7081592e89e04d312608944">Position</reimplements>
        <briefdescription>
<para>Return the current write position. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/test/std_io.h" line="165" column="10" bodyfile="iceberg/test/std_io.h" bodystart="165" bodyend="171"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1test_1_1StdPositionOutputStream_1a313f8300dca717765dc9cc5d73aaf6a2" prot="public" static="no" const="no" explicit="no" inline="yes" virt="virtual">
        <type>Status</type>
        <definition>Status iceberg::test::StdPositionOutputStream::Write</definition>
        <argsstring>(std::span&lt; const std::byte &gt; data) override</argsstring>
        <name>Write</name>
        <qualifiedname>iceberg::test::StdPositionOutputStream::Write</qualifiedname>
        <reimplements refid="classiceberg_1_1PositionOutputStream_1a8e4e2b8170e8890315f29f923adca4fd">Write</reimplements>
        <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/test/std_io.h" line="173" column="10" bodyfile="iceberg/test/std_io.h" bodystart="173" bodyend="183"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1test_1_1StdPositionOutputStream_1ad868890f010ae1da2a9928d4003eb65e" prot="public" static="no" const="no" explicit="no" inline="yes" virt="virtual">
        <type>Status</type>
        <definition>Status iceberg::test::StdPositionOutputStream::Flush</definition>
        <argsstring>() override</argsstring>
        <name>Flush</name>
        <qualifiedname>iceberg::test::StdPositionOutputStream::Flush</qualifiedname>
        <reimplements refid="classiceberg_1_1PositionOutputStream_1af39318871759febda6183d96f12c566a">Flush</reimplements>
        <briefdescription>
<para>Flush buffered data to the underlying store. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/test/std_io.h" line="185" column="10" bodyfile="iceberg/test/std_io.h" bodystart="185" bodyend="191"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1test_1_1StdPositionOutputStream_1afd03afc5920ea55a104b561e6cfd695e" prot="public" static="no" const="no" explicit="no" inline="yes" virt="virtual">
        <type>Status</type>
        <definition>Status iceberg::test::StdPositionOutputStream::Close</definition>
        <argsstring>() override</argsstring>
        <name>Close</name>
        <qualifiedname>iceberg::test::StdPositionOutputStream::Close</qualifiedname>
        <reimplements refid="classiceberg_1_1PositionOutputStream_1afdc2d172994065da3c356f9652e4ee54">Close</reimplements>
        <briefdescription>
<para>Close the stream. Implementations should allow repeated Close calls. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/test/std_io.h" line="193" column="10" bodyfile="iceberg/test/std_io.h" bodystart="193" bodyend="202"/>
      </memberdef>
    </sectiondef>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <inheritancegraph>
      <node id="2">
        <label>iceberg::PositionOutputStream</label>
        <link refid="classiceberg_1_1PositionOutputStream"/>
      </node>
      <node id="1">
        <label>iceberg::test::StdPositionOutputStream</label>
        <link refid="classiceberg_1_1test_1_1StdPositionOutputStream"/>
        <childnode refid="2" relation="public-inheritance">
        </childnode>
      </node>
    </inheritancegraph>
    <collaborationgraph>
      <node id="2">
        <label>iceberg::PositionOutputStream</label>
        <link refid="classiceberg_1_1PositionOutputStream"/>
      </node>
      <node id="1">
        <label>iceberg::test::StdPositionOutputStream</label>
        <link refid="classiceberg_1_1test_1_1StdPositionOutputStream"/>
        <childnode refid="2" relation="public-inheritance">
        </childnode>
      </node>
    </collaborationgraph>
    <location file="iceberg/test/std_io.h" line="157" column="1" bodyfile="iceberg/test/std_io.h" bodystart="157" bodyend="207"/>
    <listofallmembers>
      <member refid="classiceberg_1_1test_1_1StdPositionOutputStream_1afd03afc5920ea55a104b561e6cfd695e" prot="public" virt="virtual"><scope>iceberg::test::StdPositionOutputStream</scope><name>Close</name></member>
      <member refid="classiceberg_1_1test_1_1StdPositionOutputStream_1a5b31b214ad5e481bf03ced5c2880267d" prot="private" virt="non-virtual"><scope>iceberg::test::StdPositionOutputStream</scope><name>file_</name></member>
      <member refid="classiceberg_1_1test_1_1StdPositionOutputStream_1ad868890f010ae1da2a9928d4003eb65e" prot="public" virt="virtual"><scope>iceberg::test::StdPositionOutputStream</scope><name>Flush</name></member>
      <member refid="classiceberg_1_1test_1_1StdPositionOutputStream_1a0290597909ff1b4569f294e201609fd6" prot="public" virt="non-virtual"><scope>iceberg::test::StdPositionOutputStream</scope><name>is_open</name></member>
      <member refid="classiceberg_1_1test_1_1StdPositionOutputStream_1affaa0af6349c529325406fe85ee7a2df" prot="private" virt="non-virtual"><scope>iceberg::test::StdPositionOutputStream</scope><name>location_</name></member>
      <member refid="classiceberg_1_1test_1_1StdPositionOutputStream_1a6bc8e1bf108788599c8e8f43540af127" prot="public" virt="virtual"><scope>iceberg::test::StdPositionOutputStream</scope><name>Position</name></member>
      <member refid="classiceberg_1_1test_1_1StdPositionOutputStream_1ad96b064c2488b805c55b8cdc7324009c" prot="public" virt="non-virtual"><scope>iceberg::test::StdPositionOutputStream</scope><name>StdPositionOutputStream</name></member>
      <member refid="classiceberg_1_1test_1_1StdPositionOutputStream_1a313f8300dca717765dc9cc5d73aaf6a2" prot="public" virt="virtual"><scope>iceberg::test::StdPositionOutputStream</scope><name>Write</name></member>
      <member refid="classiceberg_1_1PositionOutputStream_1a5b25b209d5a47e9f0120847487cc18a6" prot="public" virt="virtual"><scope>iceberg::test::StdPositionOutputStream</scope><name>~PositionOutputStream</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>