• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<html><meta http-equiv="Content-Type" content="text/html; charset=utf-8">
3<title>success_type&lt;T&gt; - Boost.Outcome documentation</title>
4<link rel="stylesheet" href="../../css/boost.css" type="text/css">
5<meta name="generator" content="Hugo 0.52 with Boostdoc theme">
6<meta name="viewport" content="width=device-width,initial-scale=1.0"/>
7
8<link rel="icon" href="../../images/favicon.ico" type="image/ico"/>
9<body><div class="spirit-nav">
10<a accesskey="p" href="../../reference/types/awaitables/lazy.html"><img src="../../images/prev.png" alt="Prev"></a>
11    <a accesskey="u" href="../../reference/types.html"><img src="../../images/up.png" alt="Up"></a>
12    <a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../../reference/aliases.html"><img src="../../images/next.png" alt="Next"></a></div><div id="content">
13  <div class="titlepage"><div><div><h1 style="clear: both"><code>success_type&lt;T&gt;</code></h1></div></div></div>
14  <p>Type sugar for constructing a successful result or outcome. Generally not constructed directly, but via the free function <a href="../../reference/functions/success.html" class="api-reference"><code>success(T &amp;&amp;)</code></a>
15. Detectable using <a href="../../reference/traits/is_success_type.html" class="api-reference"><code>is_success_type&lt;T&gt;</code></a>
16.</p>
17
18<p>This is a regular wrapper type, with defaulted default, copy and move constructor, defaulted assignment, and defaulted destructor.</p>
19
20<p>A member type alias <code>value_type</code> indicates <code>T</code>.</p>
21
22<p>There is an explicit initialising constructor taking any type <code>U</code> which is not a <code>success_type&lt;T&gt;</code>, and which will forward construct the contained <code>T</code> from that <code>U</code>.</p>
23
24<p>There is a <code>.value()</code> reference observer with the usual constexpr lvalue, const lvalue, rvalue and const rvalue overloads.</p>
25
26<p>There is a specialisation <code>success_type&lt;void&gt;</code> which stores nothing and provides no <code>.value()</code> observers.</p>
27
28<p><em>Requires</em>: Nothing.</p>
29
30<p><em>Namespace</em>: <code>BOOST_OUTCOME_V2_NAMESPACE</code></p>
31
32<p><em>Header</em>: <code>&lt;boost/outcome/success_failure.hpp&gt;</code></p>
33
34
35        </div><p><small>Last revised: January 21, 2019 at 18:00:41 UTC</small></p>
36<hr>
37<div class="spirit-nav">
38<a accesskey="p" href="../../reference/types/awaitables/lazy.html"><img src="../../images/prev.png" alt="Prev"></a>
39    <a accesskey="u" href="../../reference/types.html"><img src="../../images/up.png" alt="Up"></a>
40    <a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../../reference/aliases.html"><img src="../../images/next.png" alt="Next"></a></div></body>
41</html>
42