[DEV] add v1.76.0

This commit is contained in:
2021-10-05 21:37:46 +02:00
parent a97e9ae7d4
commit d0115b733d
45133 changed files with 4744437 additions and 1026325 deletions

View File

@@ -0,0 +1,47 @@
<!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>std::error_code error_from_exception(std::exception_ptr &amp;&amp;ep = std::current_exception(), std::error_code not_matched = std::make_error_code(std::errc::resource_unavailable_try_again)) noexcept - 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="../../reference/functions/try_operation_return_as.html"><img src="../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../reference/functions.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/functions/strong_swap.html"><img src="../../images/next.png" alt="Next"></a></div><div id="content">
<div class="titlepage"><div><div><h1 style="clear: both"><code>std::error_code error_from_exception(std::exception_ptr &amp;&amp;ep = std::current_exception(), std::error_code not_matched = std::make_error_code(std::errc::resource_unavailable_try_again)) noexcept</code></h1></div></div></div>
<p>This function saves writing boilerplate by rethrowing <code>ep</code> within a <code>try</code>
block, with a long sequence of <code>catch()</code> handlers, one for every standard
C++ exception type which has a near or exact equivalent code in
<a href="https://en.cppreference.com/w/cpp/error/errc" class="api-reference" target="_blank"><i class="fa fa-book" aria-hidden="true"></i> <code>std::errc</code></a>
.</p>
<p>If matched, <code>ep</code> is set to a default constructed
<a href="https://en.cppreference.com/w/cpp/error/exception_ptr" class="api-reference" target="_blank"><i class="fa fa-book" aria-hidden="true"></i> <code>std::exception_ptr</code></a>
,
and a
<a href="https://en.cppreference.com/w/cpp/error/error_code" class="api-reference" target="_blank"><i class="fa fa-book" aria-hidden="true"></i> <code>std::error_code</code></a>
is constructed using the ADL discovered free
function <code>make_error_code()</code> upon the <code>std::errc</code> enumeration value matching the
thrown exception.</p>
<p>If not matched, <code>ep</code> is left intact, and the <code>not_matched</code> error code supplied
is returned instead.</p>
<p><em>Overridable</em>: Not overridable.</p>
<p><em>Requires</em>: C++ exceptions to be globally enabled.</p>
<p><em>Namespace</em>: <code>BOOST_OUTCOME_V2_NAMESPACE</code></p>
<p><em>Header</em>: <code>&lt;boost/outcome/utils.hpp&gt;</code></p>
</div><p><small>Last revised: February 01, 2019 at 23:42:52 UTC</small></p>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../../reference/functions/try_operation_return_as.html"><img src="../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../reference/functions.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/functions/strong_swap.html"><img src="../../images/next.png" alt="Next"></a></div></body>
</html>

View File

@@ -0,0 +1,38 @@
<!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>auto failure(T &amp;&amp;, &hellip;) - 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="../../reference/functions/policy/outcome_throw_as_system_error_with_payload_std_error_code.html"><img src="../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../reference/functions.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/functions/success.html"><img src="../../images/next.png" alt="Next"></a></div><div id="content">
<div class="titlepage"><div><div><h1 style="clear: both"><code>auto failure(T &amp;&amp;, ...)</code></h1></div></div></div>
<p>Returns appropriate type sugar for constructing an unsuccessful result or outcome, usually <a href="../../reference/types/failure_type.html" class="api-reference"><code>failure_type&lt;EC, EP = void&gt;</code></a>
with a decayed <code>T</code>.</p>
<p>Two default overloads are provided, one taking a single required parameter with optional spare storage value parameter returning <code>failure_type&lt;std::decay_t&lt;T&gt;&gt;</code>, the other taking two required parameters with optional spare storage value parameter returning <code>failure_type&lt;std::decay_t&lt;T&gt;, std::decay_t&lt;U&gt;&gt;</code>. Both overloads perfectly forward their inputs.</p>
<p>Note that <code>failure()</code> overloads are permitted by Outcome to return something other than <code>failure_type</code>. For example, <code>basic_result</code>&rsquo;s <a href="../../reference/types/basic_result/as_failure_lvalue.html" class="api-reference"><code>auto as_failure() const &amp;</code></a>
returns whatever type <code>failure()</code> returns, and <a href="../../reference/macros/try.html" class="api-reference"><code>BOOST_OUTCOME_TRY(var, expr)</code></a>
by default returns for failure whatever <code>.as_failure()</code> returns. This can be useful to have <code>BOOST_OUTCOME_TRY(...}</code> propagate on failure something custom for some specific input <code>basic_result</code> or <code>basic_outcome</code>.</p>
<p><em>Overridable</em>: By Argument Dependent Lookup (ADL).</p>
<p><em>Requires</em>: Always available.</p>
<p><em>Namespace</em>: <code>BOOST_OUTCOME_V2_NAMESPACE</code></p>
<p><em>Header</em>: <code>&lt;boost/outcome/success_failure.hpp&gt;</code></p>
</div><p><small>Last revised: February 23, 2021 at 17:37:27 UTC</small></p>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../../reference/functions/policy/outcome_throw_as_system_error_with_payload_std_error_code.html"><img src="../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../reference/functions.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/functions/success.html"><img src="../../images/next.png" alt="Next"></a></div></body>
</html>

View File

@@ -0,0 +1,58 @@
<!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>Hooks - 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="../../reference/functions.html"><img src="../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../reference/functions.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/functions/hooks/spare_storage.html"><img src="../../images/next.png" alt="Next"></a></div><div id="content">
<div class="titlepage"><div><div><h1 style="clear: both">Hooks</h1></div></div></div>
<ol class="children children-li"><li>
<a href="../../reference/functions/hooks/spare_storage.html" ><code>uint16_t spare_storage(const basic_result|basic_outcome *) noexcept</code></a>
<p>Returns the sixteen bits of spare storage in the specified result or outcome.</p><li>
<a href="../../reference/functions/hooks/hook_outcome_construction.html" ><code>void hook_outcome_construction(T *, U &amp;&amp;) noexcept</code></a>
<p>(Until v2.2.0) ADL discovered free function hook invoked by the implicit constructors of <code>basic_outcome</code>.</p><li>
<a href="../../reference/functions/hooks/hook_outcome_construction2.html" ><code>void hook_outcome_construction(T *, U &amp;&amp;, V &amp;&amp;) noexcept</code></a>
<p>(Until v2.2.0) ADL discovered free function hook invoked by the implicit constructors of <code>basic_outcome</code>.</p><li>
<a href="../../reference/functions/hooks/hook_outcome_copy_construction.html" ><code>void hook_outcome_copy_construction(T *, U &amp;&amp;) noexcept</code></a>
<p>(Until v2.2.0) ADL discovered free function hook invoked by the converting copy constructors of <code>basic_outcome</code>.</p><li>
<a href="../../reference/functions/hooks/hook_outcome_copy_construction2.html" ><code>void hook_outcome_copy_construction(T *, U &amp;&amp;, V &amp;&amp;) noexcept</code></a>
<p>(Until v2.2.0) ADL discovered free function hook invoked by the converting copy constructors of <code>basic_outcome</code>.</p><li>
<a href="../../reference/functions/hooks/hook_outcome_in_place_construction.html" ><code>void hook_outcome_in_place_construction(T *, in_place_type_t&lt;U&gt;, Args &amp;&amp;...) noexcept</code></a>
<p>(Until v2.2.0) ADL discovered free function hook invoked by the in-place constructors of <code>basic_outcome</code>.</p><li>
<a href="../../reference/functions/hooks/hook_outcome_move_construction.html" ><code>void hook_outcome_move_construction(T *, U &amp;&amp;) noexcept</code></a>
<p>(Until v2.2.0) ADL discovered free function hook invoked by the converting move constructors of <code>basic_outcome</code>.</p><li>
<a href="../../reference/functions/hooks/hook_outcome_move_construction2.html" ><code>void hook_outcome_move_construction(T *, U &amp;&amp;, V &amp;&amp;) noexcept</code></a>
<p>(Until v2.2.0) ADL discovered free function hook invoked by the converting move constructors of <code>basic_outcome</code>.</p><li>
<a href="../../reference/functions/hooks/hook_result_construction.html" ><code>void hook_result_construction(T *, U &amp;&amp;) noexcept</code></a>
<p>(Until v2.2.0) ADL discovered free function hook invoked by the implicit constructors of <code>basic_result</code>.</p><li>
<a href="../../reference/functions/hooks/hook_result_copy_construction.html" ><code>void hook_result_copy_construction(T *, U &amp;&amp;) noexcept</code></a>
<p>(Until v2.2.0) ADL discovered free function hook invoked by the converting copy constructors of <code>basic_result</code>.</p><li>
<a href="../../reference/functions/hooks/hook_result_in_place_construction.html" ><code>void hook_result_in_place_construction(T *, in_place_type_t&lt;U&gt;, Args &amp;&amp;...) noexcept</code></a>
<p>(Until v2.2.0) ADL discovered free function hook invoked by the in-place constructors of <code>basic_result</code>.</p><li>
<a href="../../reference/functions/hooks/hook_result_move_construction.html" ><code>void hook_result_move_construction(T *, U &amp;&amp;) noexcept</code></a>
<p>(Until v2.2.0) ADL discovered free function hook invoked by the converting move constructors of <code>basic_result</code>.</p><li>
<a href="../../reference/functions/hooks/override_outcome_exception.html" ><code>void override_outcome_exception(basic_outcome&lt;T, EC, EP, NoValuePolicy&gt; *, U &amp;&amp;) noexcept</code></a>
<p>Overrides the exception to something other than what was constructed.</p><li>
<a href="../../reference/functions/hooks/set_spare_storage.html" ><code>void set_spare_storage(basic_result|basic_outcome *, uint16_t) noexcept</code></a>
<p>Sets the sixteen bits of spare storage in the specified result or outcome.</p></li></ol>
</div><p><small>Last revised: January 22, 2019 at 01:11:40 UTC</small></p>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../../reference/functions.html"><img src="../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../reference/functions.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/functions/hooks/spare_storage.html"><img src="../../images/next.png" alt="Next"></a></div></body>
</html>

