blob: 7f47d2da311c346bf04972e5abea8cae195d7d20 [file] [log] [blame]
<?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="formatter_8h" kind="file" language="C++">
<compoundname>formatter.h</compoundname>
<includes local="no">concepts</includes>
<includes local="no">format</includes>
<includes local="no">string_view</includes>
<includes refid="formattable_8h" local="yes">iceberg/util/formattable.h</includes>
<includedby refid="avro__schema__util_8cc" local="yes">iceberg/avro/avro_schema_util.cc</includedby>
<includedby refid="file__reader_8cc" local="yes">iceberg/file_reader.cc</includedby>
<includedby refid="file__writer_8cc" local="yes">iceberg/file_writer.cc</includedby>
<includedby refid="json__serde_8cc" local="yes">iceberg/json_serde.cc</includedby>
<includedby refid="parquet__schema__util_8cc" local="yes">iceberg/parquet/parquet_schema_util.cc</includedby>
<includedby refid="partition__field_8cc" local="yes">iceberg/partition_field.cc</includedby>
<includedby refid="partition__spec_8cc" local="yes">iceberg/partition_spec.cc</includedby>
<includedby refid="partition__summary_8cc" local="yes">iceberg/partition_summary.cc</includedby>
<includedby refid="schema_8cc" local="yes">iceberg/schema.cc</includedby>
<includedby refid="schema__field_8cc" local="yes">iceberg/schema_field.cc</includedby>
<includedby refid="sort__field_8cc" local="yes">iceberg/sort_field.cc</includedby>
<includedby refid="sort__order_8cc" local="yes">iceberg/sort_order.cc</includedby>
<includedby refid="table__identifier_8h" local="yes">iceberg/table_identifier.h</includedby>
<includedby refid="json__serde__test_8cc" local="yes">iceberg/test/json_serde_test.cc</includedby>
<includedby refid="partition__field__test_8cc" local="yes">iceberg/test/partition_field_test.cc</includedby>
<includedby refid="partition__spec__test_8cc" local="yes">iceberg/test/partition_spec_test.cc</includedby>
<includedby refid="schema__field__test_8cc" local="yes">iceberg/test/schema_field_test.cc</includedby>
<includedby refid="schema__test_8cc" local="yes">iceberg/test/schema_test.cc</includedby>
<includedby refid="sort__field__test_8cc" local="yes">iceberg/test/sort_field_test.cc</includedby>
<includedby refid="sort__order__test_8cc" local="yes">iceberg/test/sort_order_test.cc</includedby>
<includedby refid="transform__test_8cc" local="yes">iceberg/test/transform_test.cc</includedby>
<includedby refid="type__test_8cc" local="yes">iceberg/test/type_test.cc</includedby>
<includedby refid="type_8cc" local="yes">iceberg/type.cc</includedby>
<includedby refid="formatter__internal_8h" local="yes">iceberg/util/formatter_internal.h</includedby>
<includedby refid="uuid_8cc" local="yes">iceberg/util/uuid.cc</includedby>
<incdepgraph>
<node id="7">
<label>iceberg/iceberg_export.h</label>
<link refid="iceberg__export_8h_source"/>
</node>
<node id="5">
<label>iceberg/util/formattable.h</label>
<link refid="formattable_8h"/>
<childnode refid="6" relation="include">
</childnode>
<childnode refid="7" relation="include">
</childnode>
</node>
<node id="1">
<label>iceberg/util/formatter.h</label>
<link refid="formatter_8h"/>
<childnode refid="2" relation="include">
</childnode>
<childnode refid="3" relation="include">
</childnode>
<childnode refid="4" relation="include">
</childnode>
<childnode refid="5" relation="include">
</childnode>
</node>
<node id="2">
<label>concepts</label>
</node>
<node id="3">
<label>format</label>
</node>
<node id="6">
<label>string</label>
</node>
<node id="4">
<label>string_view</label>
</node>
</incdepgraph>
<invincdepgraph>
<node id="3">
<label>iceberg/catalog.h</label>
<link refid="catalog_8h_source"/>
<childnode refid="4" relation="include">
</childnode>
<childnode refid="6" relation="include">
</childnode>
<childnode refid="7" relation="include">
</childnode>
</node>
<node id="4">
<label>iceberg/catalog/memory/in_memory_catalog.h</label>
<link refid="in__memory__catalog_8h_source"/>
<childnode refid="5" relation="include">
</childnode>
</node>
<node id="9">
<label>iceberg/catalog/rest/json_serde_internal.h</label>
<link refid="catalog_2rest_2json__serde__internal_8h"/>
</node>
<node id="6">
<label>iceberg/catalog/rest/rest_catalog.h</label>
<link refid="rest__catalog_8h"/>
</node>
<node id="8">
<label>iceberg/catalog/rest/types.h</label>
<link refid="types_8h"/>
<childnode refid="9" relation="include">
</childnode>
</node>
<node id="10">
<label>iceberg/table.h</label>
<link refid="table_8h_source"/>
<childnode refid="5" relation="include">
</childnode>
</node>
<node id="2">
<label>iceberg/table_identifier.h</label>
<link refid="table__identifier_8h"/>
<childnode refid="3" relation="include">
</childnode>
<childnode refid="8" relation="include">
</childnode>
<childnode refid="10" relation="include">
</childnode>
<childnode refid="5" relation="include">
</childnode>
</node>
<node id="7">
<label>iceberg/test/mock_catalog.h</label>
<link refid="mock__catalog_8h_source"/>
</node>
<node id="5">
<label>iceberg/test/update_test_base.h</label>
<link refid="update__test__base_8h_source"/>
</node>
<node id="1">
<label>iceberg/util/formatter.h</label>
<link refid="formatter_8h"/>
<childnode refid="2" relation="include">
</childnode>
<childnode refid="11" relation="include">
</childnode>
</node>
<node id="11">
<label>iceberg/util/formatter_internal.h</label>
<link refid="formatter__internal_8h_source"/>
</node>
</invincdepgraph>
<innerclass refid="structstd_1_1formatter_3_01Derived_01_4" prot="public">std::formatter&lt; Derived &gt;</innerclass>
<innerclass refid="structstd_1_1formatter_3_01T_01_4" prot="public">std::formatter&lt; T &gt;</innerclass>
<briefdescription>
</briefdescription>
<detaileddescription>
<para>A specialization of std::formatter for Formattable objects. This header is separate from <ref refid="formattable_8h" kindref="compound">iceberg/util/formattable.h</ref> so that the latter (which is meant to be included widely) does not leak &lt;format&gt; unnecessarily into other headers. You must include this header to format a Formattable. </para>
</detaileddescription>
<programlisting>
<codeline lineno="1"><highlight class="comment">/*</highlight></codeline>
<codeline lineno="2"><highlight class="comment"><sp/>*<sp/>Licensed<sp/>to<sp/>the<sp/>Apache<sp/>Software<sp/>Foundation<sp/>(ASF)<sp/>under<sp/>one</highlight></codeline>
<codeline lineno="3"><highlight class="comment"><sp/>*<sp/>or<sp/>more<sp/>contributor<sp/>license<sp/>agreements.<sp/><sp/>See<sp/>the<sp/>NOTICE<sp/>file</highlight></codeline>
<codeline lineno="4"><highlight class="comment"><sp/>*<sp/>distributed<sp/>with<sp/>this<sp/>work<sp/>for<sp/>additional<sp/>information</highlight></codeline>
<codeline lineno="5"><highlight class="comment"><sp/>*<sp/>regarding<sp/>copyright<sp/>ownership.<sp/><sp/>The<sp/>ASF<sp/>licenses<sp/>this<sp/>file</highlight></codeline>
<codeline lineno="6"><highlight class="comment"><sp/>*<sp/>to<sp/>you<sp/>under<sp/>the<sp/>Apache<sp/>License,<sp/>Version<sp/>2.0<sp/>(the</highlight></codeline>
<codeline lineno="7"><highlight class="comment"><sp/>*<sp/>&quot;License&quot;);<sp/>you<sp/>may<sp/>not<sp/>use<sp/>this<sp/>file<sp/>except<sp/>in<sp/>compliance</highlight></codeline>
<codeline lineno="8"><highlight class="comment"><sp/>*<sp/>with<sp/>the<sp/>License.<sp/><sp/>You<sp/>may<sp/>obtain<sp/>a<sp/>copy<sp/>of<sp/>the<sp/>License<sp/>at</highlight></codeline>
<codeline lineno="9"><highlight class="comment"><sp/>*</highlight></codeline>
<codeline lineno="10"><highlight class="comment"><sp/>*<sp/><sp/><sp/>http://www.apache.org/licenses/LICENSE-2.0</highlight></codeline>
<codeline lineno="11"><highlight class="comment"><sp/>*</highlight></codeline>
<codeline lineno="12"><highlight class="comment"><sp/>*<sp/>Unless<sp/>required<sp/>by<sp/>applicable<sp/>law<sp/>or<sp/>agreed<sp/>to<sp/>in<sp/>writing,</highlight></codeline>
<codeline lineno="13"><highlight class="comment"><sp/>*<sp/>software<sp/>distributed<sp/>under<sp/>the<sp/>License<sp/>is<sp/>distributed<sp/>on<sp/>an</highlight></codeline>
<codeline lineno="14"><highlight class="comment"><sp/>*<sp/>&quot;AS<sp/>IS&quot;<sp/>BASIS,<sp/>WITHOUT<sp/>WARRANTIES<sp/>OR<sp/>CONDITIONS<sp/>OF<sp/>ANY</highlight></codeline>
<codeline lineno="15"><highlight class="comment"><sp/>*<sp/>KIND,<sp/>either<sp/>express<sp/>or<sp/>implied.<sp/><sp/>See<sp/>the<sp/>License<sp/>for<sp/>the</highlight></codeline>
<codeline lineno="16"><highlight class="comment"><sp/>*<sp/>specific<sp/>language<sp/>governing<sp/>permissions<sp/>and<sp/>limitations</highlight></codeline>
<codeline lineno="17"><highlight class="comment"><sp/>*<sp/>under<sp/>the<sp/>License.</highlight></codeline>
<codeline lineno="18"><highlight class="comment"><sp/>*/</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="19"><highlight class="normal"></highlight></codeline>
<codeline lineno="20"><highlight class="normal"></highlight><highlight class="preprocessor">#pragma<sp/>once</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="21"><highlight class="normal"></highlight></codeline>
<codeline lineno="27"><highlight class="normal"></highlight></codeline>
<codeline lineno="28"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;concepts&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="29"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;format&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="30"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;string_view&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="31"><highlight class="normal"></highlight></codeline>
<codeline lineno="32"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;<ref refid="formattable_8h" kindref="compound">iceberg/util/formattable.h</ref>&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="33"><highlight class="normal"></highlight></codeline>
<codeline lineno="36"><highlight class="keyword">template</highlight><highlight class="normal"><sp/>&lt;std::derived_from&lt;iceberg::util::Formattable&gt;<sp/>Derived&gt;</highlight></codeline>
<codeline lineno="37" refid="structstd_1_1formatter_3_01Derived_01_4" refkind="compound"><highlight class="normal"></highlight><highlight class="keyword">struct<sp/></highlight><highlight class="normal">std::formatter&lt;Derived&gt;<sp/>:<sp/>std::formatter&lt;std::string_view&gt;<sp/>{</highlight></codeline>
<codeline lineno="38"><highlight class="normal"><sp/><sp/></highlight><highlight class="keyword">template</highlight><highlight class="normal"><sp/>&lt;</highlight><highlight class="keyword">class</highlight><highlight class="normal"><sp/>FormatContext&gt;</highlight></codeline>
<codeline lineno="39"><highlight class="normal"><sp/><sp/></highlight><highlight class="keyword">auto</highlight><highlight class="normal"><sp/>format(</highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/><ref refid="classiceberg_1_1util_1_1Formattable" kindref="compound">iceberg::util::Formattable</ref>&amp;<sp/>obj,<sp/>FormatContext&amp;<sp/>ctx)</highlight><highlight class="keyword"><sp/>const<sp/></highlight><highlight class="normal">{</highlight></codeline>
<codeline lineno="40"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/>std::formatter&lt;string_view&gt;::format(obj.<ref refid="classiceberg_1_1util_1_1Formattable_1a79618aca5b3bf63610d9c87ac5ae0386" kindref="member">ToString</ref>(),<sp/>ctx);</highlight></codeline>
<codeline lineno="41"><highlight class="normal"><sp/><sp/>}</highlight></codeline>
<codeline lineno="42"><highlight class="normal">};</highlight></codeline>
<codeline lineno="43"><highlight class="normal"></highlight></codeline>
<codeline lineno="45"><highlight class="keyword">template</highlight><highlight class="normal"><sp/>&lt;</highlight><highlight class="keyword">typename</highlight><highlight class="normal"><sp/>T&gt;</highlight></codeline>
<codeline lineno="46"><highlight class="normal"><sp/><sp/></highlight><highlight class="keyword">requires</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">requires</highlight><highlight class="normal">(</highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>T&amp;<sp/>t)<sp/>{</highlight></codeline>
<codeline lineno="47"><highlight class="normal"><sp/><sp/><sp/><sp/>{<sp/>ToString(t)<sp/>}<sp/>-&gt;<sp/>std::convertible_to&lt;std::string_view&gt;;</highlight></codeline>
<codeline lineno="48"><highlight class="normal"><sp/><sp/>}</highlight></codeline>
<codeline lineno="49" refid="structstd_1_1formatter_3_01T_01_4" refkind="compound"><highlight class="normal"></highlight><highlight class="keyword">struct<sp/></highlight><highlight class="normal">std::formatter&lt;T&gt;<sp/>:<sp/>std::formatter&lt;std::string_view&gt;<sp/>{</highlight></codeline>
<codeline lineno="50"><highlight class="normal"><sp/><sp/></highlight><highlight class="keyword">template</highlight><highlight class="normal"><sp/>&lt;</highlight><highlight class="keyword">class</highlight><highlight class="normal"><sp/>FormatContext&gt;</highlight></codeline>
<codeline lineno="51"><highlight class="normal"><sp/><sp/></highlight><highlight class="keyword">auto</highlight><highlight class="normal"><sp/>format(</highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>T&amp;<sp/>value,<sp/>FormatContext&amp;<sp/>ctx)</highlight><highlight class="keyword"><sp/>const<sp/></highlight><highlight class="normal">{</highlight></codeline>
<codeline lineno="52"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/>std::formatter&lt;std::string_view&gt;::format(ToString(value),<sp/>ctx);</highlight></codeline>
<codeline lineno="53"><highlight class="normal"><sp/><sp/>}</highlight></codeline>
<codeline lineno="54"><highlight class="normal">};</highlight></codeline>
</programlisting>
<location file="iceberg/util/formatter.h"/>
</compounddef>
</doxygen>