[DEV] add v1.76.0

libs/outcome/doc/html/tutorial/essential/no-value/builtin.html

@@ -0,0 +1,151 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html><meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>Built-in policies - Boost.Outcome documentation</title>
+<link rel="stylesheet" href="../../../css/boost.css" type="text/css">
+<meta name="generator" content="Hugo 0.52 with Boostdoc theme">
+<meta name="viewport" content="width=device-width,initial-scale=1.0"/>
+
+<link rel="icon" href="../../../images/favicon.ico" type="image/ico"/>
+<body><div class="spirit-nav">
+<a accesskey="p" href="../../../tutorial/essential/no-value/custom.html"><img src="../../../images/prev.png" alt="Prev"></a>
+    <a accesskey="u" href="../../../tutorial/essential/no-value.html"><img src="../../../images/up.png" alt="Up"></a>
+    <a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="../../../tutorial/essential/coroutines.html"><img src="../../../images/next.png" alt="Next"></a></div><div id="content">
+  <div class="titlepage"><div><div><h1 style="clear: both">Built-in policies</h1></div></div></div>
+  <p>These are the predefined policies built into Outcome:</p>
+
+<hr style="border-color: black;">
+
+<p>&nbsp;</p>
+
+<a href="../../../reference/policies/all_narrow.html" class="api-reference"><code>all_narrow</code></a>
+
+
+<p>If there is an observation of a value/error/exception which is not present,
+the program is put into a <strong>hard undefined behaviour</strong> situation. The
+compiler <em>literally</em> compiles no code for an invalid observation &ndash; the
+CPU &ldquo;runs off&rdquo; into the unknown.</p>
+
+<p>As bad as this may sound, it generates the most optimal code, and such
+hard UB is very tool-friendly for detection e.g. undefined behaviour
+sanitiser, valgrind memcheck, etc.</p>
+
+<p>If you are considering choosing this policy, definitely read
+<a href="../../../reference/policies/base/ub.html" class="api-reference"><code>static void _ub(Impl &amp;&amp;)</code></a>
+ first.</p>
+
+<p>Note that <a href="../../../reference/aliases/unchecked.html" class="api-reference"><code>unchecked&lt;T, E = varies&gt;</code></a>
+ aliases a <code>basic_result</code>
+with the <code>all_narrow</code> no-value policy.</p>
+
+<hr style="border-color: black;">
+
+<p>&nbsp;</p>
+
+<a href="../../../reference/policies/terminate.html" class="api-reference"><code>terminate</code></a>
+
+
+<p>Observation of a missing value/error/exception causes a call to
+<code>std::terminate()</code>.</p>
+
+<p>Note that configuring <code>EC = void</code> or <code>EP = void</code> causes
+<a href="../../../reference/aliases/default_policy.html" class="api-reference"><code>default_policy</code></a>
+ to choose <code>terminate</code> as the no-value policy.</p>
+
+<hr style="border-color: black;">
+
+<p>&nbsp;</p>
+
+<a href="../../../reference/policies/error_code_throw_as_system_error_outcome.html" class="api-reference"><code>error_code_throw_as_system_error&lt;T, EC, EP&gt;</code></a>
+
+
+<p>This policy assumes that <code>EC</code> has the interface of <code>std::error_code</code>,
+and <code>EP</code> has the interface of <code>std::exception_ptr</code>. Upon missing value
+observation:</p>
+
+<ul>
+<li>if an exception is stored through pointer of type <code>EP</code> it is rethrown;</li>
+<li>otherwise, if an error of type <code>EC</code> is stored, it is converted to <code>error_code</code>
+and then thrown as <code>system_error</code>.</li>
+</ul>
+
+<p>Upon missing error observation throws:</p>
+
+<ul>
+<li><code>bad_result_access(&quot;no error&quot;)</code> from instances of <code>basic_result&lt;&gt;</code>.</li>
+<li><code>bad_outcome_access(&quot;no error&quot;)</code> from instances of <code>basic_outcome&lt;&gt;</code>.</li>
+</ul>
+
+<p>Upon missing exception observation throws <code>bad_outcome_access(&quot;no exception&quot;)</code>.</p>
+
+<p>Overloads are provided for <code>boost::system::error_code</code> and <code>boost::exception_ptr</code>.</p>
+
+<p>Note that if <a href="../../../reference/traits/is_error_code_available.html" class="api-reference"><code>is_error_code_available&lt;T&gt;</code></a>
+ is true for <code>EC</code>,
+and (if <code>basic_outcome</code>) <a href="../../../reference/traits/is_exception_ptr_available.html" class="api-reference"><code>is_exception_ptr_available&lt;T&gt;</code></a>
+
+is true for <code>EP</code>, <a href="../../../reference/aliases/default_policy.html" class="api-reference"><code>default_policy</code></a>
+ chooses
+<code>error_code_throw_as_system_error&lt;T, EC, EP&gt;</code> as the no-value policy.</p>
+
+<hr style="border-color: black;">
+
+<p>&nbsp;</p>
+
+<a href="../../../reference/policies/exception_ptr_rethrow_outcome.html" class="api-reference"><code>exception_ptr_rethrow&lt;T, EC, EP&gt;</code></a>
+
+
+<p>This policy assumes that either <code>EC</code> or <code>EP</code> (unless <code>void</code>) has the interface of <code>std::exception_ptr</code>. Upon missing value observation:</p>
+
+<ul>
+<li>in instances of <code>basic_result&lt;&gt;</code>, rethrows exception pointed to by <code>EC</code>;</li>
+<li>in instances of <code>basic_outcome&lt;&gt;</code>, if exception <code>EP</code> is present rethrows it,
+otherwise rethrows <code>EC</code>.</li>
+</ul>
+
+<p>Upon missing error observation:</p>
+
+<ul>
+<li>in instances of <code>basic_result&lt;&gt;</code>, throws  <code>bad_result_access(&quot;no error&quot;)</code> ;</li>
+<li>in instances of <code>basic_outcome&lt;&gt;</code>, throws  <code>bad_outcome_access(&quot;no error&quot;)</code>.</li>
+</ul>
+
+<p>Upon missing exception observation throws <code>bad_outcome_access(&quot;no exception&quot;)</code>.</p>
+
+<p>Overloads are provided for <code>boost::exception_ptr</code>.</p>
+
+<p>Note that if <a href="../../../reference/traits/is_exception_ptr_available.html" class="api-reference"><code>is_exception_ptr_available&lt;T&gt;</code></a>
+ is true for <code>EC</code>,
+or (if <code>basic_outcome</code>) <a href="../../../reference/traits/is_exception_ptr_available.html" class="api-reference"><code>is_exception_ptr_available&lt;T&gt;</code></a>
+
+is true for <code>EP</code>, <a href="../../../reference/aliases/default_policy.html" class="api-reference"><code>default_policy</code></a>
+ chooses
+<code>exception_ptr_rethrow&lt;T, EC, EP&gt;</code> as the no-value policy.</p>
+
+<hr style="border-color: black;">
+
+<p>&nbsp;</p>
+
+<a href="../../../reference/policies/throw_bad_result_access.html" class="api-reference"><code>throw_bad_result_access&lt;EC&gt;</code></a>
+
+
+<p>Upon missing value observation throws <code>bad_result_access_with&lt;EC&gt;(ec)</code>,
+where <code>ec</code> is the value of the stored error. If error is not stored,
+the behaviour is undefined.</p>
+
+<p>Upon missing error observation throws <code>bad_result_access(&quot;no error&quot;)</code>.</p>
+
+<p>This policy can be used with <code>basic_outcome&lt;&gt;</code> instances, where it always
+throws <code>bad_outcome_access</code> for all no-value/error/exception observations.</p>
+
+<p>Note that <a href="../../../reference/aliases/checked.html" class="api-reference"><code>checked&lt;T, E = varies&gt;</code></a>
+ aliases a <code>basic_result</code>
+with the <code>throw_bad_result_access&lt;EC&gt;</code> no-value policy.</p>
+
+
+        </div><p><small>Last revised: February 09, 2019 at 15:18:26 UTC</small></p>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../../../tutorial/essential/no-value/custom.html"><img src="../../../images/prev.png" alt="Prev"></a>
+    <a accesskey="u" href="../../../tutorial/essential/no-value.html"><img src="../../../images/up.png" alt="Up"></a>
+    <a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="../../../tutorial/essential/coroutines.html"><img src="../../../images/next.png" alt="Next"></a></div></body>
+</html>