View File

@@ -0,0 +1,37 @@
<!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>void hook_outcome_construction(T *, U &amp;&amp;) noexcept - 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="../../../reference/functions/hooks/spare_storage.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/hooks.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/functions/hooks/hook_outcome_construction2.html"><img src="../../../images/next.png" alt="Next"></a></div><div id="content">
<div class="titlepage"><div><div><h1 style="clear: both"><code>void hook_outcome_construction(T *, U &amp;&amp;) noexcept</code></h1></div></div></div>
<p>Removed in Outcome v2.2.0, unless <a href="../../../reference/macros/enable_legacy_support_for.html" class="api-reference"><code>BOOST_OUTCOME_ENABLE_LEGACY_SUPPORT_FOR</code></a>
is set to less than <code>220</code> to
enable emulation. Use <a href="../../../reference/policies/base/on_outcome_construction.html" class="api-reference"><code>on_outcome_construction(T *, U &amp;&amp;) noexcept</code></a>
instead in new code.</p>
<p>One of the constructor hooks for <a href="../../../reference/types/basic_outcome.html" class="api-reference"><code>basic_outcome&lt;T, EC, EP, NoValuePolicy&gt;</code></a>
, generally invoked by the implicit constructors of <code>basic_outcome</code>. See each constructor&rsquo;s documentation to see which specific hook it invokes.</p>
<p><em>Overridable</em>: By Argument Dependent Lookup.</p>
<p><em>Requires</em>: Nothing.</p>
<p><em>Namespace</em>: <code>BOOST_OUTCOME_V2_NAMESPACE::hooks</code></p>
<p><em>Header</em>: <code>&lt;boost/outcome/basic_outcome.hpp&gt;</code></p>
</div><p><small>Last revised: August 19, 2020 at 12:15:40 &#43;0100</small></p>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../../../reference/functions/hooks/spare_storage.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/hooks.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/functions/hooks/hook_outcome_construction2.html"><img src="../../../images/next.png" alt="Next"></a></div></body>
</html>

View File

@@ -0,0 +1,37 @@
<!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>void hook_outcome_construction(T *, U &amp;&amp;, V &amp;&amp;) noexcept - 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="../../../reference/functions/hooks/hook_outcome_construction.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/hooks.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/functions/hooks/hook_outcome_copy_construction.html"><img src="../../../images/next.png" alt="Next"></a></div><div id="content">
<div class="titlepage"><div><div><h1 style="clear: both"><code>void hook_outcome_construction(T *, U &amp;&amp;, V &amp;&amp;) noexcept</code></h1></div></div></div>
<p>Removed in Outcome v2.2.0, unless <a href="../../../reference/macros/enable_legacy_support_for.html" class="api-reference"><code>BOOST_OUTCOME_ENABLE_LEGACY_SUPPORT_FOR</code></a>
is set to less than <code>220</code> to
enable emulation. Use <a href="../../../reference/policies/base/on_outcome_construction2.html" class="api-reference"><code>on_outcome_construction(T *, U &amp;&amp;, V &amp;&amp;) noexcept</code></a>
instead in new code.</p>
<p>One of the constructor hooks for <a href="../../../reference/types/basic_outcome.html" class="api-reference"><code>basic_outcome&lt;T, EC, EP, NoValuePolicy&gt;</code></a>
, generally invoked by the implicit constructors of <code>basic_outcome</code> which consume two arguments. See each constructor&rsquo;s documentation to see which specific hook it invokes.</p>
<p><em>Overridable</em>: By Argument Dependent Lookup.</p>
<p><em>Requires</em>: Nothing.</p>
<p><em>Namespace</em>: <code>BOOST_OUTCOME_V2_NAMESPACE::hooks</code></p>
<p><em>Header</em>: <code>&lt;boost/outcome/basic_outcome.hpp&gt;</code></p>
</div><p><small>Last revised: August 19, 2020 at 12:15:40 &#43;0100</small></p>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../../../reference/functions/hooks/hook_outcome_construction.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/hooks.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/functions/hooks/hook_outcome_copy_construction.html"><img src="../../../images/next.png" alt="Next"></a></div></body>
</html>

View File

@@ -0,0 +1,37 @@
<!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>void hook_outcome_copy_construction(T *, U &amp;&amp;) noexcept - 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="../../../reference/functions/hooks/hook_outcome_construction2.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/hooks.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/functions/hooks/hook_outcome_copy_construction2.html"><img src="../../../images/next.png" alt="Next"></a></div><div id="content">
<div class="titlepage"><div><div><h1 style="clear: both"><code>void hook_outcome_copy_construction(T *, U &amp;&amp;) noexcept</code></h1></div></div></div>
<p>Removed in Outcome v2.2.0, unless <a href="../../../reference/macros/enable_legacy_support_for.html" class="api-reference"><code>BOOST_OUTCOME_ENABLE_LEGACY_SUPPORT_FOR</code></a>
is set to less than <code>220</code> to
enable emulation. Use <a href="../../../reference/policies/base/on_outcome_copy_construction.html" class="api-reference"><code>on_outcome_copy_construction(T *, U &amp;&amp;) noexcept</code></a>
instead in new code.</p>
<p>One of the constructor hooks for <a href="../../../reference/types/basic_outcome.html" class="api-reference"><code>basic_outcome&lt;T, EC, EP, NoValuePolicy&gt;</code></a>
, generally invoked by the converting copy constructors of <code>basic_outcome</code> (NOT the standard copy constructor). See each constructor&rsquo;s documentation to see which specific hook it invokes.</p>
<p><em>Overridable</em>: By Argument Dependent Lookup.</p>
<p><em>Requires</em>: Nothing.</p>
<p><em>Namespace</em>: <code>BOOST_OUTCOME_V2_NAMESPACE::hooks</code></p>
<p><em>Header</em>: <code>&lt;boost/outcome/basic_outcome.hpp&gt;</code></p>
</div><p><small>Last revised: August 19, 2020 at 12:15:40 &#43;0100</small></p>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../../../reference/functions/hooks/hook_outcome_construction2.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/hooks.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/functions/hooks/hook_outcome_copy_construction2.html"><img src="../../../images/next.png" alt="Next"></a></div></body>
</html>

View File

@@ -0,0 +1,37 @@
<!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>void hook_outcome_copy_construction(T *, U &amp;&amp;, V &amp;&amp;) noexcept - 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="../../../reference/functions/hooks/hook_outcome_copy_construction.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/hooks.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/functions/hooks/hook_outcome_in_place_construction.html"><img src="../../../images/next.png" alt="Next"></a></div><div id="content">
<div class="titlepage"><div><div><h1 style="clear: both"><code>void hook_outcome_copy_construction(T *, U &amp;&amp;, V &amp;&amp;) noexcept</code></h1></div></div></div>
<p>Removed in Outcome v2.2.0, unless <a href="../../../reference/macros/enable_legacy_support_for.html" class="api-reference"><code>BOOST_OUTCOME_ENABLE_LEGACY_SUPPORT_FOR</code></a>
is set to less than <code>220</code> to
enable emulation. Use <a href="../../../reference/policies/base/on_outcome_copy_construction2.html" class="api-reference"><code>on_outcome_copy_construction(T *, U &amp;&amp;, V &amp;&amp;) noexcept</code></a>
instead in new code.</p>
<p>One of the constructor hooks for <a href="../../../reference/types/basic_outcome.html" class="api-reference"><code>basic_outcome&lt;T, EC, EP, NoValuePolicy&gt;</code></a>
, generally invoked by the converting copy constructors of <code>basic_outcome</code> (NOT the standard copy constructor) which consume two arguments. See each constructor&rsquo;s documentation to see which specific hook it invokes.</p>
<p><em>Overridable</em>: By Argument Dependent Lookup.</p>
<p><em>Requires</em>: Nothing.</p>
<p><em>Namespace</em>: <code>BOOST_OUTCOME_V2_NAMESPACE::hooks</code></p>
<p><em>Header</em>: <code>&lt;boost/outcome/basic_outcome.hpp&gt;</code></p>
</div><p><small>Last revised: August 19, 2020 at 12:15:40 &#43;0100</small></p>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../../../reference/functions/hooks/hook_outcome_copy_construction.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/hooks.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/functions/hooks/hook_outcome_in_place_construction.html"><img src="../../../images/next.png" alt="Next"></a></div></body>
</html>

View File

