You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by uw...@apache.org on 2018/12/23 16:31:34 UTC
[27/51] [partial] arrow-site git commit: Upload nightly docs
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/62ef7145/docs/latest/cpp/api/support.html
----------------------------------------------------------------------
diff --git a/docs/latest/cpp/api/support.html b/docs/latest/cpp/api/support.html
new file mode 100644
index 0000000..5dca19e
--- /dev/null
+++ b/docs/latest/cpp/api/support.html
@@ -0,0 +1,463 @@
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Programming Support — Apache Arrow v0.11.1.dev473+g6ed02454</title>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+ <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
+ <link rel="index" title="Index" href="../../genindex.html" />
+ <link rel="search" title="Search" href="../../search.html" />
+ <link rel="next" title="Memory (management)" href="memory.html" />
+ <link rel="prev" title="API Reference" href="../api.html" />
+
+
+ <script src="../../_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav">
+
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-scroll">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="../../index.html" class="icon icon-home"> Apache Arrow
+
+
+
+ </a>
+
+
+
+
+ <div class="version">
+ 0.11.1.dev473+g6ed02454
+ </div>
+
+
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+
+
+
+ <p class="caption"><span class="caption-text">Memory Format</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../format/README.html">Arrow specification documents</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../format/Guidelines.html">Implementation guidelines</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../format/Layout.html">Physical memory layout</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../format/Metadata.html">Metadata: Logical types, schemas, data headers</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../format/IPC.html">Interprocess messaging / communication (IPC)</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Languages</span></p>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">C++ Implementation</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../getting_started.html">Getting Started</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../examples.html">Examples</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="../api.html">API Reference</a><ul class="current">
+<li class="toctree-l3 current"><a class="current reference internal" href="#">Programming Support</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="#error-return-and-reporting">Error return and reporting</a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="memory.html">Memory (management)</a></li>
+<li class="toctree-l3"><a class="reference internal" href="datatype.html">Data Types</a></li>
+<li class="toctree-l3"><a class="reference internal" href="array.html">Arrays</a></li>
+<li class="toctree-l3"><a class="reference internal" href="builder.html">Array Builders</a></li>
+<li class="toctree-l3"><a class="reference internal" href="table.html">Two-dimensional Datasets</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../../python/index.html">Python bindings</a></li>
+</ul>
+
+
+
+ </div>
+ </div>
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" aria-label="top navigation">
+
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Apache Arrow</a>
+
+ </nav>
+
+
+ <div class="wy-nav-content">
+
+ <div class="rst-content">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+ <ul class="wy-breadcrumbs">
+
+ <li><a href="../../index.html">Docs</a> »</li>
+
+ <li><a href="../index.html">C++ Implementation</a> »</li>
+
+ <li><a href="../api.html">API Reference</a> »</li>
+
+ <li>Programming Support</li>
+
+
+ <li class="wy-breadcrumbs-aside">
+
+
+ <a href="../../_sources/cpp/api/support.rst.txt" rel="nofollow"> View page source</a>
+
+
+ </li>
+
+ </ul>
+
+
+ <hr/>
+</div>
+ <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+ <div itemprop="articleBody">
+
+ <div class="section" id="programming-support">
+<h1>Programming Support<a class="headerlink" href="#programming-support" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="error-return-and-reporting">
+<h2>Error return and reporting<a class="headerlink" href="#error-return-and-reporting" title="Permalink to this headline">¶</a></h2>
+<dl class="class">
+<dt id="_CPPv3N5arrow6StatusE">
+<span id="_CPPv2N5arrow6StatusE"></span><span id="arrow::Status"></span><span class="target" id="classarrow_1_1_status"></span><em class="property">class </em><code class="descname">Status</code><a class="headerlink" href="#_CPPv3N5arrow6StatusE" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p><a class="reference internal" href="#classarrow_1_1_status"><span class="std std-ref">Status</span></a> outcome object (success or error) </p>
+<p>The <a class="reference internal" href="#classarrow_1_1_status"><span class="std std-ref">Status</span></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>
+<div class="breathe-sectiondef docutils container">
+<p class="breathe-sectiondef-title rubric">Public Functions</p>
+<dl class="function">
+<dt id="_CPPv3NK5arrow6Status2okEv">
+<span id="_CPPv2NK5arrow6Status2okEv"></span><span id="arrow::Status::okC"></span><span class="target" id="classarrow_1_1_status_1a2240d82ac632c582efc070af2fe9a5ec"></span>bool <code class="descname">ok</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow6Status2okEv" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>Return true iff the status indicates success. </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv3NK5arrow6Status13IsOutOfMemoryEv">
+<span id="_CPPv2NK5arrow6Status13IsOutOfMemoryEv"></span><span id="arrow::Status::IsOutOfMemoryC"></span><span class="target" id="classarrow_1_1_status_1aa68adbba5eb1af6a3bbea812e932202e"></span>bool <code class="descname">IsOutOfMemory</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow6Status13IsOutOfMemoryEv" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>Return true iff the status indicates an out-of-memory error. </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv3NK5arrow6Status10IsKeyErrorEv">
+<span id="_CPPv2NK5arrow6Status10IsKeyErrorEv"></span><span id="arrow::Status::IsKeyErrorC"></span><span class="target" id="classarrow_1_1_status_1aecaae760cdbe63349166c5415c7d6405"></span>bool <code class="descname">IsKeyError</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow6Status10IsKeyErrorEv" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>Return true iff the status indicates a key lookup error. </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv3NK5arrow6Status9IsInvalidEv">
+<span id="_CPPv2NK5arrow6Status9IsInvalidEv"></span><span id="arrow::Status::IsInvalidC"></span><span class="target" id="classarrow_1_1_status_1a1473b7bf14ad50feab36b514b5af6484"></span>bool <code class="descname">IsInvalid</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow6Status9IsInvalidEv" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>Return true iff the status indicates invalid data. </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv3NK5arrow6Status9IsIOErrorEv">
+<span id="_CPPv2NK5arrow6Status9IsIOErrorEv"></span><span id="arrow::Status::IsIOErrorC"></span><span class="target" id="classarrow_1_1_status_1a028972b0c7f807ebfabfb00b692c489e"></span>bool <code class="descname">IsIOError</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow6Status9IsIOErrorEv" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>Return true iff the status indicates an IO-related failure. </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv3NK5arrow6Status15IsCapacityErrorEv">
+<span id="_CPPv2NK5arrow6Status15IsCapacityErrorEv"></span><span id="arrow::Status::IsCapacityErrorC"></span><span class="target" id="classarrow_1_1_status_1ae8ee3e230331723c3d9d554ca68c4f9f"></span>bool <code class="descname">IsCapacityError</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow6Status15IsCapacityErrorEv" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>Return true iff the status indicates a container reaching capacity limits. </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv3NK5arrow6Status11IsTypeErrorEv">
+<span id="_CPPv2NK5arrow6Status11IsTypeErrorEv"></span><span id="arrow::Status::IsTypeErrorC"></span><span class="target" id="classarrow_1_1_status_1aa508d180a205b08be3438f0b13209df5"></span>bool <code class="descname">IsTypeError</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow6Status11IsTypeErrorEv" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>Return true iff the status indicates a type error. </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv3NK5arrow6Status14IsUnknownErrorEv">
+<span id="_CPPv2NK5arrow6Status14IsUnknownErrorEv"></span><span id="arrow::Status::IsUnknownErrorC"></span><span class="target" id="classarrow_1_1_status_1a712fe45f53af49719298b6a69ca69fdd"></span>bool <code class="descname">IsUnknownError</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow6Status14IsUnknownErrorEv" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>Return true iff the status indicates an unknown error. </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv3NK5arrow6Status16IsNotImplementedEv">
+<span id="_CPPv2NK5arrow6Status16IsNotImplementedEv"></span><span id="arrow::Status::IsNotImplementedC"></span><span class="target" id="classarrow_1_1_status_1a772915ccb2d41372bf989da001195bcd"></span>bool <code class="descname">IsNotImplemented</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow6Status16IsNotImplementedEv" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>Return true iff the status indicates an unimplemented operation. </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv3NK5arrow6Status20IsSerializationErrorEv">
+<span id="_CPPv2NK5arrow6Status20IsSerializationErrorEv"></span><span id="arrow::Status::IsSerializationErrorC"></span><span class="target" id="classarrow_1_1_status_1aff56e112e3004e6f9f79a5e9e9d35d2a"></span>bool <code class="descname">IsSerializationError</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow6Status20IsSerializationErrorEv" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>Return true iff the status indicates a (de)serialization failure. </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv3NK5arrow6Status8IsRErrorEv">
+<span id="_CPPv2NK5arrow6Status8IsRErrorEv"></span><span id="arrow::Status::IsRErrorC"></span><span class="target" id="classarrow_1_1_status_1aa94c1d729d9a98fadc5ec50cbdaa9887"></span>bool <code class="descname">IsRError</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow6Status8IsRErrorEv" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>Return true iff the status indicates a R-originated error. </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv3NK5arrow6Status13IsPythonErrorEv">
+<span id="_CPPv2NK5arrow6Status13IsPythonErrorEv"></span><span id="arrow::Status::IsPythonErrorC"></span><span class="target" id="classarrow_1_1_status_1a0b64c9245ff0c520e62995222f16e1bf"></span>bool <code class="descname">IsPythonError</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow6Status13IsPythonErrorEv" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>Return true iff the status indicates a Python-originated error. </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv3NK5arrow6Status20IsPlasmaObjectExistsEv">
+<span id="_CPPv2NK5arrow6Status20IsPlasmaObjectExistsEv"></span><span id="arrow::Status::IsPlasmaObjectExistsC"></span><span class="target" id="classarrow_1_1_status_1a836c49e470898d24c854894dab8349c0"></span>bool <code class="descname">IsPlasmaObjectExists</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow6Status20IsPlasmaObjectExistsEv" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>Return true iff the status indicates an already existing Plasma object. </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv3NK5arrow6Status25IsPlasmaObjectNonexistentEv">
+<span id="_CPPv2NK5arrow6Status25IsPlasmaObjectNonexistentEv"></span><span id="arrow::Status::IsPlasmaObjectNonexistentC"></span><span class="target" id="classarrow_1_1_status_1aa044a455a43c720b38daf3977cfef40f"></span>bool <code class="descname">IsPlasmaObjectNonexistent</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow6Status25IsPlasmaObjectNonexistentEv" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>Return true iff the status indicates a non-existent Plasma object. </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv3NK5arrow6Status27IsPlasmaObjectAlreadySealedEv">
+<span id="_CPPv2NK5arrow6Status27IsPlasmaObjectAlreadySealedEv"></span><span id="arrow::Status::IsPlasmaObjectAlreadySealedC"></span><span class="target" id="classarrow_1_1_status_1a5d7860582571a1fbf6b14515ff0184a9"></span>bool <code class="descname">IsPlasmaObjectAlreadySealed</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow6Status27IsPlasmaObjectAlreadySealedEv" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>Return true iff the status indicates an already sealed Plasma object. </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv3NK5arrow6Status17IsPlasmaStoreFullEv">
+<span id="_CPPv2NK5arrow6Status17IsPlasmaStoreFullEv"></span><span id="arrow::Status::IsPlasmaStoreFullC"></span><span class="target" id="classarrow_1_1_status_1ab326eeae329f62cf80208cac2f49d8e4"></span>bool <code class="descname">IsPlasmaStoreFull</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow6Status17IsPlasmaStoreFullEv" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>Return true iff the status indicates the Plasma store reached its capacity limit. </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv3NK5arrow6Status8ToStringEv">
+<span id="_CPPv2NK5arrow6Status8ToStringEv"></span><span id="arrow::Status::ToStringC"></span><span class="target" id="classarrow_1_1_status_1a5bccb726dc7a1989b9158b46bfb309b6"></span>std::string <code class="descname">ToString</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow6Status8ToStringEv" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>Return a string representation of this status suitable for printing. </p>
+<p>The string “OK” is returned for success. </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv3NK5arrow6Status12CodeAsStringEv">
+<span id="_CPPv2NK5arrow6Status12CodeAsStringEv"></span><span id="arrow::Status::CodeAsStringC"></span><span class="target" id="classarrow_1_1_status_1a4b39130dbef68d6b20ee9baa41c76504"></span>std::string <code class="descname">CodeAsString</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow6Status12CodeAsStringEv" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>Return a string representation of the status code, without the message text or POSIX code information. </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv3NK5arrow6Status4codeEv">
+<span id="_CPPv2NK5arrow6Status4codeEv"></span><span id="arrow::Status::codeC"></span><span class="target" id="classarrow_1_1_status_1a0006d966f821af5194a087806b121e80"></span>StatusCode <code class="descname">code</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow6Status4codeEv" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>Return the StatusCode value attached to this status. </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv3NK5arrow6Status7messageEv">
+<span id="_CPPv2NK5arrow6Status7messageEv"></span><span id="arrow::Status::messageC"></span><span class="target" id="classarrow_1_1_status_1ad67b92854b41e7f0c5951b114b195284"></span>std::string <code class="descname">message</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv3NK5arrow6Status7messageEv" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>Return the specific error message attached to this status. </p>
+</dd></dl>
+
+</div>
+<div class="breathe-sectiondef docutils container">
+<p class="breathe-sectiondef-title rubric">Public Static Functions</p>
+<dl class="function">
+<dt id="_CPPv3N5arrow6Status2OKEv">
+<span id="_CPPv2N5arrow6Status2OKEv"></span><span id="arrow::Status::OK"></span><span class="target" id="classarrow_1_1_status_1a5c0b0031db6eeec3dcc70485d24cfe03"></span><em class="property">static</em> <a class="reference internal" href="#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">OK</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv3N5arrow6Status2OKEv" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>Return a success status. </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv3N5arrow6Status2OKEDpRR4Args">
+<span id="_CPPv2N5arrow6Status2OKEDpRR4Args"></span><span id="arrow::Status::OK__ArgsRRDp"></span><em class="property">template </em><typename... <em>Args</em>><br /><span class="target" id="classarrow_1_1_status_1afea264a6a3b9103992fc58c917fbb7d4"></span><em class="property">static</em> <a class="reference internal" href="#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">OK</code><span class="sig-paren">(</span>Args&&... <em>args</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv3N5arrow6Status2OKEDpRR4Args" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>Return a success status with a specific message. </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv3N5arrow6Status11OutOfMemoryEDpRR4Args">
+<span id="_CPPv2N5arrow6Status11OutOfMemoryEDpRR4Args"></span><span id="arrow::Status::OutOfMemory__ArgsRRDp"></span><em class="property">template </em><typename... <em>Args</em>><br /><span class="target" id="classarrow_1_1_status_1ae39cb87196acb83e4eb921cf729248e3"></span><em class="property">static</em> <a class="reference internal" href="#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">OutOfMemory</code><span class="sig-paren">(</span>Args&&... <em>args</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv3N5arrow6Status11OutOfMemoryEDpRR4Args" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>Return an error status for out-of-memory conditions. </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv3N5arrow6Status8KeyErrorEDpRR4Args">
+<span id="_CPPv2N5arrow6Status8KeyErrorEDpRR4Args"></span><span id="arrow::Status::KeyError__ArgsRRDp"></span><em class="property">template </em><typename... <em>Args</em>><br /><span class="target" id="classarrow_1_1_status_1a9cb12a31b919deae25d1089da1cf21c7"></span><em class="property">static</em> <a class="reference internal" href="#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">KeyError</code><span class="sig-paren">(</span>Args&&... <em>args</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv3N5arrow6Status8KeyErrorEDpRR4Args" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>Return an error status for failed key lookups (e.g. column name in a table) </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv3N5arrow6Status9TypeErrorEDpRR4Args">
+<span id="_CPPv2N5arrow6Status9TypeErrorEDpRR4Args"></span><span id="arrow::Status::TypeError__ArgsRRDp"></span><em class="property">template </em><typename... <em>Args</em>><br /><span class="target" id="classarrow_1_1_status_1a0ff96a9163346d8af8abe40e9809a8ba"></span><em class="property">static</em> <a class="reference internal" href="#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">TypeError</code><span class="sig-paren">(</span>Args&&... <em>args</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv3N5arrow6Status9TypeErrorEDpRR4Args" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>Return an error status for type errors (such as mismatching data types) </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv3N5arrow6Status12UnknownErrorEDpRR4Args">
+<span id="_CPPv2N5arrow6Status12UnknownErrorEDpRR4Args"></span><span id="arrow::Status::UnknownError__ArgsRRDp"></span><em class="property">template </em><typename... <em>Args</em>><br /><span class="target" id="classarrow_1_1_status_1a40dfa10f3910d85b4a8d9d5c2c043feb"></span><em class="property">static</em> <a class="reference internal" href="#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">UnknownError</code><span class="sig-paren">(</span>Args&&... <em>args</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv3N5arrow6Status12UnknownErrorEDpRR4Args" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>Return an error status for unknown errors. </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv3N5arrow6Status14NotImplementedEDpRR4Args">
+<span id="_CPPv2N5arrow6Status14NotImplementedEDpRR4Args"></span><span id="arrow::Status::NotImplemented__ArgsRRDp"></span><em class="property">template </em><typename... <em>Args</em>><br /><span class="target" id="classarrow_1_1_status_1ae63ddaaa7db5edef4e75a26b693351a1"></span><em class="property">static</em> <a class="reference internal" href="#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">NotImplemented</code><span class="sig-paren">(</span>Args&&... <em>args</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv3N5arrow6Status14NotImplementedEDpRR4Args" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>Return an error status when an operation or a combination of operation and data types is unimplemented. </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv3N5arrow6Status7InvalidEDpRR4Args">
+<span id="_CPPv2N5arrow6Status7InvalidEDpRR4Args"></span><span id="arrow::Status::Invalid__ArgsRRDp"></span><em class="property">template </em><typename... <em>Args</em>><br /><span class="target" id="classarrow_1_1_status_1aa388393c060f3b44316876a630190576"></span><em class="property">static</em> <a class="reference internal" href="#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">Invalid</code><span class="sig-paren">(</span>Args&&... <em>args</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv3N5arrow6Status7InvalidEDpRR4Args" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>Return an error status for invalid data (for example a string that fails parsing) </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv3N5arrow6Status13CapacityErrorEDpRR4Args">
+<span id="_CPPv2N5arrow6Status13CapacityErrorEDpRR4Args"></span><span id="arrow::Status::CapacityError__ArgsRRDp"></span><em class="property">template </em><typename... <em>Args</em>><br /><span class="target" id="classarrow_1_1_status_1a116186da015799d2efc8446ec709d4af"></span><em class="property">static</em> <a class="reference internal" href="#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">CapacityError</code><span class="sig-paren">(</span>Args&&... <em>args</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv3N5arrow6Status13CapacityErrorEDpRR4Args" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>Return an error status when a container’s capacity would exceed its limits. </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv3N5arrow6Status7IOErrorEDpRR4Args">
+<span id="_CPPv2N5arrow6Status7IOErrorEDpRR4Args"></span><span id="arrow::Status::IOError__ArgsRRDp"></span><em class="property">template </em><typename... <em>Args</em>><br /><span class="target" id="classarrow_1_1_status_1a4d6fc084d924c8297e35b9996c4171b3"></span><em class="property">static</em> <a class="reference internal" href="#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">IOError</code><span class="sig-paren">(</span>Args&&... <em>args</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv3N5arrow6Status7IOErrorEDpRR4Args" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>Return an error status when some IO-related operation failed. </p>
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv3N5arrow6Status18SerializationErrorEDpRR4Args">
+<span id="_CPPv2N5arrow6Status18SerializationErrorEDpRR4Args"></span><span id="arrow::Status::SerializationError__ArgsRRDp"></span><em class="property">template </em><typename... <em>Args</em>><br /><span class="target" id="classarrow_1_1_status_1a0852f0d35526dc31345154f92c955c00"></span><em class="property">static</em> <a class="reference internal" href="#_CPPv3N5arrow6StatusE" title="arrow::Status">Status</a> <code class="descname">SerializationError</code><span class="sig-paren">(</span>Args&&... <em>args</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv3N5arrow6Status18SerializationErrorEDpRR4Args" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>Return an error status when some (de)serialization operation failed. </p>
+</dd></dl>
+
+</div>
+</dd></dl>
+
+<dl class="macro">
+<dt id="c.ARROW_RETURN_NOT_OK">
+<span class="target" id="status_8h_1a4a98c16fff26a2c4cf8c26d9244c1cb4"></span><code class="descname">ARROW_RETURN_NOT_OK</code><span class="sig-paren">(</span>status<span class="sig-paren">)</span><a class="headerlink" href="#c.ARROW_RETURN_NOT_OK" title="Permalink to this definition">¶</a></dt>
+<dd><p>Propagate any non-successful Status to the caller. </p>
+</dd></dl>
+
+</div>
+</div>
+
+
+ </div>
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="memory.html" class="btn btn-neutral float-right" title="Memory (management)" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="../api.html" class="btn btn-neutral" title="API Reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ © Copyright 2016-2018 Apache Software Foundation
+
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+
+
+
+
+ <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.Navigation.enable(true);
+ });
+ </script>
+<script async src="https://www.googletagmanager.com/gtag/js?id=UA-107500873-1"></script>
+<script>
+ window.dataLayer = window.dataLayer || [];
+ function gtag(){dataLayer.push(arguments);}
+ gtag('js', new Date());
+
+ gtag('config', 'UA-107500873-1');
+</script>
+
+
+</body>
+</html>
\ No newline at end of file