libs/outcome/doc/html/tutorial/essential/no-value/custom.html

@@ -0,0 +1,60 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html><meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>A custom no-value policy - Boost.Outcome documentation</title>
+<link rel="stylesheet" href="../../../css/boost.css" type="text/css">
+<meta name="generator" content="Hugo 0.52 with Boostdoc theme">
+<meta name="viewport" content="width=device-width,initial-scale=1.0"/>
+
+<link rel="icon" href="../../../images/favicon.ico" type="image/ico"/>
+<body><div class="spirit-nav">
+<a accesskey="p" href="../../../tutorial/essential/no-value.html"><img src="../../../images/prev.png" alt="Prev"></a>
+    <a accesskey="u" href="../../../tutorial/essential/no-value.html"><img src="../../../images/up.png" alt="Up"></a>
+    <a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="../../../tutorial/essential/no-value/builtin.html"><img src="../../../images/next.png" alt="Next"></a></div><div id="content">
+  <div class="titlepage"><div><div><h1 style="clear: both">A custom no-value policy</h1></div></div></div>
+  <p>If you want your <code>basic_outcome&lt;&gt;</code> or <code>basic_result&lt;&gt;</code> instances to call
+<code>std::abort()</code> whenever <code>.value()</code> is called on an object that does not contain a value, or <code>.error()</code> is called on an object that does not contain an error, you will need to define your own no-value policy as follows:</p>
+
+<div class="code-snippet"><div class="highlight"><pre class="chroma"><code class="language-c++" data-lang="c++"><span class="k">struct</span> <span class="nl">abort_policy</span> <span class="p">:</span> <span class="n">outcome</span><span class="o">::</span><span class="n">policy</span><span class="o">::</span><span class="n">base</span>
+<span class="p">{</span>
+  <span class="k">template</span> <span class="o">&lt;</span><span class="k">class</span><span class="err"> </span><span class="nc">Impl</span><span class="o">&gt;</span> <span class="k">static</span> <span class="k">constexpr</span> <span class="kt">void</span> <span class="n">wide_value_check</span><span class="p">(</span><span class="n">Impl</span> <span class="o">&amp;&amp;</span><span class="n">self</span><span class="p">)</span>
+  <span class="p">{</span>
+    <span class="k">if</span><span class="p">(</span><span class="o">!</span><span class="n">base</span><span class="o">::</span><span class="n">_has_value</span><span class="p">(</span><span class="n">std</span><span class="o">::</span><span class="n">forward</span><span class="o">&lt;</span><span class="n">Impl</span><span class="o">&gt;</span><span class="p">(</span><span class="n">self</span><span class="p">)))</span>
+      <span class="n">std</span><span class="o">::</span><span class="n">abort</span><span class="p">();</span>
+  <span class="p">}</span>
+
+  <span class="k">template</span> <span class="o">&lt;</span><span class="k">class</span><span class="err"> </span><span class="nc">Impl</span><span class="o">&gt;</span> <span class="k">static</span> <span class="k">constexpr</span> <span class="kt">void</span> <span class="n">wide_error_check</span><span class="p">(</span><span class="n">Impl</span> <span class="o">&amp;&amp;</span><span class="n">self</span><span class="p">)</span>
+  <span class="p">{</span>
+    <span class="k">if</span><span class="p">(</span><span class="o">!</span><span class="n">base</span><span class="o">::</span><span class="n">_has_error</span><span class="p">(</span><span class="n">std</span><span class="o">::</span><span class="n">forward</span><span class="o">&lt;</span><span class="n">Impl</span><span class="o">&gt;</span><span class="p">(</span><span class="n">self</span><span class="p">)))</span>
+      <span class="n">std</span><span class="o">::</span><span class="n">abort</span><span class="p">();</span>
+  <span class="p">}</span>
+
+  <span class="k">template</span> <span class="o">&lt;</span><span class="k">class</span><span class="err"> </span><span class="nc">Impl</span><span class="o">&gt;</span> <span class="k">static</span> <span class="k">constexpr</span> <span class="kt">void</span> <span class="n">wide_exception_check</span><span class="p">(</span><span class="n">Impl</span> <span class="o">&amp;&amp;</span><span class="n">self</span><span class="p">)</span>
+  <span class="p">{</span>
+    <span class="k">if</span><span class="p">(</span><span class="o">!</span><span class="n">base</span><span class="o">::</span><span class="n">_has_exception</span><span class="p">(</span><span class="n">std</span><span class="o">::</span><span class="n">forward</span><span class="o">&lt;</span><span class="n">Impl</span><span class="o">&gt;</span><span class="p">(</span><span class="n">self</span><span class="p">)))</span>
+      <span class="n">std</span><span class="o">::</span><span class="n">abort</span><span class="p">();</span>
+  <span class="p">}</span>
+<span class="p">};</span>
+</code></pre></div><a href="https://github.com/boostorg/outcome/tree/master/doc/src/snippets/policies.cpp#L36" class="code-snippet-url" target="_blank">View this code on Github</a></div>
+
+
+<p>All policies ought to inherit from <a href="../../../reference/policies/base.html" class="api-reference"><code>base</code></a>
+ in order to provide your policy implementation with
+the internal policy API for accessing and manipulating <code>result</code> and <code>outcome</code> state.</p>
+
+<p>Once the policy is defined, you have to specify it when providing your own
+<code>basic_outcome</code> specialization:</p>
+
+<div class="code-snippet"><div class="highlight"><pre class="chroma"><code class="language-c++" data-lang="c++"><span class="k">template</span> <span class="o">&lt;</span><span class="k">typename</span> <span class="n">T</span><span class="o">&gt;</span>
+<span class="k">using</span> <span class="n">strictOutcome</span> <span class="o">=</span>  <span class="c1">//
+</span><span class="c1"></span><span class="n">outcome</span><span class="o">::</span><span class="n">basic_outcome</span><span class="o">&lt;</span><span class="n">T</span><span class="p">,</span> <span class="n">std</span><span class="o">::</span><span class="n">error_code</span><span class="p">,</span> <span class="n">std</span><span class="o">::</span><span class="n">exception_ptr</span><span class="p">,</span> <span class="n">abort_policy</span><span class="o">&gt;</span><span class="p">;</span>
+</code></pre></div><a href="https://github.com/boostorg/outcome/tree/master/doc/src/snippets/policies.cpp#L94" class="code-snippet-url" target="_blank">View this code on Github</a></div>
+
+
+
+        </div><p><small>Last revised: February 08, 2019 at 22:18:08 UTC</small></p>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../../../tutorial/essential/no-value.html"><img src="../../../images/prev.png" alt="Prev"></a>
+    <a accesskey="u" href="../../../tutorial/essential/no-value.html"><img src="../../../images/up.png" alt="Up"></a>
+    <a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="../../../tutorial/essential/no-value/builtin.html"><img src="../../../images/next.png" alt="Next"></a></div></body>
+</html>