@@ -0,0 +1,37 @@
<!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>void hook_outcome_in_place_construction(T *, in_place_type_t&lt;U&gt;, Args &amp;&amp;&hellip;) noexcept - 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="../../../reference/functions/hooks/hook_outcome_copy_construction2.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/hooks.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/functions/hooks/hook_outcome_move_construction.html"><img src="../../../images/next.png" alt="Next"></a></div><div id="content">
<div class="titlepage"><div><div><h1 style="clear: both"><code>void hook_outcome_in_place_construction(T *, in_place_type_t&lt;U&gt;, Args &amp;&amp;...) noexcept</code></h1></div></div></div>
<p>Removed in Outcome v2.2.0, unless <a href="../../../reference/macros/enable_legacy_support_for.html" class="api-reference"><code>BOOST_OUTCOME_ENABLE_LEGACY_SUPPORT_FOR</code></a>
is set to less than <code>220</code> to
enable emulation. Use <a href="../../../reference/policies/base/on_outcome_in_place_construction.html" class="api-reference"><code>on_outcome_in_place_construction(T *, in_place_type_t&lt;U&gt;, Args &amp;&amp;...) noexcept</code></a>
instead in new code.</p>
<p>One of the constructor hooks for <a href="../../../reference/types/basic_outcome.html" class="api-reference"><code>basic_outcome&lt;T, EC, EP, NoValuePolicy&gt;</code></a>
, generally invoked by the in-place constructors of <code>basic_outcome</code>. See each constructor&rsquo;s documentation to see which specific hook it invokes.</p>
<p><em>Overridable</em>: By Argument Dependent Lookup.</p>
<p><em>Requires</em>: Nothing.</p>
<p><em>Namespace</em>: <code>BOOST_OUTCOME_V2_NAMESPACE::hooks</code></p>
<p><em>Header</em>: <code>&lt;boost/outcome/basic_outcome.hpp&gt;</code></p>
</div><p><small>Last revised: August 19, 2020 at 12:15:40 &#43;0100</small></p>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../../../reference/functions/hooks/hook_outcome_copy_construction2.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/hooks.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/functions/hooks/hook_outcome_move_construction.html"><img src="../../../images/next.png" alt="Next"></a></div></body>
</html>

View File

@@ -0,0 +1,37 @@
<!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>void hook_outcome_move_construction(T *, U &amp;&amp;) noexcept - 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="../../../reference/functions/hooks/hook_outcome_in_place_construction.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/hooks.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/functions/hooks/hook_outcome_move_construction2.html"><img src="../../../images/next.png" alt="Next"></a></div><div id="content">
<div class="titlepage"><div><div><h1 style="clear: both"><code>void hook_outcome_move_construction(T *, U &amp;&amp;) noexcept</code></h1></div></div></div>
<p>Removed in Outcome v2.2.0, unless <a href="../../../reference/macros/enable_legacy_support_for.html" class="api-reference"><code>BOOST_OUTCOME_ENABLE_LEGACY_SUPPORT_FOR</code></a>
is set to less than <code>220</code> to
enable emulation. Use <a href="../../../reference/policies/base/on_outcome_move_construction.html" class="api-reference"><code>on_outcome_move_construction(T *, U &amp;&amp;) noexcept</code></a>
instead in new code.</p>
<p>One of the constructor hooks for <a href="../../../reference/types/basic_outcome.html" class="api-reference"><code>basic_outcome&lt;T, EC, EP, NoValuePolicy&gt;</code></a>
, generally invoked by the converting move constructors of <code>basic_outcome</code> (NOT the standard move constructor). See each constructor&rsquo;s documentation to see which specific hook it invokes.</p>
<p><em>Overridable</em>: By Argument Dependent Lookup.</p>
<p><em>Requires</em>: Nothing.</p>
<p><em>Namespace</em>: <code>BOOST_OUTCOME_V2_NAMESPACE::hooks</code></p>
<p><em>Header</em>: <code>&lt;boost/outcome/basic_outcome.hpp&gt;</code></p>
</div><p><small>Last revised: August 19, 2020 at 12:15:40 &#43;0100</small></p>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../../../reference/functions/hooks/hook_outcome_in_place_construction.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/hooks.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/functions/hooks/hook_outcome_move_construction2.html"><img src="../../../images/next.png" alt="Next"></a></div></body>
</html>

View File

@@ -0,0 +1,37 @@
<!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>void hook_outcome_move_construction(T *, U &amp;&amp;, V &amp;&amp;) noexcept - 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="../../../reference/functions/hooks/hook_outcome_move_construction.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/hooks.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/functions/hooks/hook_result_construction.html"><img src="../../../images/next.png" alt="Next"></a></div><div id="content">
<div class="titlepage"><div><div><h1 style="clear: both"><code>void hook_outcome_move_construction(T *, U &amp;&amp;, V &amp;&amp;) noexcept</code></h1></div></div></div>
<p>Removed in Outcome v2.2.0, unless <a href="../../../reference/macros/enable_legacy_support_for.html" class="api-reference"><code>BOOST_OUTCOME_ENABLE_LEGACY_SUPPORT_FOR</code></a>
is set to less than <code>220</code> to
enable emulation. Use <a href="../../../reference/policies/base/on_outcome_move_construction2.html" class="api-reference"><code>on_outcome_move_construction(T *, U &amp;&amp;, V &amp;&amp;) noexcept</code></a>
instead in new code.</p>
<p>One of the constructor hooks for <a href="../../../reference/types/basic_outcome.html" class="api-reference"><code>basic_outcome&lt;T, EC, EP, NoValuePolicy&gt;</code></a>
, generally invoked by the converting move constructors of <code>basic_outcome</code> (NOT the standard move constructor) which consume two arguments. See each constructor&rsquo;s documentation to see which specific hook it invokes.</p>
<p><em>Overridable</em>: By Argument Dependent Lookup.</p>
<p><em>Requires</em>: Nothing.</p>
<p><em>Namespace</em>: <code>BOOST_OUTCOME_V2_NAMESPACE::hooks</code></p>
<p><em>Header</em>: <code>&lt;boost/outcome/basic_outcome.hpp&gt;</code></p>
</div><p><small>Last revised: August 19, 2020 at 12:15:40 &#43;0100</small></p>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../../../reference/functions/hooks/hook_outcome_move_construction.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/hooks.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/functions/hooks/hook_result_construction.html"><img src="../../../images/next.png" alt="Next"></a></div></body>
</html>

View File

@@ -0,0 +1,37 @@
<!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>void hook_result_construction(T *, U &amp;&amp;) noexcept - 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="../../../reference/functions/hooks/hook_outcome_move_construction2.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/hooks.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/functions/hooks/hook_result_copy_construction.html"><img src="../../../images/next.png" alt="Next"></a></div><div id="content">
<div class="titlepage"><div><div><h1 style="clear: both"><code>void hook_result_construction(T *, U &amp;&amp;) noexcept</code></h1></div></div></div>
<p>Removed in Outcome v2.2.0, unless <a href="../../../reference/macros/enable_legacy_support_for.html" class="api-reference"><code>BOOST_OUTCOME_ENABLE_LEGACY_SUPPORT_FOR</code></a>
is set to less than <code>220</code> to
enable emulation. Use <a href="../../../reference/policies/base/on_result_construction.html" class="api-reference"><code>on_result_construction(T *, U &amp;&amp;) noexcept</code></a>
instead in new code.</p>
<p>One of the constructor hooks for <a href="../../../reference/types/basic_result.html" class="api-reference"><code>basic_result&lt;T, E, NoValuePolicy&gt;</code></a>
, generally invoked by the implicit constructors of <code>basic_result</code>. See each constructor&rsquo;s documentation to see which specific hook it invokes.</p>
<p><em>Overridable</em>: By Argument Dependent Lookup.</p>
<p><em>Requires</em>: Nothing.</p>
<p><em>Namespace</em>: <code>BOOST_OUTCOME_V2_NAMESPACE::hooks</code></p>
<p><em>Header</em>: <code>&lt;boost/outcome/basic_result.hpp&gt;</code></p>
</div><p><small>Last revised: August 19, 2020 at 12:15:40 &#43;0100</small></p>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../../../reference/functions/hooks/hook_outcome_move_construction2.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/hooks.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/functions/hooks/hook_result_copy_construction.html"><img src="../../../images/next.png" alt="Next"></a></div></body>
</html>

View File

@@ -0,0 +1,37 @@
<!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>void hook_result_copy_construction(T *, U &amp;&amp;) noexcept - 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="../../../reference/functions/hooks/hook_result_construction.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/hooks.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/functions/hooks/hook_result_in_place_construction.html"><img src="../../../images/next.png" alt="Next"></a></div><div id="content">
<div class="titlepage"><div><div><h1 style="clear: both"><code>void hook_result_copy_construction(T *, U &amp;&amp;) noexcept</code></h1></div></div></div>
<p>Removed in Outcome v2.2.0, unless <a href="../../../reference/macros/enable_legacy_support_for.html" class="api-reference"><code>BOOST_OUTCOME_ENABLE_LEGACY_SUPPORT_FOR</code></a>
is set to less than <code>220</code> to
enable emulation. Use <a href="../../../reference/policies/base/on_result_copy_construction.html" class="api-reference"><code>on_result_copy_construction(T *, U &amp;&amp;) noexcept</code></a>
instead in new code.</p>
<p>One of the constructor hooks for <a href="../../../reference/types/basic_result.html" class="api-reference"><code>basic_result&lt;T, E, NoValuePolicy&gt;</code></a>
, generally invoked by the converting copy constructors of <code>basic_result</code> (NOT the standard copy constructor). See each constructor&rsquo;s documentation to see which specific hook it invokes.</p>
<p><em>Overridable</em>: By Argument Dependent Lookup.</p>
<p><em>Requires</em>: Nothing.</p>
<p><em>Namespace</em>: <code>BOOST_OUTCOME_V2_NAMESPACE::hooks</code></p>
<p><em>Header</em>: <code>&lt;boost/outcome/basic_result.hpp&gt;</code></p>
</div><p><small>Last revised: August 19, 2020 at 12:15:40 &#43;0100</small></p>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../../../reference/functions/hooks/hook_result_construction.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/hooks.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/functions/hooks/hook_result_in_place_construction.html"><img src="../../../images/next.png" alt="Next"></a></div></body>
</html>

