Imported Upstream version 1.72.0

[platform/upstream/boost.git] / libs / outcome / doc / html / reference / macros / tryv.html
diff --git a/libs/outcome/doc/html/reference/macros/tryv.html b/libs/outcome/doc/html/reference/macros/tryv.html

index 214b879..520b6e3 100644 (file)
--- a/libs/outcome/doc/html/reference/macros/tryv.html
+++ b/libs/outcome/doc/html/reference/macros/tryv.html
@@ -9,7 +9,7 @@
  <body><div class="spirit-nav">
  <a accesskey="p" href="../../reference/macros/try.html"><img src="../../images/prev.png" alt="Prev"></a>
      <a accesskey="u" href="../../reference/macros.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="../../reference/macros/tryx.html"><img src="../../images/next.png" alt="Next"></a></div><div id="content">
+    <a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../../reference/macros/tryv_failure_likely.html"><img src="../../images/next.png" alt="Next"></a></div><div id="content">
    <div class="titlepage"><div><div><h1 style="clear: both"><code>BOOST_OUTCOME_TRYV(expr)/BOOST_OUTCOME_TRY(expr)</code></h1></div></div></div>
    <p>Evaluate an expression which results in a type matching the following customisation points, continuing execution if successful, immediately returning <a href="../../reference/functions/try_operation_return_as.html" class="api-reference"><code>try_operation_return_as(X)</code></a>
   from the calling function if unsuccessful:</p>
@@ -28,6 +28,9 @@
  <p>The difference between the <code>BOOST_OUTCOME_TRYV(expr)</code> and <code>BOOST_OUTCOME_TRY(expr)</code> editions is that the latter will set a variable if two or more macro arguments are present (see <a href="../../reference/macros/try.html" class="api-reference"><code>BOOST_OUTCOME_TRY(var, expr)</code></a>
  ). The former requires the <code>T</code> to be <code>void</code>.</p>
  
+<p>Hints are given to the compiler that the expression will be successful. If you expect failure, you should use <a href="../../reference/macros/tryv_failure_likely.html" class="api-reference"><code>BOOST_OUTCOME_TRYV_FAILURE_LIKELY(expr)</code></a>
+ instead.</p>
+
  <p><em>Overridable</em>: Not overridable.</p>
  
  <p><em>Definition</em>: Firstly the expression&rsquo;s temporary is bound to a uniquely named, stack allocated, <code>auto &amp;&amp;</code>. If that reference&rsquo;s bound object&rsquo;s <code>try_operation_has_value()</code> is false, immediately execute <code>return try_operation_return_as(propagated unique reference);</code>, propagating the rvalue/lvalue/etc-ness of the original expression.</p>
@@ -35,10 +38,10 @@
  <p><em>Header</em>: <code>&lt;boost/outcome/try.hpp&gt;</code></p>
  
  
-        </div><p><small>Last revised: June 21, 2019 at 21:45:08 &#43;0100</small></p>
+        </div><p><small>Last revised: October 16, 2019 at 10:26:35 &#43;0100</small></p>
  <hr>
  <div class="spirit-nav">
  <a accesskey="p" href="../../reference/macros/try.html"><img src="../../images/prev.png" alt="Prev"></a>
      <a accesskey="u" href="../../reference/macros.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="../../reference/macros/tryx.html"><img src="../../images/next.png" alt="Next"></a></div></body>
+    <a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../../reference/macros/tryv_failure_likely.html"><img src="../../images/next.png" alt="Next"></a></div></body>
  </html>