| <!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::ErrorCollector 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&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&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"><a class="el" href="classiceberg_1_1ErrorCollector.html">ErrorCollector</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pro-attribs">Protected Attributes</a> | |
| <a href="classiceberg_1_1ErrorCollector-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">iceberg::ErrorCollector Class Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Base class for collecting errors in the builder pattern. |
| <a href="classiceberg_1_1ErrorCollector.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="error__collector_8h_source.html">error_collector.h</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for iceberg::ErrorCollector:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classiceberg_1_1ErrorCollector.png" usemap="#iceberg::ErrorCollector_map" alt=""/> |
| <map id="iceberg::ErrorCollector_map" name="iceberg::ErrorCollector_map"> |
| <area href="classiceberg_1_1ManifestGroup.html" title="Coordinates reading manifest files and producing scan tasks." alt="iceberg::ManifestGroup" shape="rect" coords="0,56,242,80"/> |
| <area href="classiceberg_1_1PendingUpdate.html" title="Base class for all kinds of table metadata updates." alt="iceberg::PendingUpdate" shape="rect" coords="252,56,494,80"/> |
| <area href="classiceberg_1_1SnapshotManager.html" title="API for managing snapshots." alt="iceberg::SnapshotManager" shape="rect" coords="504,56,746,80"/> |
| <area href="classiceberg_1_1TableMetadataBuilder.html" title="Builder class for constructing TableMetadata objects." alt="iceberg::TableMetadataBuilder" shape="rect" coords="756,56,998,80"/> |
| <area href="classiceberg_1_1TableScanBuilder.html" title="Builder class for creating TableScan instances." alt="iceberg::TableScanBuilder< ScanType >" shape="rect" coords="1008,56,1250,80"/> |
| <area href="classiceberg_1_1ExpireSnapshots.html" title="API for removing old snapshots from a table." alt="iceberg::ExpireSnapshots" shape="rect" coords="504,112,746,136"/> |
| <area href="classiceberg_1_1SetSnapshot.html" title="Sets the current snapshot directly or by rolling back." alt="iceberg::SetSnapshot" shape="rect" coords="504,168,746,192"/> |
| <area href="classiceberg_1_1SnapshotUpdate.html" title="Base class for operations that produce snapshots." alt="iceberg::SnapshotUpdate" shape="rect" coords="504,224,746,248"/> |
| <area href="classiceberg_1_1UpdateLocation.html" title="Updating table location with a new base location." alt="iceberg::UpdateLocation" shape="rect" coords="504,280,746,304"/> |
| <area href="classiceberg_1_1UpdatePartitionSpec.html" title="API for partition spec evolution." alt="iceberg::UpdatePartitionSpec" shape="rect" coords="504,336,746,360"/> |
| <area href="classiceberg_1_1UpdatePartitionStatistics.html" title="Updates table partition statistics." alt="iceberg::UpdatePartitionStatistics" shape="rect" coords="504,392,746,416"/> |
| <area href="classiceberg_1_1UpdateProperties.html" title="Updates table properties." alt="iceberg::UpdateProperties" shape="rect" coords="504,448,746,472"/> |
| <area href="classiceberg_1_1UpdateSchema.html" title="API for schema evolution." alt="iceberg::UpdateSchema" shape="rect" coords="504,504,746,528"/> |
| <area href="classiceberg_1_1UpdateSnapshotReference.html" title="Updates snapshot references." alt="iceberg::UpdateSnapshotReference" shape="rect" coords="504,560,746,584"/> |
| <area href="classiceberg_1_1UpdateSortOrder.html" title="Updating table sort order with a newly created order." alt="iceberg::UpdateSortOrder" shape="rect" coords="504,616,746,640"/> |
| <area href="classiceberg_1_1UpdateStatistics.html" title="Updates table statistics." alt="iceberg::UpdateStatistics" shape="rect" coords="504,672,746,696"/> |
| </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:a827c296a8527f87f76d7f9321e7ee68f" id="r_a827c296a8527f87f76d7f9321e7ee68f"><td class="memItemLeft" align="right" valign="top"><a id="a827c296a8527f87f76d7f9321e7ee68f" name="a827c296a8527f87f76d7f9321e7ee68f"></a> |
|  </td><td class="memItemRight" valign="bottom"><b>ErrorCollector</b> (<a class="el" href="classiceberg_1_1ErrorCollector.html">ErrorCollector</a> &&)=default</td></tr> |
| <tr class="separator:a827c296a8527f87f76d7f9321e7ee68f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a22311658715152d8e6e27834240ce446" id="r_a22311658715152d8e6e27834240ce446"><td class="memItemLeft" align="right" valign="top"><a id="a22311658715152d8e6e27834240ce446" name="a22311658715152d8e6e27834240ce446"></a> |
| <a class="el" href="classiceberg_1_1ErrorCollector.html">ErrorCollector</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classiceberg_1_1ErrorCollector.html">ErrorCollector</a> &&)=default</td></tr> |
| <tr class="separator:a22311658715152d8e6e27834240ce446"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab3fa546cd2748fe418db9c0933542755" id="r_ab3fa546cd2748fe418db9c0933542755"><td class="memItemLeft" align="right" valign="top"><a id="ab3fa546cd2748fe418db9c0933542755" name="ab3fa546cd2748fe418db9c0933542755"></a> |
|  </td><td class="memItemRight" valign="bottom"><b>ErrorCollector</b> (const <a class="el" href="classiceberg_1_1ErrorCollector.html">ErrorCollector</a> &)=default</td></tr> |
| <tr class="separator:ab3fa546cd2748fe418db9c0933542755"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aaba366560be481bfa9538735f3a38e3e" id="r_aaba366560be481bfa9538735f3a38e3e"><td class="memItemLeft" align="right" valign="top"><a id="aaba366560be481bfa9538735f3a38e3e" name="aaba366560be481bfa9538735f3a38e3e"></a> |
| <a class="el" href="classiceberg_1_1ErrorCollector.html">ErrorCollector</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classiceberg_1_1ErrorCollector.html">ErrorCollector</a> &)=default</td></tr> |
| <tr class="separator:aaba366560be481bfa9538735f3a38e3e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3a20345150b136c918ffe8947a7d75e1" id="r_a3a20345150b136c918ffe8947a7d75e1"><td class="memTemplParams" colspan="2">template<typename... Args> </td></tr> |
| <tr class="memitem:a3a20345150b136c918ffe8947a7d75e1"><td class="memTemplItemLeft" align="right" valign="top">auto & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classiceberg_1_1ErrorCollector.html#a3a20345150b136c918ffe8947a7d75e1">AddError</a> (this auto &self, ErrorKind kind, const std::format_string< Args... > fmt, Args &&... args)</td></tr> |
| <tr class="memdesc:a3a20345150b136c918ffe8947a7d75e1"><td class="mdescLeft"> </td><td class="mdescRight">Add a specific error and return reference to derived class. <br /></td></tr> |
| <tr class="separator:a3a20345150b136c918ffe8947a7d75e1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5e555954de121d0908dcf4648da446e3" id="r_a5e555954de121d0908dcf4648da446e3"><td class="memItemLeft" align="right" valign="top">auto & </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1ErrorCollector.html#a5e555954de121d0908dcf4648da446e3">AddError</a> (this auto &self, <a class="el" href="structiceberg_1_1Error.html">Error</a> err)</td></tr> |
| <tr class="memdesc:a5e555954de121d0908dcf4648da446e3"><td class="mdescLeft"> </td><td class="mdescRight">Add an existing error object and return reference to derived class. <br /></td></tr> |
| <tr class="separator:a5e555954de121d0908dcf4648da446e3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5749264a2234092a5246056a1c72ee51" id="r_a5749264a2234092a5246056a1c72ee51"><td class="memItemLeft" align="right" valign="top">auto & </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1ErrorCollector.html#a5749264a2234092a5246056a1c72ee51">AddError</a> (this auto &self, std::unexpected< <a class="el" href="structiceberg_1_1Error.html">Error</a> > err)</td></tr> |
| <tr class="memdesc:a5749264a2234092a5246056a1c72ee51"><td class="mdescLeft"> </td><td class="mdescRight">Add an unexpected result's error and return reference to derived class. <br /></td></tr> |
| <tr class="separator:a5749264a2234092a5246056a1c72ee51"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8813b3fe2a3cc112e6db19c87b8422ae" id="r_a8813b3fe2a3cc112e6db19c87b8422ae"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1ErrorCollector.html#a8813b3fe2a3cc112e6db19c87b8422ae">has_errors</a> () const</td></tr> |
| <tr class="memdesc:a8813b3fe2a3cc112e6db19c87b8422ae"><td class="mdescLeft"> </td><td class="mdescRight">Check if any errors have been collected. <br /></td></tr> |
| <tr class="separator:a8813b3fe2a3cc112e6db19c87b8422ae"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afae10739a78bbffc2609a63e52821195" id="r_afae10739a78bbffc2609a63e52821195"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1ErrorCollector.html#afae10739a78bbffc2609a63e52821195">error_count</a> () const</td></tr> |
| <tr class="memdesc:afae10739a78bbffc2609a63e52821195"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of errors collected. <br /></td></tr> |
| <tr class="separator:afae10739a78bbffc2609a63e52821195"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a16cbe7b6d423a372c9e68d970ff2c3ea" id="r_a16cbe7b6d423a372c9e68d970ff2c3ea"><td class="memItemLeft" align="right" valign="top">Status </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1ErrorCollector.html#a16cbe7b6d423a372c9e68d970ff2c3ea">CheckErrors</a> () const</td></tr> |
| <tr class="memdesc:a16cbe7b6d423a372c9e68d970ff2c3ea"><td class="mdescLeft"> </td><td class="mdescRight">Check for accumulated errors and return them if any exist. <br /></td></tr> |
| <tr class="separator:a16cbe7b6d423a372c9e68d970ff2c3ea"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a274df2b90b0c22156a4c339aa30a4401" id="r_a274df2b90b0c22156a4c339aa30a4401"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1ErrorCollector.html#a274df2b90b0c22156a4c339aa30a4401">ClearErrors</a> ()</td></tr> |
| <tr class="memdesc:a274df2b90b0c22156a4c339aa30a4401"><td class="mdescLeft"> </td><td class="mdescRight">Clear all accumulated errors. <br /></td></tr> |
| <tr class="separator:a274df2b90b0c22156a4c339aa30a4401"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a101fb70f2ad50a6023de932dc2eca96c" id="r_a101fb70f2ad50a6023de932dc2eca96c"><td class="memItemLeft" align="right" valign="top"><a id="a101fb70f2ad50a6023de932dc2eca96c" name="a101fb70f2ad50a6023de932dc2eca96c"></a> |
| const std::vector< <a class="el" href="structiceberg_1_1Error.html">Error</a> > & </td><td class="memItemRight" valign="bottom"><b>errors</b> () const</td></tr> |
| <tr class="memdesc:a101fb70f2ad50a6023de932dc2eca96c"><td class="mdescLeft"> </td><td class="mdescRight">Get read-only access to all collected errors. <br /></td></tr> |
| <tr class="separator:a101fb70f2ad50a6023de932dc2eca96c"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a> |
| Protected Attributes</h2></td></tr> |
| <tr class="memitem:a354d1e7287bb45926a4b563f80d0c623" id="r_a354d1e7287bb45926a4b563f80d0c623"><td class="memItemLeft" align="right" valign="top"><a id="a354d1e7287bb45926a4b563f80d0c623" name="a354d1e7287bb45926a4b563f80d0c623"></a> |
| std::vector< <a class="el" href="structiceberg_1_1Error.html">Error</a> > </td><td class="memItemRight" valign="bottom"><b>errors_</b></td></tr> |
| <tr class="separator:a354d1e7287bb45926a4b563f80d0c623"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Base class for collecting errors in the builder pattern. </p> |
| <p>This class equips builders with error accumulation capabilities to make it easy for method chaining. Builder methods should call <a class="el" href="classiceberg_1_1ErrorCollector.html#a3a20345150b136c918ffe8947a7d75e1" title="Add a specific error and return reference to derived class.">AddError()</a> to accumulate errors and call <a class="el" href="classiceberg_1_1ErrorCollector.html#a16cbe7b6d423a372c9e68d970ff2c3ea" title="Check for accumulated errors and return them if any exist.">CheckErrors()</a> before completing the build process.</p> |
| <p>Example usage: </p><div class="fragment"><div class="line"><span class="keyword">class </span>MyBuilder : <span class="keyword">public</span> <a class="code hl_class" href="classiceberg_1_1ErrorCollector.html">ErrorCollector</a> {</div> |
| <div class="line"> <span class="keyword">public</span>:</div> |
| <div class="line"> MyBuilder& SetValue(<span class="keywordtype">int</span> val) {</div> |
| <div class="line"> <span class="keywordflow">if</span> (val < 0) {</div> |
| <div class="line"> <span class="keywordflow">return</span> AddError(ErrorKind::kInvalidArgument, <span class="stringliteral">"Value must be non-negative"</span>);</div> |
| <div class="line"> }</div> |
| <div class="line"> value_ = val;</div> |
| <div class="line"> <span class="keywordflow">return</span> *<span class="keyword">this</span>;</div> |
| <div class="line"> }</div> |
| <div class="line"> </div> |
| <div class="line"> Result<MyObject> Build() {</div> |
| <div class="line"> ICEBERG_RETURN_UNEXPECTED(CheckErrors());</div> |
| <div class="line"> <span class="keywordflow">return</span> MyObject{value_};</div> |
| <div class="line"> }</div> |
| <div class="line"> </div> |
| <div class="line"> <span class="keyword">private</span>:</div> |
| <div class="line"> <span class="keywordtype">int</span> value_ = 0;</div> |
| <div class="line">};</div> |
| <div class="ttc" id="aclassiceberg_1_1ErrorCollector_html"><div class="ttname"><a href="classiceberg_1_1ErrorCollector.html">iceberg::ErrorCollector</a></div><div class="ttdoc">Base class for collecting errors in the builder pattern.</div><div class="ttdef"><b>Definition</b> error_collector.h:93</div></div> |
| </div><!-- fragment --> </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a5e555954de121d0908dcf4648da446e3" name="a5e555954de121d0908dcf4648da446e3"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5e555954de121d0908dcf4648da446e3">◆ </a></span>AddError() <span class="overload">[1/3]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">auto & iceberg::ErrorCollector::AddError </td> |
| <td>(</td> |
| <td class="paramtype">this auto & </td> |
| <td class="paramname"><em>self</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="structiceberg_1_1Error.html">Error</a> </td> |
| <td class="paramname"><em>err</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</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>Add an existing error object and return reference to derived class. </p> |
| <p>Useful when propagating errors from other components or reusing error objects without deconstructing and reconstructing them.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">self</td><td>Deduced reference to the derived class instance </td></tr> |
| <tr><td class="paramname">err</td><td>The error to add </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="classiceberg_1_1Reference.html" title="A reference represents a named field in an expression.">Reference</a> to the derived class for method chaining </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a3a20345150b136c918ffe8947a7d75e1" name="a3a20345150b136c918ffe8947a7d75e1"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3a20345150b136c918ffe8947a7d75e1">◆ </a></span>AddError() <span class="overload">[2/3]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename... Args> </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">auto & iceberg::ErrorCollector::AddError </td> |
| <td>(</td> |
| <td class="paramtype">this auto & </td> |
| <td class="paramname"><em>self</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">ErrorKind </td> |
| <td class="paramname"><em>kind</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::format_string< Args... > </td> |
| <td class="paramname"><em>fmt</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">Args &&... </td> |
| <td class="paramname"><em>args</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</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>Add a specific error and return reference to derived class. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">self</td><td>Deduced reference to the derived class instance </td></tr> |
| <tr><td class="paramname">kind</td><td>The kind of error </td></tr> |
| <tr><td class="paramname">fmt</td><td>The format string </td></tr> |
| <tr><td class="paramname">args</td><td>The arguments to format the message </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="classiceberg_1_1Reference.html" title="A reference represents a named field in an expression.">Reference</a> to the derived class for method chaining </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a5749264a2234092a5246056a1c72ee51" name="a5749264a2234092a5246056a1c72ee51"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5749264a2234092a5246056a1c72ee51">◆ </a></span>AddError() <span class="overload">[3/3]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">auto & iceberg::ErrorCollector::AddError </td> |
| <td>(</td> |
| <td class="paramtype">this auto & </td> |
| <td class="paramname"><em>self</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::unexpected< <a class="el" href="structiceberg_1_1Error.html">Error</a> > </td> |
| <td class="paramname"><em>err</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</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>Add an unexpected result's error and return reference to derived class. </p> |
| <p>Useful for cases like below: </p><div class="fragment"><div class="line"><span class="keywordflow">return</span> <a class="code hl_function" href="classiceberg_1_1ErrorCollector.html#a3a20345150b136c918ffe8947a7d75e1">AddError</a>(InvalidArgument(<span class="stringliteral">"Invalid value: {}"</span>, value));</div> |
| <div class="ttc" id="aclassiceberg_1_1ErrorCollector_html_a3a20345150b136c918ffe8947a7d75e1"><div class="ttname"><a href="classiceberg_1_1ErrorCollector.html#a3a20345150b136c918ffe8947a7d75e1">iceberg::ErrorCollector::AddError</a></div><div class="ttdeci">auto & AddError(this auto &self, ErrorKind kind, const std::format_string< Args... > fmt, Args &&... args)</div><div class="ttdoc">Add a specific error and return reference to derived class.</div><div class="ttdef"><b>Definition</b> error_collector.h:112</div></div> |
| </div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">self</td><td>Deduced reference to the derived class instance </td></tr> |
| <tr><td class="paramname">err</td><td>The unexpected result containing the error to add </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="classiceberg_1_1Reference.html" title="A reference represents a named field in an expression.">Reference</a> to the derived class for method chaining </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a16cbe7b6d423a372c9e68d970ff2c3ea" name="a16cbe7b6d423a372c9e68d970ff2c3ea"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a16cbe7b6d423a372c9e68d970ff2c3ea">◆ </a></span>CheckErrors()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Status iceberg::ErrorCollector::CheckErrors </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>Check for accumulated errors and return them if any exist. </p> |
| <p>This should be called before completing a builder operation (e.g., in Build(), Apply(), or Commit() methods) to validate that no errors were accumulated during the builder method calls.</p> |
| <dl class="section return"><dt>Returns</dt><dd>Status indicating success if no errors, or a ValidationFailed error with all accumulated error messages </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a274df2b90b0c22156a4c339aa30a4401" name="a274df2b90b0c22156a4c339aa30a4401"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a274df2b90b0c22156a4c339aa30a4401">◆ </a></span>ClearErrors()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void iceberg::ErrorCollector::ClearErrors </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>Clear all accumulated errors. </p> |
| <p>This can be useful for resetting the error state in tests or when reusing a builder instance. </p> |
| |
| </div> |
| </div> |
| <a id="afae10739a78bbffc2609a63e52821195" name="afae10739a78bbffc2609a63e52821195"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#afae10739a78bbffc2609a63e52821195">◆ </a></span>error_count()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">size_t iceberg::ErrorCollector::error_count </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>Get the number of errors collected. </p> |
| <dl class="section return"><dt>Returns</dt><dd>The count of accumulated errors </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a8813b3fe2a3cc112e6db19c87b8422ae" name="a8813b3fe2a3cc112e6db19c87b8422ae"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8813b3fe2a3cc112e6db19c87b8422ae">◆ </a></span>has_errors()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool iceberg::ErrorCollector::has_errors </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>Check if any errors have been collected. </p> |
| <dl class="section return"><dt>Returns</dt><dd>true if there are accumulated errors </dd></dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>iceberg/util/<a class="el" href="error__collector_8h_source.html">error_collector.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by <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> |