View File

@@ -0,0 +1,37 @@
<!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>void hook_result_in_place_construction(T *, in_place_type_t&lt;U&gt;, Args &amp;&amp;&hellip;) noexcept - 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="../../../reference/functions/hooks/hook_result_copy_construction.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/hooks.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/functions/hooks/hook_result_move_construction.html"><img src="../../../images/next.png" alt="Next"></a></div><div id="content">
<div class="titlepage"><div><div><h1 style="clear: both"><code>void hook_result_in_place_construction(T *, in_place_type_t&lt;U&gt;, Args &amp;&amp;...) noexcept</code></h1></div></div></div>
<p>Removed in Outcome v2.2.0, unless <a href="../../../reference/macros/enable_legacy_support_for.html" class="api-reference"><code>BOOST_OUTCOME_ENABLE_LEGACY_SUPPORT_FOR</code></a>
is set to less than <code>220</code> to
enable emulation. Use <a href="../../../reference/policies/base/on_result_in_place_construction.html" class="api-reference"><code>on_result_in_place_construction(T *, in_place_type_t&lt;U&gt;, Args &amp;&amp;...) noexcept</code></a>
instead in new code.</p>
<p>One of the constructor hooks for <a href="../../../reference/types/basic_result.html" class="api-reference"><code>basic_result&lt;T, E, NoValuePolicy&gt;</code></a>
, generally invoked by the in-place constructors of <code>basic_result</code>. See each constructor&rsquo;s documentation to see which specific hook it invokes.</p>
<p><em>Overridable</em>: By Argument Dependent Lookup.</p>
<p><em>Requires</em>: Nothing.</p>
<p><em>Namespace</em>: <code>BOOST_OUTCOME_V2_NAMESPACE::hooks</code></p>
<p><em>Header</em>: <code>&lt;boost/outcome/basic_result.hpp&gt;</code></p>
</div><p><small>Last revised: August 19, 2020 at 12:15:40 &#43;0100</small></p>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../../../reference/functions/hooks/hook_result_copy_construction.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/hooks.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/functions/hooks/hook_result_move_construction.html"><img src="../../../images/next.png" alt="Next"></a></div></body>
</html>

View File

@@ -0,0 +1,37 @@
<!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>void hook_result_move_construction(T *, U &amp;&amp;) noexcept - 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="../../../reference/functions/hooks/hook_result_in_place_construction.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/hooks.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/functions/hooks/override_outcome_exception.html"><img src="../../../images/next.png" alt="Next"></a></div><div id="content">
<div class="titlepage"><div><div><h1 style="clear: both"><code>void hook_result_move_construction(T *, U &amp;&amp;) noexcept</code></h1></div></div></div>
<p>Removed in Outcome v2.2.0, unless <a href="../../../reference/macros/enable_legacy_support_for.html" class="api-reference"><code>BOOST_OUTCOME_ENABLE_LEGACY_SUPPORT_FOR</code></a>
is set to less than <code>220</code> to
enable emulation. Use <a href="../../../reference/policies/base/on_result_move_construction.html" class="api-reference"><code>on_result_move_construction(T *, U &amp;&amp;) noexcept</code></a>
instead in new code.</p>
<p>One of the constructor hooks for <a href="../../../reference/types/basic_result.html" class="api-reference"><code>basic_result&lt;T, E, NoValuePolicy&gt;</code></a>
, generally invoked by the converting move constructors of <code>basic_result</code> (NOT the standard move constructor). See each constructor&rsquo;s documentation to see which specific hook it invokes.</p>
<p><em>Overridable</em>: By Argument Dependent Lookup.</p>
<p><em>Requires</em>: Nothing.</p>
<p><em>Namespace</em>: <code>BOOST_OUTCOME_V2_NAMESPACE::hooks</code></p>
<p><em>Header</em>: <code>&lt;boost/outcome/basic_result.hpp&gt;</code></p>
</div><p><small>Last revised: August 19, 2020 at 12:15:40 &#43;0100</small></p>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../../../reference/functions/hooks/hook_result_in_place_construction.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/hooks.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/functions/hooks/override_outcome_exception.html"><img src="../../../images/next.png" alt="Next"></a></div></body>
</html>

View File

@@ -0,0 +1,40 @@
<!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>void override_outcome_exception(basic_outcome&lt;T, EC, EP, NoValuePolicy&gt; *, U &amp;&amp;) noexcept - 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="../../../reference/functions/hooks/hook_result_move_construction.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/hooks.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/functions/hooks/set_spare_storage.html"><img src="../../../images/next.png" alt="Next"></a></div><div id="content">
<div class="titlepage"><div><div><h1 style="clear: both"><code>void override_outcome_exception(basic_outcome&lt;T, EC, EP, NoValuePolicy&gt; *, U &amp;&amp;) noexcept</code></h1></div></div></div>
<p>Overrides the exception to something other than what was constructed. You <em>almost certainly</em> never
want to use this function. A much better way of overriding the exception returned is to create
a custom no-value policy which lazily synthesises a custom exception object at the point of need.</p>
<p>The only reason that this function exists is because some people have very corner case needs
where a custom no-value policy can&rsquo;t be used, and where move-constructing a new <code>outcome</code> from
an old <code>outcome</code> with the exception state replaced isn&rsquo;t possible (e.g. when the types are
non-copyable and non-moveable).</p>
<p>Unless you are in a situation where no other viable alternative exists, do not use this function.</p>
<p><em>Overridable</em>: Not overridable.</p>
<p><em>Requires</em>: Nothing.</p>
<p><em>Namespace</em>: <code>BOOST_OUTCOME_V2_NAMESPACE::hooks</code></p>
<p><em>Header</em>: <code>&lt;boost/outcome/basic_outcome.hpp&gt;</code></p>
</div><p><small>Last revised: January 30, 2019 at 16:16:10 UTC</small></p>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../../../reference/functions/hooks/hook_result_move_construction.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/hooks.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/functions/hooks/set_spare_storage.html"><img src="../../../images/next.png" alt="Next"></a></div></body>
</html>

View File

@@ -0,0 +1,32 @@
<!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>void set_spare_storage(basic_result|basic_outcome *, uint16_t) noexcept - 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="../../../reference/functions/hooks/override_outcome_exception.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/hooks.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/functions/iostream.html"><img src="../../../images/next.png" alt="Next"></a></div><div id="content">
<div class="titlepage"><div><div><h1 style="clear: both"><code>void set_spare_storage(basic_result|basic_outcome *, uint16_t) noexcept</code></h1></div></div></div>
<p>Sets the sixteen bits of spare storage in the specified result or outcome. You can retrieve these bits later using <a href="../../../reference/functions/hooks/spare_storage.html" class="api-reference"><code>uint16_t spare_storage(const basic_result|basic_outcome *) noexcept</code></a>
.</p>
<p><em>Overridable</em>: Not overridable.</p>
<p><em>Requires</em>: Nothing.</p>
<p><em>Namespace</em>: <code>BOOST_OUTCOME_V2_NAMESPACE::hooks</code></p>
<p><em>Header</em>: <code>&lt;boost/outcome/basic_result.hpp&gt;</code></p>
</div><p><small>Last revised: January 21, 2019 at 18:00:41 UTC</small></p>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../../../reference/functions/hooks/override_outcome_exception.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/hooks.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/functions/iostream.html"><img src="../../../images/next.png" alt="Next"></a></div></body>
</html>

View File

@@ -0,0 +1,32 @@
<!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>uint16_t spare_storage(const basic_result|basic_outcome *) noexcept - 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="../../../reference/functions/hooks.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/hooks.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/functions/hooks/hook_outcome_construction.html"><img src="../../../images/next.png" alt="Next"></a></div><div id="content">
<div class="titlepage"><div><div><h1 style="clear: both"><code>uint16_t spare_storage(const basic_result|basic_outcome *) noexcept</code></h1></div></div></div>
<p>Returns the sixteen bits of spare storage in the specified result or outcome. You can set these bits using <a href="../../../reference/functions/hooks/set_spare_storage.html" class="api-reference"><code>void set_spare_storage(basic_result|basic_outcome *, uint16_t) noexcept</code></a>
.</p>
<p><em>Overridable</em>: Not overridable.</p>
<p><em>Requires</em>: Nothing.</p>
<p><em>Namespace</em>: <code>BOOST_OUTCOME_V2_NAMESPACE::hooks</code></p>
<p><em>Header</em>: <code>&lt;boost/outcome/basic_result.hpp&gt;</code></p>
</div><p><small>Last revised: January 21, 2019 at 18:00:41 UTC</small></p>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../../../reference/functions/hooks.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/hooks.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/functions/hooks/hook_outcome_construction.html"><img src="../../../images/next.png" alt="Next"></a></div></body>
</html>

View File

