Google Git
Sign in
apache/incubator-graphar-website/refs/heads/asf-site/./docs/cpp/classgraphar_1_1_status.html
blob: 8818a8029dd4dfa28541429447861d5c7772c533 [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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Apache GraphAr C++ Library: graphar::Status 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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Apache GraphAr C++ Library
</div>
<div id="projectbrief">The C++ Library for Apache GraphAr</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>graphar</b></li><li class="navelem"><a class="el" href="classgraphar_1_1_status.html">Status</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classgraphar_1_1_status-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">graphar::Status Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classgraphar_1_1_status.html" title="Status outcome object (success or error)">Status</a> outcome object (success or error)
<a href="classgraphar_1_1_status.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="status_8h_source.html">status.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a0a860f829759c387e55e5d72e2253e36"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgraphar_1_1_status.html#a0a860f829759c387e55e5d72e2253e36">Status</a> () noexcept</td></tr>
<tr class="separator:a0a860f829759c387e55e5d72e2253e36"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1a1973d36a87952ccbbb2c09426d3076"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgraphar_1_1_status.html#a1a1973d36a87952ccbbb2c09426d3076">~Status</a> () noexcept</td></tr>
<tr class="separator:a1a1973d36a87952ccbbb2c09426d3076"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a003d78f26f5cbad3615e2ee5944b76bb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgraphar_1_1_status.html#a003d78f26f5cbad3615e2ee5944b76bb">Status</a> (StatusCode <a class="el" href="classgraphar_1_1_status.html#ad8afab2740385545877fc6bba2c34636">code</a>, const std::string &amp;msg)</td></tr>
<tr class="memdesc:a003d78f26f5cbad3615e2ee5944b76bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a status with the specified error code and message. <a href="classgraphar_1_1_status.html#a003d78f26f5cbad3615e2ee5944b76bb">More...</a><br /></td></tr>
<tr class="separator:a003d78f26f5cbad3615e2ee5944b76bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad2e06c777504a46a8d4dd959aa46f106"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgraphar_1_1_status.html#ad2e06c777504a46a8d4dd959aa46f106">Status</a> (const <a class="el" href="classgraphar_1_1_status.html">Status</a> &amp;s)</td></tr>
<tr class="separator:ad2e06c777504a46a8d4dd959aa46f106"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adb3d43ca307b4d68ba517de8025b6856"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgraphar_1_1_status.html#adb3d43ca307b4d68ba517de8025b6856">Status</a> (<a class="el" href="classgraphar_1_1_status.html">Status</a> &amp;&amp;s) noexcept</td></tr>
<tr class="separator:adb3d43ca307b4d68ba517de8025b6856"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2a5b813b0a187fcf753a9e14836bc966"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgraphar_1_1_status.html">Status</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgraphar_1_1_status.html#a2a5b813b0a187fcf753a9e14836bc966">operator=</a> (<a class="el" href="classgraphar_1_1_status.html">Status</a> &amp;&amp;s) noexcept</td></tr>
<tr class="separator:a2a5b813b0a187fcf753a9e14836bc966"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a401ecb877b8439e3006552f46869e6f0"><td class="memItemLeft" align="right" valign="top">constexpr bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgraphar_1_1_status.html#a401ecb877b8439e3006552f46869e6f0">ok</a> () const</td></tr>
<tr class="separator:a401ecb877b8439e3006552f46869e6f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5722c85539ba45817a7f7d57d511bb7c"><td class="memItemLeft" align="right" valign="top">constexpr bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgraphar_1_1_status.html#a5722c85539ba45817a7f7d57d511bb7c">IsKeyError</a> () const</td></tr>
<tr class="separator:a5722c85539ba45817a7f7d57d511bb7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5655e90a1f657d7e5a12b5217a7eee25"><td class="memItemLeft" align="right" valign="top">constexpr bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgraphar_1_1_status.html#a5655e90a1f657d7e5a12b5217a7eee25">IsTypeError</a> () const</td></tr>
<tr class="separator:a5655e90a1f657d7e5a12b5217a7eee25"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a91714dda07e087535605998d815d9240"><td class="memItemLeft" align="right" valign="top">constexpr bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgraphar_1_1_status.html#a91714dda07e087535605998d815d9240">IsInvalid</a> () const</td></tr>
<tr class="separator:a91714dda07e087535605998d815d9240"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad0d090660a9e71c3e19b3c1739b98f68"><td class="memItemLeft" align="right" valign="top">constexpr bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgraphar_1_1_status.html#ad0d090660a9e71c3e19b3c1739b98f68">IsIndexError</a> () const</td></tr>
<tr class="separator:ad0d090660a9e71c3e19b3c1739b98f68"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa42e3449fecbebb29bff9e59bb83fcce"><td class="memItemLeft" align="right" valign="top">constexpr bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgraphar_1_1_status.html#aa42e3449fecbebb29bff9e59bb83fcce">IsYamlError</a> () const</td></tr>
<tr class="separator:aa42e3449fecbebb29bff9e59bb83fcce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7faef0c9213acb06dd3e249a8d75f43d"><td class="memItemLeft" align="right" valign="top">constexpr bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgraphar_1_1_status.html#a7faef0c9213acb06dd3e249a8d75f43d">IsArrowError</a> () const</td></tr>
<tr class="separator:a7faef0c9213acb06dd3e249a8d75f43d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad8afab2740385545877fc6bba2c34636"><td class="memItemLeft" align="right" valign="top">constexpr StatusCode&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgraphar_1_1_status.html#ad8afab2740385545877fc6bba2c34636">code</a> () const</td></tr>
<tr class="separator:ad8afab2740385545877fc6bba2c34636"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a11279464d73e7362db85e08935546022"><td class="memItemLeft" align="right" valign="top">const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgraphar_1_1_status.html#a11279464d73e7362db85e08935546022">message</a> () const</td></tr>
<tr class="separator:a11279464d73e7362db85e08935546022"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:ad92f5c41a661d4f468390e39da90f881"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classgraphar_1_1_status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgraphar_1_1_status.html#ad92f5c41a661d4f468390e39da90f881">OK</a> ()</td></tr>
<tr class="separator:ad92f5c41a661d4f468390e39da90f881"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5441389439e388b4b625df09385bdb3d"><td class="memTemplParams" colspan="2"><a id="a5441389439e388b4b625df09385bdb3d"></a>
template&lt;typename... Args&gt; </td></tr>
<tr class="memitem:a5441389439e388b4b625df09385bdb3d"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="classgraphar_1_1_status.html">Status</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><b>FromArgs</b> (StatusCode <a class="el" href="classgraphar_1_1_status.html#ad8afab2740385545877fc6bba2c34636">code</a>, Args... args)</td></tr>
<tr class="separator:a5441389439e388b4b625df09385bdb3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af74806ef2e707acc99abc8997361f1e5"><td class="memTemplParams" colspan="2">template&lt;typename... Args&gt; </td></tr>
<tr class="memitem:af74806ef2e707acc99abc8997361f1e5"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="classgraphar_1_1_status.html">Status</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgraphar_1_1_status.html#af74806ef2e707acc99abc8997361f1e5">IOError</a> (Args &amp;&amp;... args)</td></tr>
<tr class="separator:af74806ef2e707acc99abc8997361f1e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4ee4924ddadfc2c1effc055572084d71"><td class="memTemplParams" colspan="2">template&lt;typename... Args&gt; </td></tr>
<tr class="memitem:a4ee4924ddadfc2c1effc055572084d71"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="classgraphar_1_1_status.html">Status</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgraphar_1_1_status.html#a4ee4924ddadfc2c1effc055572084d71">KeyError</a> (Args &amp;&amp;... args)</td></tr>
<tr class="separator:a4ee4924ddadfc2c1effc055572084d71"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3335cf4bf5cd222d5e29b01fe95e919a"><td class="memTemplParams" colspan="2">template&lt;typename... Args&gt; </td></tr>
<tr class="memitem:a3335cf4bf5cd222d5e29b01fe95e919a"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="classgraphar_1_1_status.html">Status</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgraphar_1_1_status.html#a3335cf4bf5cd222d5e29b01fe95e919a">TypeError</a> (Args &amp;&amp;... args)</td></tr>
<tr class="separator:a3335cf4bf5cd222d5e29b01fe95e919a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ca4be37aae8dfea7e6ef54920e0073f"><td class="memTemplParams" colspan="2">template&lt;typename... Args&gt; </td></tr>
<tr class="memitem:a9ca4be37aae8dfea7e6ef54920e0073f"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="classgraphar_1_1_status.html">Status</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgraphar_1_1_status.html#a9ca4be37aae8dfea7e6ef54920e0073f">Invalid</a> (Args &amp;&amp;... args)</td></tr>
<tr class="separator:a9ca4be37aae8dfea7e6ef54920e0073f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1f9b2120c7a6b3e66f9f2e31021df67f"><td class="memTemplParams" colspan="2">template&lt;typename... Args&gt; </td></tr>
<tr class="memitem:a1f9b2120c7a6b3e66f9f2e31021df67f"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="classgraphar_1_1_status.html">Status</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgraphar_1_1_status.html#a1f9b2120c7a6b3e66f9f2e31021df67f">IndexError</a> (Args &amp;&amp;... args)</td></tr>
<tr class="separator:a1f9b2120c7a6b3e66f9f2e31021df67f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a358b23c7f34efbf14c84cbc2ddbdd6a4"><td class="memTemplParams" colspan="2">template&lt;typename... Args&gt; </td></tr>
<tr class="memitem:a358b23c7f34efbf14c84cbc2ddbdd6a4"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="classgraphar_1_1_status.html">Status</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgraphar_1_1_status.html#a358b23c7f34efbf14c84cbc2ddbdd6a4">YamlError</a> (Args &amp;&amp;... args)</td></tr>
<tr class="separator:a358b23c7f34efbf14c84cbc2ddbdd6a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a521553014a9f2a6d44f5d71a91a3cb72"><td class="memTemplParams" colspan="2">template&lt;typename... Args&gt; </td></tr>
<tr class="memitem:a521553014a9f2a6d44f5d71a91a3cb72"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="classgraphar_1_1_status.html">Status</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgraphar_1_1_status.html#a521553014a9f2a6d44f5d71a91a3cb72">ArrowError</a> (Args &amp;&amp;... args)</td></tr>
<tr class="separator:a521553014a9f2a6d44f5d71a91a3cb72"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a45918d3b4f77af5a794fd8f2245ab2"><td class="memTemplParams" colspan="2">template&lt;typename... Args&gt; </td></tr>
<tr class="memitem:a4a45918d3b4f77af5a794fd8f2245ab2"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="classgraphar_1_1_status.html">Status</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgraphar_1_1_status.html#a4a45918d3b4f77af5a794fd8f2245ab2">UnknownError</a> (Args &amp;&amp;... args)</td></tr>
<tr class="separator:a4a45918d3b4f77af5a794fd8f2245ab2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classgraphar_1_1_status.html" title="Status outcome object (success or error)">Status</a> outcome object (success or error) </p>
<p>The <a class="el" href="classgraphar_1_1_status.html" title="Status outcome object (success or error)">Status</a> object is an object holding the outcome of an operation. The outcome is represented as a StatusCode, either success (StatusCode::OK) or an error (any other of the StatusCode enumeration values).</p>
<p>Additionally, if an error occurred, a specific error message is generally attached. </p>
<p class="definition">Definition at line <a class="el" href="status_8h_source.html#l00123">123</a> of file <a class="el" href="status_8h_source.html">status.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a0a860f829759c387e55e5d72e2253e36"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0a860f829759c387e55e5d72e2253e36">&#9670;&nbsp;</a></span>Status() <span class="overload">[1/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">graphar::Status::Status </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">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a success status. </p>
<p class="definition">Definition at line <a class="el" href="status_8h_source.html#l00126">126</a> of file <a class="el" href="status_8h_source.html">status.h</a>.</p>
</div>
</div>
<a id="a1a1973d36a87952ccbbb2c09426d3076"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1a1973d36a87952ccbbb2c09426d3076">&#9670;&nbsp;</a></span>~Status()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">graphar::Status::~Status </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">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
<p class="definition">Definition at line <a class="el" href="status_8h_source.html#l00128">128</a> of file <a class="el" href="status_8h_source.html">status.h</a>.</p>
</div>
</div>
<a id="a003d78f26f5cbad3615e2ee5944b76bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a003d78f26f5cbad3615e2ee5944b76bb">&#9670;&nbsp;</a></span>Status() <span class="overload">[2/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">graphar::Status::Status </td>
<td>(</td>
<td class="paramtype">StatusCode&#160;</td>
<td class="paramname"><em>code</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>msg</em>&#160;</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>Constructs a status with the specified error code and message. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">code</td><td>The error code of the status. </td></tr>
<tr><td class="paramname">msg</td><td>The error message of the status. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="status_8h_source.html#l00138">138</a> of file <a class="el" href="status_8h_source.html">status.h</a>.</p>
</div>
</div>
<a id="ad2e06c777504a46a8d4dd959aa46f106"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad2e06c777504a46a8d4dd959aa46f106">&#9670;&nbsp;</a></span>Status() <span class="overload">[3/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">graphar::Status::Status </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgraphar_1_1_status.html">Status</a> &amp;&#160;</td>
<td class="paramname"><em>s</em></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>Copy the specified status. </p>
<p class="definition">Definition at line <a class="el" href="status_8h_source.html#l00144">144</a> of file <a class="el" href="status_8h_source.html">status.h</a>.</p>
</div>
</div>
<a id="adb3d43ca307b4d68ba517de8025b6856"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adb3d43ca307b4d68ba517de8025b6856">&#9670;&nbsp;</a></span>Status() <span class="overload">[4/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">graphar::Status::Status </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgraphar_1_1_status.html">Status</a> &amp;&amp;&#160;</td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Move the specified status. </p>
<p class="definition">Definition at line <a class="el" href="status_8h_source.html#l00147">147</a> of file <a class="el" href="status_8h_source.html">status.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a521553014a9f2a6d44f5d71a91a3cb72"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a521553014a9f2a6d44f5d71a91a3cb72">&#9670;&nbsp;</a></span>ArrowError()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename... Args&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classgraphar_1_1_status.html">Status</a> graphar::Status::ArrowError </td>
<td>(</td>
<td class="paramtype">Args &amp;&amp;...&#160;</td>
<td class="paramname"><em>args</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return an error status when some arrow-related operation failed. </p>
<p class="definition">Definition at line <a class="el" href="status_8h_source.html#l00211">211</a> of file <a class="el" href="status_8h_source.html">status.h</a>.</p>
</div>
</div>
<a id="ad8afab2740385545877fc6bba2c34636"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad8afab2740385545877fc6bba2c34636">&#9670;&nbsp;</a></span>code()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr StatusCode graphar::Status::code </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">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the StatusCode value attached to this status. </p>
<p class="definition">Definition at line <a class="el" href="status_8h_source.html#l00248">248</a> of file <a class="el" href="status_8h_source.html">status.h</a>.</p>
</div>
</div>
<a id="a1f9b2120c7a6b3e66f9f2e31021df67f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1f9b2120c7a6b3e66f9f2e31021df67f">&#9670;&nbsp;</a></span>IndexError()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename... Args&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classgraphar_1_1_status.html">Status</a> graphar::Status::IndexError </td>
<td>(</td>
<td class="paramtype">Args &amp;&amp;...&#160;</td>
<td class="paramname"><em>args</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return an error status when an index is out of bounds. </p>
<p class="definition">Definition at line <a class="el" href="status_8h_source.html#l00197">197</a> of file <a class="el" href="status_8h_source.html">status.h</a>.</p>
</div>
</div>
<a id="a9ca4be37aae8dfea7e6ef54920e0073f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9ca4be37aae8dfea7e6ef54920e0073f">&#9670;&nbsp;</a></span>Invalid()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename... Args&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classgraphar_1_1_status.html">Status</a> graphar::Status::Invalid </td>
<td>(</td>
<td class="paramtype">Args &amp;&amp;...&#160;</td>
<td class="paramname"><em>args</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns an error status for invalid data (for example a string that fails parsing). </p>
<p class="definition">Definition at line <a class="el" href="status_8h_source.html#l00188">188</a> of file <a class="el" href="status_8h_source.html">status.h</a>.</p>
</div>
</div>
<a id="af74806ef2e707acc99abc8997361f1e5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af74806ef2e707acc99abc8997361f1e5">&#9670;&nbsp;</a></span>IOError()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename... Args&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classgraphar_1_1_status.html">Status</a> graphar::Status::IOError </td>
<td>(</td>
<td class="paramtype">Args &amp;&amp;...&#160;</td>
<td class="paramname"><em>args</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns an error status when some IO-related operation failed. </p>
<p class="definition">Definition at line <a class="el" href="status_8h_source.html#l00166">166</a> of file <a class="el" href="status_8h_source.html">status.h</a>.</p>
</div>
</div>
<a id="a7faef0c9213acb06dd3e249a8d75f43d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7faef0c9213acb06dd3e249a8d75f43d">&#9670;&nbsp;</a></span>IsArrowError()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr bool graphar::Status::IsArrowError </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">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return true iff the status indicates an arrow-related failure. </p>
<p class="definition">Definition at line <a class="el" href="status_8h_source.html#l00243">243</a> of file <a class="el" href="status_8h_source.html">status.h</a>.</p>
</div>
</div>
<a id="ad0d090660a9e71c3e19b3c1739b98f68"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad0d090660a9e71c3e19b3c1739b98f68">&#9670;&nbsp;</a></span>IsIndexError()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr bool graphar::Status::IsIndexError </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">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return true iff the status indicates an index out of bounds. </p>
<p class="definition">Definition at line <a class="el" href="status_8h_source.html#l00235">235</a> of file <a class="el" href="status_8h_source.html">status.h</a>.</p>
</div>
</div>
<a id="a91714dda07e087535605998d815d9240"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a91714dda07e087535605998d815d9240">&#9670;&nbsp;</a></span>IsInvalid()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr bool graphar::Status::IsInvalid </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">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return true iff the status indicates invalid data. </p>
<p class="definition">Definition at line <a class="el" href="status_8h_source.html#l00233">233</a> of file <a class="el" href="status_8h_source.html">status.h</a>.</p>
</div>
</div>
<a id="a5722c85539ba45817a7f7d57d511bb7c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5722c85539ba45817a7f7d57d511bb7c">&#9670;&nbsp;</a></span>IsKeyError()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr bool graphar::Status::IsKeyError </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">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return true iff the status indicates a key lookup error. </p>
<p class="definition">Definition at line <a class="el" href="status_8h_source.html#l00227">227</a> of file <a class="el" href="status_8h_source.html">status.h</a>.</p>
</div>
</div>
<a id="a5655e90a1f657d7e5a12b5217a7eee25"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5655e90a1f657d7e5a12b5217a7eee25">&#9670;&nbsp;</a></span>IsTypeError()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr bool graphar::Status::IsTypeError </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">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return true iff the status indicates a type match error. </p>
<p class="definition">Definition at line <a class="el" href="status_8h_source.html#l00229">229</a> of file <a class="el" href="status_8h_source.html">status.h</a>.</p>
</div>
</div>
<a id="aa42e3449fecbebb29bff9e59bb83fcce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa42e3449fecbebb29bff9e59bb83fcce">&#9670;&nbsp;</a></span>IsYamlError()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr bool graphar::Status::IsYamlError </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">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return true iff the status indicates an yaml parse related failure. </p>
<p class="definition">Definition at line <a class="el" href="status_8h_source.html#l00239">239</a> of file <a class="el" href="status_8h_source.html">status.h</a>.</p>
</div>
</div>
<a id="a4ee4924ddadfc2c1effc055572084d71"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4ee4924ddadfc2c1effc055572084d71">&#9670;&nbsp;</a></span>KeyError()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename... Args&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classgraphar_1_1_status.html">Status</a> graphar::Status::KeyError </td>
<td>(</td>
<td class="paramtype">Args &amp;&amp;...&#160;</td>
<td class="paramname"><em>args</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns an error status for failed key lookups. </p>
<p class="definition">Definition at line <a class="el" href="status_8h_source.html#l00172">172</a> of file <a class="el" href="status_8h_source.html">status.h</a>.</p>
</div>
</div>
<a id="a11279464d73e7362db85e08935546022"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a11279464d73e7362db85e08935546022">&#9670;&nbsp;</a></span>message()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::string&amp; graphar::Status::message </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>Return the specific error message attached to this status. </p>
<p class="definition">Definition at line <a class="el" href="status_8h_source.html#l00253">253</a> of file <a class="el" href="status_8h_source.html">status.h</a>.</p>
</div>
</div>
<a id="ad92f5c41a661d4f468390e39da90f881"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad92f5c41a661d4f468390e39da90f881">&#9670;&nbsp;</a></span>OK()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classgraphar_1_1_status.html">Status</a> graphar::Status::OK </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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a success status. </p>
<p class="definition">Definition at line <a class="el" href="status_8h_source.html#l00157">157</a> of file <a class="el" href="status_8h_source.html">status.h</a>.</p>
</div>
</div>
<a id="a401ecb877b8439e3006552f46869e6f0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a401ecb877b8439e3006552f46869e6f0">&#9670;&nbsp;</a></span>ok()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr bool graphar::Status::ok </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">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return true iff the status indicates success. </p>
<p class="definition">Definition at line <a class="el" href="status_8h_source.html#l00224">224</a> of file <a class="el" href="status_8h_source.html">status.h</a>.</p>
</div>
</div>
<a id="a2a5b813b0a187fcf753a9e14836bc966"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2a5b813b0a187fcf753a9e14836bc966">&#9670;&nbsp;</a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgraphar_1_1_status.html">Status</a>&amp; graphar::Status::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgraphar_1_1_status.html">Status</a> &amp;&amp;&#160;</td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Move assignment operator. </p>
<p class="definition">Definition at line <a class="el" href="status_8h_source.html#l00149">149</a> of file <a class="el" href="status_8h_source.html">status.h</a>.</p>
</div>
</div>
<a id="a3335cf4bf5cd222d5e29b01fe95e919a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3335cf4bf5cd222d5e29b01fe95e919a">&#9670;&nbsp;</a></span>TypeError()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename... Args&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classgraphar_1_1_status.html">Status</a> graphar::Status::TypeError </td>
<td>(</td>
<td class="paramtype">Args &amp;&amp;...&#160;</td>
<td class="paramname"><em>args</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns an error status for failed type matches. </p>
<p class="definition">Definition at line <a class="el" href="status_8h_source.html#l00178">178</a> of file <a class="el" href="status_8h_source.html">status.h</a>.</p>
</div>
</div>
<a id="a4a45918d3b4f77af5a794fd8f2245ab2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4a45918d3b4f77af5a794fd8f2245ab2">&#9670;&nbsp;</a></span>UnknownError()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename... Args&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classgraphar_1_1_status.html">Status</a> graphar::Status::UnknownError </td>
<td>(</td>
<td class="paramtype">Args &amp;&amp;...&#160;</td>
<td class="paramname"><em>args</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return an error status for unknown errors. </p>
<p class="definition">Definition at line <a class="el" href="status_8h_source.html#l00218">218</a> of file <a class="el" href="status_8h_source.html">status.h</a>.</p>
</div>
</div>
<a id="a358b23c7f34efbf14c84cbc2ddbdd6a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a358b23c7f34efbf14c84cbc2ddbdd6a4">&#9670;&nbsp;</a></span>YamlError()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename... Args&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classgraphar_1_1_status.html">Status</a> graphar::Status::YamlError </td>
<td>(</td>
<td class="paramtype">Args &amp;&amp;...&#160;</td>
<td class="paramname"><em>args</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return an error status when some yaml parse related operation failed. </p>
<p class="definition">Definition at line <a class="el" href="status_8h_source.html#l00204">204</a> of file <a class="el" href="status_8h_source.html">status.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/graphar/<a class="el" href="status_8h_source.html">status.h</a></li>
</ul>
</div><!-- contents -->
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<!-- disclaimer_footer.html -->
<footer style="text-align: center; font-size: 12px;">
<div>
<p>
Apache GraphAr is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.
</p>
<p>
Copyright © 2024 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. <br/>
Apache, the names of Apache projects, and the feather logo are either registered trademarks or trademarks of the Apache Software Foundation in the United States and/or other countries.
</p>
</div>
</footer>