as_failure_rvalue.html 2.5 KB

12345678910111213141516171819202122232425262728293031
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <html><meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  3. <title>auto as_failure() &amp;&amp; - Boost.Outcome documentation</title>
  4. <link rel="stylesheet" href="../../../css/boost.css" type="text/css">
  5. <meta name="generator" content="Hugo 0.52 with Boostdoc theme">
  6. <meta name="viewport" content="width=device-width,initial-scale=1.0"/>
  7. <link rel="icon" href="../../../images/favicon.ico" type="image/ico"/>
  8. <body><div class="spirit-nav">
  9. <a accesskey="p" href="../../../reference/types/basic_result/as_failure_lvalue.html"><img src="../../../images/prev.png" alt="Prev"></a>
  10. <a accesskey="u" href="../../../reference/types/basic_result.html"><img src="../../../images/up.png" alt="Up"></a>
  11. <a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="../../../reference/types/bad_outcome_access.html"><img src="../../../images/next.png" alt="Next"></a></div><div id="content">
  12. <div class="titlepage"><div><div><h1 style="clear: both"><code>auto as_failure() &amp;&amp;</code></h1></div></div></div>
  13. <p>Return the output from free function <a href="../../../reference/functions/failure.html" class="api-reference"><code>auto failure(T &amp;&amp;, ...)</code></a>
  14. containing a move from any errored state, thus leaving the result&rsquo;s error value in a moved-from state. Depending on the choice of <code>error_type</code>, this function may therefore be destructive. The error state is accessed using <a href="../../../reference/types/basic_outcome/assume_error_rvalue.html" class="api-reference"><code>error_type &amp;&amp;assume_error() &amp;&amp; noexcept</code></a>
  15. .</p>
  16. <p><em>Requires</em>: Always available.</p>
  17. <p><em>Complexity</em>: Whatever that of <code>error_type</code>&rsquo;s move constructor is.</p>
  18. <p><em>Guarantees</em>: None.</p>
  19. </div><p><small>Last revised: January 24, 2019 at 01:15:16 UTC</small></p>
  20. <hr>
  21. <div class="spirit-nav">
  22. <a accesskey="p" href="../../../reference/types/basic_result/as_failure_lvalue.html"><img src="../../../images/prev.png" alt="Prev"></a>
  23. <a accesskey="u" href="../../../reference/types/basic_result.html"><img src="../../../images/up.png" alt="Up"></a>
  24. <a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="../../../reference/types/bad_outcome_access.html"><img src="../../../images/next.png" alt="Next"></a></div></body>
  25. </html>