@@ -0,0 +1,42 @@
<!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>Iostream - 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="../../reference/functions/hooks/set_spare_storage.html"><img src="../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../reference/functions.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/functions/iostream/outcome_operator_in.html"><img src="../../images/next.png" alt="Next"></a></div><div id="content">
<div class="titlepage"><div><div><h1 style="clear: both">Iostream</h1></div></div></div>
<ol class="children children-li"><li>
<a href="../../reference/functions/iostream/outcome_operator_in.html" ><code>std::istream &amp;operator&gt;&gt;(std::istream &amp;, basic_outcome&lt;T, EC, EP, NoValuePolicy&gt; &amp;)</code></a>
<p>Deserialises a <code>basic_outcome</code> from a <code>std::istream</code>.</p><li>
<a href="../../reference/functions/iostream/result_operator_in.html" ><code>std::istream &amp;operator&gt;&gt;(std::istream &amp;, basic_result&lt;T, E, NoValuePolicy&gt; &amp;)</code></a>
<p>Deserialises a <code>basic_result</code> from a <code>std::istream</code>.</p><li>
<a href="../../reference/functions/iostream/outcome_operator_out.html" ><code>std::ostream &amp;operator&lt;&lt;(std::ostream &amp;, const basic_outcome&lt;T, EC, EP, NoValuePolicy&gt; &amp;)</code></a>
<p>Serialises a <code>basic_outcome</code> to a <code>std::ostream</code>.</p><li>
<a href="../../reference/functions/iostream/result_operator_out.html" ><code>std::ostream &amp;operator&lt;&lt;(std::ostream &amp;, const basic_result&lt;T, E, NoValuePolicy&gt; &amp;)</code></a>
<p>Serialises a <code>basic_result</code> to a <code>std::ostream</code>.</p><li>
<a href="../../reference/functions/iostream/outcome_print.html" ><code>std::string print(const basic_outcome&lt;T, EC, EP, NoValuePolicy&gt; &amp;)</code></a>
<p>Returns a string containing a human readable rendition of the <code>basic_outcome</code>.</p><li>
<a href="../../reference/functions/iostream/result_print.html" ><code>std::string print(const basic_result&lt;T, E, NoValuePolicy&gt; &amp;)</code></a>
<p>Returns a string containing a human readable rendition of the <code>basic_result</code>.</p></li></ol>
</div><p><small>Last revised: March 03, 2019 at 21:04:29 UTC</small></p>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../../reference/functions/hooks/set_spare_storage.html"><img src="../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../reference/functions.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/functions/iostream/outcome_operator_in.html"><img src="../../images/next.png" alt="Next"></a></div></body>
</html>

View File

@@ -0,0 +1,36 @@
<!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>std::istream &amp;operator&gt;&gt;(std::istream &amp;, basic_outcome&lt;T, EC, EP, NoValuePolicy&gt; &amp;) - 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="../../../reference/functions/iostream.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/iostream.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/functions/iostream/result_operator_in.html"><img src="../../../images/next.png" alt="Next"></a></div><div id="content">
<div class="titlepage"><div><div><h1 style="clear: both"><code>std::istream &amp;operator&gt;&gt;(std::istream &amp;, basic_outcome&lt;T, EC, EP, NoValuePolicy&gt; &amp;)</code></h1></div></div></div>
<p>Deserialises a <code>basic_outcome</code> from a <code>std::istream</code>.</p>
<p>Serialisation format is:</p>
<pre><code>&lt;unsigned int flags&gt;&lt;space&gt;&lt;value_type if set and not void&gt;&lt;error_type if set and not void&gt;&lt;exception_type if set and not void&gt;
</code></pre>
<p><em>Overridable</em>: Not overridable.</p>
<p><em>Requires</em>: That <code>operator&gt;&gt;</code> is a valid expression for <code>std::istream</code> and <code>T</code>, <code>EC</code> and <code>EP</code>.</p>
<p><em>Namespace</em>: <code>BOOST_OUTCOME_V2_NAMESPACE</code></p>
<p><em>Header</em>: <code>&lt;boost/outcome/iostream_support.hpp&gt;</code> (must be explicitly included manually).</p>
</div><p><small>Last revised: March 03, 2019 at 21:04:29 UTC</small></p>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../../../reference/functions/iostream.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/iostream.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/functions/iostream/result_operator_in.html"><img src="../../../images/next.png" alt="Next"></a></div></body>
</html>

View File

@@ -0,0 +1,40 @@
<!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>std::ostream &amp;operator&lt;&lt;(std::ostream &amp;, const basic_outcome&lt;T, EC, EP, NoValuePolicy&gt; &amp;) - 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="../../../reference/functions/iostream/result_operator_in.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/iostream.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/functions/iostream/result_operator_out.html"><img src="../../../images/next.png" alt="Next"></a></div><div id="content">
<div class="titlepage"><div><div><h1 style="clear: both"><code>std::ostream &amp;operator&lt;&lt;(std::ostream &amp;, const basic_outcome&lt;T, EC, EP, NoValuePolicy&gt; &amp;)</code></h1></div></div></div>
<p>Serialises a <code>basic_outcome</code> to a <code>std::ostream</code>.</p>
<p>Serialisation format is:</p>
<pre><code>&lt;unsigned int flags&gt;&lt;space&gt;&lt;value_type if set and not void&gt;&lt;error_type if set and not void&gt;&lt;exception_type if set and not void&gt;
</code></pre>
<p>This is the <strong>wrong</strong> function to use if you wish to print human readable output.
Use <a href="../../../reference/functions/iostream/outcome_print.html" class="api-reference"><code>std::string print(const basic_outcome&lt;T, EC, EP, NoValuePolicy&gt; &amp;)</code></a>
instead.</p>
<p><em>Overridable</em>: Not overridable.</p>
<p><em>Requires</em>: That <code>operator&lt;&lt;</code> is a valid expression for <code>std::ostream</code> and <code>T</code>, <code>EC</code> and <code>EP</code>.</p>
<p><em>Namespace</em>: <code>BOOST_OUTCOME_V2_NAMESPACE</code></p>
<p><em>Header</em>: <code>&lt;boost/outcome/iostream_support.hpp&gt;</code> (must be explicitly included manually).</p>
</div><p><small>Last revised: March 03, 2019 at 21:04:29 UTC</small></p>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../../../reference/functions/iostream/result_operator_in.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/iostream.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/functions/iostream/result_operator_out.html"><img src="../../../images/next.png" alt="Next"></a></div></body>
</html>

View File

@@ -0,0 +1,31 @@
<!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>std::string print(const basic_outcome&lt;T, EC, EP, NoValuePolicy&gt; &amp;) - 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="../../../reference/functions/iostream/result_operator_out.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/iostream.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/functions/iostream/result_print.html"><img src="../../../images/next.png" alt="Next"></a></div><div id="content">
<div class="titlepage"><div><div><h1 style="clear: both"><code>std::string print(const basic_outcome&lt;T, EC, EP, NoValuePolicy&gt; &amp;)</code></h1></div></div></div>
<p>Returns a string containing a human readable rendition of the <code>basic_outcome</code>.</p>
<p><em>Overridable</em>: Not overridable.</p>
<p><em>Requires</em>: Always available.</p>
<p><em>Namespace</em>: <code>BOOST_OUTCOME_V2_NAMESPACE</code></p>
<p><em>Header</em>: <code>&lt;boost/outcome/iostream_support.hpp&gt;</code> (must be explicitly included manually).</p>
</div><p><small>Last revised: March 03, 2019 at 21:04:29 UTC</small></p>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../../../reference/functions/iostream/result_operator_out.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/iostream.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/functions/iostream/result_print.html"><img src="../../../images/next.png" alt="Next"></a></div></body>
</html>

View File

@@ -0,0 +1,36 @@
<!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>std::istream &amp;operator&gt;&gt;(std::istream &amp;, basic_result&lt;T, E, NoValuePolicy&gt; &amp;) - 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="../../../reference/functions/iostream/outcome_operator_in.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/iostream.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/functions/iostream/outcome_operator_out.html"><img src="../../../images/next.png" alt="Next"></a></div><div id="content">
<div class="titlepage"><div><div><h1 style="clear: both"><code>std::istream &amp;operator&gt;&gt;(std::istream &amp;, basic_result&lt;T, E, NoValuePolicy&gt; &amp;)</code></h1></div></div></div>
<p>Deserialises a <code>basic_result</code> from a <code>std::istream</code>.</p>
<p>Serialisation format is:</p>
<pre><code>&lt;unsigned int flags&gt;&lt;space&gt;&lt;value_type if set and not void&gt;&lt;error_type if set and not void&gt;
</code></pre>
<p><em>Overridable</em>: Not overridable.</p>
<p><em>Requires</em>: That <code>operator&gt;&gt;</code> is a valid expression for <code>std::istream</code> and <code>T</code> and <code>E</code>.</p>
<p><em>Namespace</em>: <code>BOOST_OUTCOME_V2_NAMESPACE</code></p>
<p><em>Header</em>: <code>&lt;boost/outcome/iostream_support.hpp&gt;</code> (must be explicitly included manually).</p>
</div><p><small>Last revised: March 03, 2019 at 21:04:29 UTC</small></p>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../../../reference/functions/iostream/outcome_operator_in.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/iostream.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/functions/iostream/outcome_operator_out.html"><img src="../../../images/next.png" alt="Next"></a></div></body>
</html>

View File

@@ -0,0 +1,40 @@
<!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>std::ostream &amp;operator&lt;&lt;(std::ostream &amp;, const basic_result&lt;T, E, NoValuePolicy&gt; &amp;) - 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="../../../reference/functions/iostream/outcome_operator_out.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/iostream.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/functions/iostream/outcome_print.html"><img src="../../../images/next.png" alt="Next"></a></div><div id="content">
<div class="titlepage"><div><div><h1 style="clear: both"><code>std::ostream &amp;operator&lt;&lt;(std::ostream &amp;, const basic_result&lt;T, E, NoValuePolicy&gt; &amp;)</code></h1></div></div></div>
<p>Serialises a <code>basic_result</code> to a <code>std::ostream</code>.</p>
<p>Serialisation format is:</p>
<pre><code>&lt;unsigned int flags&gt;&lt;space&gt;&lt;value_type if set and not void&gt;&lt;error_type if set and not void&gt;
</code></pre>
<p>This is the <strong>wrong</strong> function to use if you wish to print human readable output.
Use <a href="../../../reference/functions/iostream/result_print.html" class="api-reference"><code>std::string print(const basic_result&lt;T, E, NoValuePolicy&gt; &amp;)</code></a>
instead.</p>
<p><em>Overridable</em>: Not overridable.</p>
<p><em>Requires</em>: That <code>operator&lt;&lt;</code> is a valid expression for <code>std::ostream</code> and <code>T</code> and <code>E</code>.</p>
<p><em>Namespace</em>: <code>BOOST_OUTCOME_V2_NAMESPACE</code></p>
<p><em>Header</em>: <code>&lt;boost/outcome/iostream_support.hpp&gt;</code> (must be explicitly included manually).</p>
</div><p><small>Last revised: March 03, 2019 at 21:04:29 UTC</small></p>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../../../reference/functions/iostream/outcome_operator_out.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/iostream.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/functions/iostream/outcome_print.html"><img src="../../../images/next.png" alt="Next"></a></div></body>
</html>

View File

@@ -0,0 +1,31 @@
<!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>std::string print(const basic_result&lt;T, E, NoValuePolicy&gt; &amp;) - 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="../../../reference/functions/iostream/outcome_print.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/iostream.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/functions/policy.html"><img src="../../../images/next.png" alt="Next"></a></div><div id="content">
<div class="titlepage"><div><div><h1 style="clear: both"><code>std::string print(const basic_result&lt;T, E, NoValuePolicy&gt; &amp;)</code></h1></div></div></div>
<p>Returns a string containing a human readable rendition of the <code>basic_result</code>.</p>
<p><em>Overridable</em>: Not overridable.</p>
<p><em>Requires</em>: Always available.</p>
<p><em>Namespace</em>: <code>BOOST_OUTCOME_V2_NAMESPACE</code></p>
<p><em>Header</em>: <code>&lt;boost/outcome/iostream_support.hpp&gt;</code> (must be explicitly included manually).</p>
</div><p><small>Last revised: March 03, 2019 at 21:04:29 UTC</small></p>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../../../reference/functions/iostream/outcome_print.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/iostream.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/functions/policy.html"><img src="../../../images/next.png" alt="Next"></a></div></body>
</html>

View File

@@ -0,0 +1,44 @@
<!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>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="../../reference/functions/iostream/result_print.html"><img src="../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../reference/functions.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/functions/policy/basic_outcome_failure_exception_from_error.html"><img src="../../images/next.png" alt="Next"></a></div><div id="content">
<div class="titlepage"><div><div><h1 style="clear: both">Policy</h1></div></div></div>
<ol class="children children-li"><li>
<a href="../../reference/functions/policy/basic_outcome_failure_exception_from_error.html" ><code>auto basic_outcome_failure_exception_from_error(const EC &amp;)</code></a>
<p>ADL discovered free function synthesising an exception type from an error type, used by the <code>.failure()</code> observers.</p><li>
<a href="../../reference/functions/policy/error_code.html" ><code>decltype(auto) error_code(T &amp;&amp;)</code></a>
<p>Extracts a <code>boost::system::error_code</code> or <code>std::error_code</code> from the input via ADL discovery of a suitable <code>make_error_code(T)</code> function.</p><li>
<a href="../../reference/functions/policy/exception_ptr.html" ><code>decltype(auto) exception_ptr(T &amp;&amp;)</code></a>
<p>Extracts a <code>boost::exception_ptr</code> or <code>std::exception_ptr</code> from the input via ADL discovery of a suitable <code>make_exception_ptr(T)</code> function.</p><li>
<a href="../../reference/functions/policy/outcome_throw_as_system_error_with_payload_boost_enum.html" ><code>void outcome_throw_as_system_error_with_payload(BoostErrorCodeEnum &amp;&amp;)</code></a>
<p>Specialisation of <code>outcome_throw_as_system_error_with_payload()</code> for input types where <code>boost::system::is_error_code_enum&lt;BoostErrorCodeEnum&gt;</code> or <code>boost::system::is_error_condition_enum&lt;BoostErrorCodeEnum&gt;</code> is true.</p><li>
<a href="../../reference/functions/policy/outcome_throw_as_system_error_with_payload_std_enum.html" ><code>void outcome_throw_as_system_error_with_payload(ErrorCodeEnum &amp;&amp;)</code></a>
<p>Specialisation of <code>outcome_throw_as_system_error_with_payload()</code> for input types where <code>std::is_error_code_enum&lt;ErrorCodeEnum&gt;</code> or <code>std::is_error_condition_enum&lt;ErrorCodeEnum&gt;</code> is true.</p><li>
<a href="../../reference/functions/policy/outcome_throw_as_system_error_with_payload_boost_error_code.html" ><code>void outcome_throw_as_system_error_with_payload(const boost::system::error_code &amp;)</code></a>
<p>Specialisation of <code>outcome_throw_as_system_error_with_payload()</code> for <code>boost::system::error_code</code>.</p><li>
<a href="../../reference/functions/policy/outcome_throw_as_system_error_with_payload_std_error_code.html" ><code>void outcome_throw_as_system_error_with_payload(const std::error_code &amp;)</code></a>
<p>Specialisation of <code>outcome_throw_as_system_error_with_payload()</code> for <code>std::error_code</code>.</p></li></ol>
</div><p><small>Last revised: January 22, 2019 at 01:11:40 UTC</small></p>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../../reference/functions/iostream/result_print.html"><img src="../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../reference/functions.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/functions/policy/basic_outcome_failure_exception_from_error.html"><img src="../../images/next.png" alt="Next"></a></div></body>
</html>

View File

@@ -0,0 +1,38 @@
<!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>auto basic_outcome_failure_exception_from_error(const EC &amp;) - 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="../../../reference/functions/policy.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/policy.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/functions/policy/error_code.html"><img src="../../../images/next.png" alt="Next"></a></div><div id="content">
<div class="titlepage"><div><div><h1 style="clear: both"><code>auto basic_outcome_failure_exception_from_error(const EC &amp;)</code></h1></div></div></div>
<p>Synthesises an exception type from an error type, used by the <a href="../../../reference/types/basic_outcome/failure.html" class="api-reference"><code>exception_type failure() const noexcept</code></a>
observers. ADL discovered. Default
overloads for this function are defined in Outcome for
<a href="https://en.cppreference.com/w/cpp/error/error_code" class="api-reference" target="_blank"><i class="fa fa-book" aria-hidden="true"></i> <code>std::error_code</code></a>
and <code>boost::system::error_code</code>, these return <code>std::make_exception_ptr(std::system_error(ec))</code>
and <code>boost::copy_exception(boost::system::system_error(ec))</code> respectively.</p>
<p><em>Overridable</em>: Argument dependent lookup.</p>
<p><em>Requires</em>: Nothing.</p>
<p><em>Namespace</em>: Namespace of <code>EC</code> type.</p>
<p><em>Header</em>: <code>&lt;boost/outcome/std_outcome.hpp&gt;</code>, <code>&lt;boost/outcome/boost_outcome.hpp&gt;</code></p>
</div><p><small>Last revised: February 06, 2019 at 16:50:01 UTC</small></p>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../../../reference/functions/policy.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/policy.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/functions/policy/error_code.html"><img src="../../../images/next.png" alt="Next"></a></div></body>
</html>

View File

@@ -0,0 +1,33 @@
<!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>decltype(auto) error_code(T &amp;&amp;) - 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="../../../reference/functions/policy/basic_outcome_failure_exception_from_error.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/policy.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/functions/policy/exception_ptr.html"><img src="../../../images/next.png" alt="Next"></a></div><div id="content">
<div class="titlepage"><div><div><h1 style="clear: both"><code>decltype(auto) error_code(T &amp;&amp;)</code></h1></div></div></div>
<p>Extracts a <code>boost::system::error_code</code> or
<a href="https://en.cppreference.com/w/cpp/error/error_code" class="api-reference" target="_blank"><i class="fa fa-book" aria-hidden="true"></i> <code>std::error_code</code></a>
from the input via ADL discovery of a suitable <code>make_error_code(T)</code> function.</p>
<p><em>Overridable</em>: Argument dependent lookup.</p>
<p><em>Requires</em>: Always available.</p>
<p><em>Namespace</em>: <code>BOOST_OUTCOME_V2_NAMESPACE::policy</code></p>
<p><em>Header</em>: <code>&lt;boost/outcome/std_result.hpp&gt;</code></p>
</div><p><small>Last revised: February 11, 2019 at 15:13:33 UTC</small></p>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../../../reference/functions/policy/basic_outcome_failure_exception_from_error.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/policy.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/functions/policy/exception_ptr.html"><img src="../../../images/next.png" alt="Next"></a></div></body>
</html>

View File

@@ -0,0 +1,33 @@
<!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>decltype(auto) exception_ptr(T &amp;&amp;) - 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="../../../reference/functions/policy/error_code.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/policy.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/functions/policy/outcome_throw_as_system_error_with_payload_boost_enum.html"><img src="../../../images/next.png" alt="Next"></a></div><div id="content">
<div class="titlepage"><div><div><h1 style="clear: both"><code>decltype(auto) exception_ptr(T &amp;&amp;)</code></h1></div></div></div>
<p>Extracts a <code>boost::exception_ptr</code> or
<a href="https://en.cppreference.com/w/cpp/error/exception_ptr" class="api-reference" target="_blank"><i class="fa fa-book" aria-hidden="true"></i> <code>std::exception_ptr</code></a>
from the input via ADL discovery of a suitable <code>make_exception_ptr(T)</code> function.</p>
<p><em>Overridable</em>: Argument dependent lookup.</p>
<p><em>Requires</em>: Always available.</p>
<p><em>Namespace</em>: <code>BOOST_OUTCOME_V2_NAMESPACE::policy</code></p>
<p><em>Header</em>: <code>&lt;boost/outcome/std_result.hpp&gt;</code></p>
</div><p><small>Last revised: January 23, 2019 at 01:27:31 UTC</small></p>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../../../reference/functions/policy/error_code.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/policy.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/functions/policy/outcome_throw_as_system_error_with_payload_boost_enum.html"><img src="../../../images/next.png" alt="Next"></a></div></body>
</html>

View File

@@ -0,0 +1,32 @@
<!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>void outcome_throw_as_system_error_with_payload(BoostErrorCodeEnum &amp;&amp;) - 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="../../../reference/functions/policy/exception_ptr.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/policy.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/functions/policy/outcome_throw_as_system_error_with_payload_std_enum.html"><img src="../../../images/next.png" alt="Next"></a></div><div id="content">
<div class="titlepage"><div><div><h1 style="clear: both"><code>void outcome_throw_as_system_error_with_payload(BoostErrorCodeEnum &amp;&amp;)</code></h1></div></div></div>
<p>A specialisation of <code>outcome_throw_as_system_error_with_payload()</code> for types where <code>boost::system::is_error_code_enum&lt;BoostErrorCodeEnum&gt;</code> or <code>boost::system::is_error_condition_enum&lt;BoostErrorCodeEnum&gt;</code> is true. This executes <a href="../../../reference/macros/throw_exception.html" class="api-reference"><code>BOOST_OUTCOME_THROW_EXCEPTION(expr)</code></a>
with a <code>boost::system::system_error</code> constructed from the result of the ADL discovered free function <code>make_error_code(BoostErrorCodeEnum)</code>.</p>
<p><em>Overridable</em>: Argument dependent lookup.</p>
<p><em>Requires</em>: Either <code>boost::system::is_error_code_enum&lt;T&gt;</code> or <code>boost::system::is_error_condition_enum&lt;T&gt;</code> to be true for a decayed <code>BoostErrorCodeEnum</code>.</p>
<p><em>Namespace</em>: <code>boost::system</code></p>
<p><em>Header</em>: <code>&lt;boost/outcome/boost_result.hpp&gt;</code></p>
</div><p><small>Last revised: August 13, 2019 at 13:55:04 -0400</small></p>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../../../reference/functions/policy/exception_ptr.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/policy.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/functions/policy/outcome_throw_as_system_error_with_payload_std_enum.html"><img src="../../../images/next.png" alt="Next"></a></div></body>
</html>

View File

@@ -0,0 +1,32 @@
<!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>void outcome_throw_as_system_error_with_payload(const boost::system::error_code &amp;) - 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="../../../reference/functions/policy/outcome_throw_as_system_error_with_payload_std_enum.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/policy.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/functions/policy/outcome_throw_as_system_error_with_payload_std_error_code.html"><img src="../../../images/next.png" alt="Next"></a></div><div id="content">
<div class="titlepage"><div><div><h1 style="clear: both"><code>void outcome_throw_as_system_error_with_payload(const boost::system::error_code &amp;)</code></h1></div></div></div>
<p>A specialisation of <code>outcome_throw_as_system_error_with_payload()</code> for <code>boost::system::error_code</code>. This executes <a href="../../../reference/macros/throw_exception.html" class="api-reference"><code>BOOST_OUTCOME_THROW_EXCEPTION(expr)</code></a>
with a <code>boost::system::system_error</code> constructed from the input.</p>
<p><em>Overridable</em>: Argument dependent lookup.</p>
<p><em>Requires</em>: Nothing.</p>
<p><em>Namespace</em>: <code>boost::system</code></p>
<p><em>Header</em>: <code>&lt;boost/outcome/boost_result.hpp&gt;</code></p>
</div><p><small>Last revised: January 24, 2019 at 01:15:16 UTC</small></p>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../../../reference/functions/policy/outcome_throw_as_system_error_with_payload_std_enum.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/policy.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/functions/policy/outcome_throw_as_system_error_with_payload_std_error_code.html"><img src="../../../images/next.png" alt="Next"></a></div></body>
</html>

View File

@@ -0,0 +1,38 @@
<!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>void outcome_throw_as_system_error_with_payload(ErrorCodeEnum &amp;&amp;) - 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="../../../reference/functions/policy/outcome_throw_as_system_error_with_payload_boost_enum.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/policy.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/functions/policy/outcome_throw_as_system_error_with_payload_boost_error_code.html"><img src="../../../images/next.png" alt="Next"></a></div><div id="content">
<div class="titlepage"><div><div><h1 style="clear: both"><code>void outcome_throw_as_system_error_with_payload(ErrorCodeEnum &amp;&amp;)</code></h1></div></div></div>
<p>A specialisation of <code>outcome_throw_as_system_error_with_payload()</code> for types where <code>std::is_error_code_enum&lt;ErrorCodeEnum&gt;</code> or <code>std::is_error_condition_enum&lt;ErrorCodeEnum&gt;</code> is true. This executes <a href="../../../reference/macros/throw_exception.html" class="api-reference"><code>BOOST_OUTCOME_THROW_EXCEPTION(expr)</code></a>
with a
<a href="https://en.cppreference.com/w/cpp/error/system_error" class="api-reference" target="_blank"><i class="fa fa-book" aria-hidden="true"></i> <code>std::system_error</code></a>
constructed from the result of the ADL discovered free function <code>make_error_code(ErrorCodeEnum)</code>.</p>
<p><em>Overridable</em>: Argument dependent lookup.</p>
<p><em>Requires</em>: Either
<a href="https://en.cppreference.com/w/cpp/error/error_code/is_error_code_enum" class="api-reference" target="_blank"><i class="fa fa-book" aria-hidden="true"></i> <code>std::is_error_code_enum&lt;T&gt;</code></a>
or
<a href="https://en.cppreference.com/w/cpp/error/error_condition/is_error_condition_enum" class="api-reference" target="_blank"><i class="fa fa-book" aria-hidden="true"></i> <code>std::is_error_condition_enum&lt;T&gt;</code></a>
to be true for a decayed <code>ErrorCodeEnum</code>.</p>
<p><em>Namespace</em>: <code>std</code></p>
<p><em>Header</em>: <code>&lt;boost/outcome/std_result.hpp&gt;</code></p>
</div><p><small>Last revised: February 01, 2019 at 15:52:57 UTC</small></p>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../../../reference/functions/policy/outcome_throw_as_system_error_with_payload_boost_enum.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/policy.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/functions/policy/outcome_throw_as_system_error_with_payload_boost_error_code.html"><img src="../../../images/next.png" alt="Next"></a></div></body>
</html>

View File

@@ -0,0 +1,34 @@
<!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>void outcome_throw_as_system_error_with_payload(const std::error_code &amp;) - 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="../../../reference/functions/policy/outcome_throw_as_system_error_with_payload_boost_error_code.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/policy.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/functions/failure.html"><img src="../../../images/next.png" alt="Next"></a></div><div id="content">
<div class="titlepage"><div><div><h1 style="clear: both"><code>void outcome_throw_as_system_error_with_payload(const std::error_code &amp;)</code></h1></div></div></div>
<p>A specialisation of <code>outcome_throw_as_system_error_with_payload()</code> for <code>std::error_code</code>. This executes <a href="../../../reference/macros/throw_exception.html" class="api-reference"><code>BOOST_OUTCOME_THROW_EXCEPTION(expr)</code></a>
with a
<a href="https://en.cppreference.com/w/cpp/error/system_error" class="api-reference" target="_blank"><i class="fa fa-book" aria-hidden="true"></i> <code>std::system_error</code></a>
constructed from the input.</p>
<p><em>Overridable</em>: Argument dependent lookup.</p>
<p><em>Requires</em>: Nothing.</p>
<p><em>Namespace</em>: <code>std</code></p>
<p><em>Header</em>: <code>&lt;boost/outcome/std_result.hpp&gt;</code></p>
</div><p><small>Last revised: February 01, 2019 at 15:52:57 UTC</small></p>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../../../reference/functions/policy/outcome_throw_as_system_error_with_payload_boost_error_code.html"><img src="../../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../../reference/functions/policy.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/functions/failure.html"><img src="../../../images/next.png" alt="Next"></a></div></body>
</html>

View File

@@ -0,0 +1,34 @@
<!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>void strong_swap(bool &amp;all_good, T &amp;a, T &amp;b) - 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="../../reference/functions/error_from_exception.html"><img src="../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../reference/functions.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/functions/try_throw_std_exception_from_error.html"><img src="../../images/next.png" alt="Next"></a></div><div id="content">
<div class="titlepage"><div><div><h1 style="clear: both"><code>void strong_swap(bool &amp;all_good, T &amp;a, T &amp;b)</code></h1></div></div></div>
<p>The standard <code>swap()</code> function provides the weak guarantee i.e. that no resources are lost. This ADL discovered function provides the strong guarantee instead: that if any of these operations throw an exception (i) move construct to temporary (ii) move assign <code>b</code> to <code>a</code> (iii) move assign temporary to <code>b</code>, an attempt is made to restore the exact pre-swapped state upon entry, and if that recovery too fails, then the boolean <code>all_good</code> will be false during stack unwind from the exception throw, to indicate that state has been lost.</p>
<p>This function is used within <code>basic_result::</code><a href="../../reference/types/basic_result/swap.html" class="api-reference"><code>swap(basic_result &amp;)</code></a>
if, and only if, either or both of <code>value_type</code> or <code>error_type</code> have a throwing move constructor or move assignment. It permits you to customise the implementation of the strong guarantee swap in Outcome with a more efficient implementation.</p>
<p><em>Overridable</em>: By Argument Dependent Lookup (ADL).</p>
<p><em>Requires</em>: That <code>T</code> is both move constructible and move assignable.</p>
<p><em>Namespace</em>: <code>BOOST_OUTCOME_V2_NAMESPACE</code></p>
<p><em>Header</em>: <code>&lt;boost/outcome/basic_result.hpp&gt;</code></p>
</div><p><small>Last revised: June 24, 2019 at 21:09:37 &#43;0100</small></p>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../../reference/functions/error_from_exception.html"><img src="../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../reference/functions.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/functions/try_throw_std_exception_from_error.html"><img src="../../images/next.png" alt="Next"></a></div></body>
</html>

View File

@@ -0,0 +1,34 @@
<!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>auto success(T &amp;&amp;, &hellip;) - 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="../../reference/functions/failure.html"><img src="../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../reference/functions.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/functions/try_operation_has_value.html"><img src="../../images/next.png" alt="Next"></a></div><div id="content">
<div class="titlepage"><div><div><h1 style="clear: both"><code>auto success(T &amp;&amp;, ...)</code></h1></div></div></div>
<p>Returns appropriate type sugar for constructing a successful result or outcome, usually <a href="../../reference/types/success_type.html" class="api-reference"><code>success_type&lt;T&gt;</code></a>
with a decayed <code>T</code>.</p>
<p>Two default overloads are provided, one taking a single required parameter with optional spare storage value parameter returning <code>success_type&lt;std::decay_t&lt;T&gt;&gt;</code> and perfectly forwarding the input. The other overload takes no parameters, and returns <code>success_type&lt;void&gt;</code>, which usually causes the construction of the receiving <code>basic_result</code> or <code>basic_outcome</code>&rsquo;s with a default construction of their value type.</p>
<p><em>Overridable</em>: By Argument Dependent Lookup (ADL).</p>
<p><em>Requires</em>: Always available.</p>
<p><em>Namespace</em>: <code>BOOST_OUTCOME_V2_NAMESPACE</code></p>
<p><em>Header</em>: <code>&lt;boost/outcome/success_failure.hpp&gt;</code></p>
</div><p><small>Last revised: February 23, 2021 at 17:37:27 UTC</small></p>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../../reference/functions/failure.html"><img src="../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../reference/functions.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/functions/try_operation_has_value.html"><img src="../../images/next.png" alt="Next"></a></div></body>
</html>

View File

@@ -0,0 +1,29 @@
<!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>decltype(auto) try_operation_extract_value(X) - 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="../../reference/functions/try_operation_has_value.html"><img src="../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../reference/functions.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/functions/try_operation_return_as.html"><img src="../../images/next.png" alt="Next"></a></div><div id="content">
<div class="titlepage"><div><div><h1 style="clear: both"><code>decltype(auto) try_operation_extract_value(X)</code></h1></div></div></div>
<p>This default implementation returns whatever the <code>.assume_value()</code> or <code>.value()</code> member functions return, preferentially choosing the former where both are available.</p>
<p><em>Requires</em>: That the expression <code>std::declval&lt;T&gt;().assume_value()</code> and/or <code>std::declval&lt;T&gt;().value()</code> is a valid expression.</p>
<p><em>Namespace</em>: <code>BOOST_OUTCOME_V2_NAMESPACE</code></p>
<p><em>Header</em>: <code>&lt;boost/outcome/try.hpp&gt;</code></p>
</div><p><small>Last revised: June 20, 2019 at 11:14:48 &#43;0100</small></p>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../../reference/functions/try_operation_has_value.html"><img src="../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../reference/functions.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/functions/try_operation_return_as.html"><img src="../../images/next.png" alt="Next"></a></div></body>
</html>

View File

@@ -0,0 +1,29 @@
<!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>bool try_operation_has_value(X) - 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="../../reference/functions/success.html"><img src="../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../reference/functions.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/functions/try_operation_extract_value.html"><img src="../../images/next.png" alt="Next"></a></div><div id="content">
<div class="titlepage"><div><div><h1 style="clear: both"><code>bool try_operation_has_value(X)</code></h1></div></div></div>
<p>This default implementation returns whatever the <code>.has_value()</code> member function returns.</p>
<p><em>Requires</em>: That the expression <code>std::declval&lt;T&gt;().has_value()</code> is a valid expression.</p>
<p><em>Namespace</em>: <code>BOOST_OUTCOME_V2_NAMESPACE</code></p>
<p><em>Header</em>: <code>&lt;boost/outcome/try.hpp&gt;</code></p>
</div><p><small>Last revised: June 20, 2019 at 11:14:48 &#43;0100</small></p>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../../reference/functions/success.html"><img src="../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../reference/functions.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/functions/try_operation_extract_value.html"><img src="../../images/next.png" alt="Next"></a></div></body>
</html>

View File

@@ -0,0 +1,34 @@
<!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>decltype(auto) try_operation_return_as(X) - 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="../../reference/functions/try_operation_extract_value.html"><img src="../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../reference/functions.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/functions/error_from_exception.html"><img src="../../images/next.png" alt="Next"></a></div><div id="content">
<div class="titlepage"><div><div><h1 style="clear: both"><code>decltype(auto) try_operation_return_as(X)</code></h1></div></div></div>
<p>This default implementation preferentially returns whatever the input type&rsquo;s <code>.as_failure()</code> member function returns.
<code>basic_result</code> and <code>basic_outcome</code> provide such a member function, see <a href="../../reference/types/basic_result/as_failure_lvalue.html" class="api-reference"><code>auto as_failure() const &amp;</code></a>
.</p>
<p>If <code>.as_failure()</code> is not available, it will also match any <code>.error()</code> member function, which it wraps into a failure type sugar using <a href="../../reference/functions/failure.html" class="api-reference"><code>failure(T &amp;&amp;, ...)</code></a>
.</p>
<p><em>Requires</em>: That the expression <code>std::declval&lt;T&gt;().as_failure()</code> and/or <code>std::declval&lt;T&gt;().error()</code> is a valid expression.</p>
<p><em>Namespace</em>: <code>BOOST_OUTCOME_V2_NAMESPACE</code></p>
<p><em>Header</em>: <code>&lt;boost/outcome/try.hpp&gt;</code></p>
</div><p><small>Last revised: June 20, 2019 at 11:14:48 &#43;0100</small></p>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../../reference/functions/try_operation_extract_value.html"><img src="../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../reference/functions.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/functions/error_from_exception.html"><img src="../../images/next.png" alt="Next"></a></div></body>
</html>

View File

@@ -0,0 +1,63 @@
<!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>void try_throw_std_exception_from_error(std::error_code ec, const std::string &amp;msg = std::string{}) - 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="../../reference/functions/strong_swap.html"><img src="../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../reference/functions.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="../../faq.html"><img src="../../images/next.png" alt="Next"></a></div><div id="content">
<div class="titlepage"><div><div><h1 style="clear: both"><code>void try_throw_std_exception_from_error(std::error_code ec, const std::string &amp;msg = std::string{})</code></h1></div></div></div>
<p>This function saves writing boilerplate by throwing a standard library exception
type equivalent to the supplied error code, with an optional custom message.</p>
<p>If the function returns, there is no standard library exception type equivalent
to the supplied error code. The following codes produce the following exception
throws:</p>
<dl>
<dt><code>EINVAL</code>
<dd><code>std::invalid_argument</code>
<dt><code>EDOM</code>
<dd><code>std::domain_error</code>
<dt><code>E2BIG</code>
<dd><code>std::length_error</code>
<dt><code>ERANGE</code>
<dd><code>std::out_of_range</code>
<dt><code>EOVERFLOW</code>
<dd><code>std::overflow_error</code>
<dt><code>ENOMEM</code>
<dd><code>std::bad_alloc</code>
</dl>
<p>The choice to refer to POSIX <code>errno</code> values above reflects the matching algorithm.
As
<a href="https://en.cppreference.com/w/cpp/error/errc" class="api-reference" target="_blank"><i class="fa fa-book" aria-hidden="true"></i> <code>std::errc</code></a>
exactly maps POSIX <code>errno</code>, on all platforms
<a href="https://en.cppreference.com/w/cpp/error/generic_category" class="api-reference" target="_blank"><i class="fa fa-book" aria-hidden="true"></i> <code>std::generic_category</code></a>
error codes are matched by this function.
Only on POSIX platforms only are
<a href="https://en.cppreference.com/w/cpp/error/system_category" class="api-reference" target="_blank"><i class="fa fa-book" aria-hidden="true"></i> <code>std::system_category</code></a>
error codes
also matched by this function.</p>
<p><em>Overridable</em>: Not overridable.</p>
<p><em>Requires</em>: C++ exceptions to be globally enabled.</p>
<p><em>Namespace</em>: <code>BOOST_OUTCOME_V2_NAMESPACE</code></p>
<p><em>Header</em>: <code>&lt;boost/outcome/utils.hpp&gt;</code></p>
</div><p><small>Last revised: February 01, 2019 at 23:42:52 UTC</small></p>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../../reference/functions/strong_swap.html"><img src="../../images/prev.png" alt="Prev"></a>
<a accesskey="u" href="../../reference/functions.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="../../faq.html"><img src="../../images/next.png" alt="Next"></a></div></body>
</html>