mirror of
https://github.com/Naios/continuable.git
synced 2025-12-06 08:46:44 +08:00
291 lines
20 KiB
HTML
291 lines
20 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
|
|
|
|
<meta charset="UTF-8" />
|
|
<title>cti::result class | Continuable</title>
|
|
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css"/>
|
|
<link rel="stylesheet" href="m-dark+doxygen.compiled.css" />
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css"/>
|
|
<link rel="stylesheet" href="base.css" />
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css"/>
|
|
<link rel="stylesheet" href="terminal.css" />
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css"/>
|
|
<link rel="stylesheet" href="atom-one-dark.css" />
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<meta name="theme-color" content="#23373B" />
|
|
</head>
|
|
<body>
|
|
<header><nav id="navigation">
|
|
<div class="m-container">
|
|
<div class="m-row">
|
|
<a href="index.html" id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m">Continuable <span class="m-thin">4.1.0</span></a>
|
|
<div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
|
|
<a href="#search" class="m-dox-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
|
|
<path d="m6 0c-3.3144 0-6 2.6856-6 6 0 3.3144 2.6856 6 6 6 1.4858 0 2.8463-0.54083 3.8945-1.4355-0.0164 0.33797 0.14734 0.75854 0.5 1.1504l3.2227 3.7891c0.55185 0.6139 1.4517 0.66544 2.002 0.11524 0.55022-0.55022 0.49866-1.4501-0.11524-2.002l-3.7891-3.2246c-0.39184-0.35266-0.81242-0.51469-1.1504-0.5 0.89472-1.0482 1.4355-2.4088 1.4355-3.8945 0-3.3128-2.6856-5.998-6-5.998zm0 1.5625a4.4375 4.4375 0 0 1 4.4375 4.4375 4.4375 4.4375 0 0 1-4.4375 4.4375 4.4375 4.4375 0 0 1-4.4375-4.4375 4.4375 4.4375 0 0 1 4.4375-4.4375z"/>
|
|
</svg></a>
|
|
<a id="m-navbar-show" href="#navigation" title="Show navigation"></a>
|
|
<a id="m-navbar-hide" href="#" title="Hide navigation"></a>
|
|
</div>
|
|
<div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
|
|
<div class="m-row">
|
|
<ol class="m-col-t-6 m-col-m-none">
|
|
<li>
|
|
<a href="tutorial.html">Tutorial</a>
|
|
<ol>
|
|
<li><a href="tutorial-creating-continuables.html">Creating continuables</a></li>
|
|
<li><a href="tutorial-chaining-continuables.html">Chaining continuables</a></li>
|
|
<li><a href="tutorial-connecting-continuables.html">Connecting continuables</a></li>
|
|
<li><a href="tutorial-transforming-continuables.html">Transforming continuables</a></li>
|
|
<li><a href="tutorial-awaiting-continuables.html">Awaiting continuables</a></li>
|
|
<li><a href="tutorial-promisify-continuables.html">Promisify functions</a></li>
|
|
</ol>
|
|
</li>
|
|
<li>
|
|
<a href="pages.html">Pages</a>
|
|
<ol>
|
|
<li><a href="installation.html">Installation</a></li>
|
|
<li><a href="tutorial.html">Tutorial</a></li>
|
|
<li><a href="configuration.html">Configuration</a></li>
|
|
<li><a href="changelog.html">Changelog</a></li>
|
|
</ol>
|
|
</li>
|
|
<li>
|
|
<a href="modules.html">Modules</a>
|
|
<ol>
|
|
<li><a href="group___base.html">Base</a></li>
|
|
<li><a href="group___connections.html">Connections</a></li>
|
|
<li><a href="group___promisify.html">Promisify</a></li>
|
|
<li><a href="group___testing.html">Testing</a></li>
|
|
<li><a href="group___types.html">Types</a></li>
|
|
<li><a href="group___transforms.html">Transforms</a></li>
|
|
<li><a href="group___traversal.html">Traversal</a></li>
|
|
</ol>
|
|
</li>
|
|
</ol>
|
|
<ol class="m-col-t-6 m-col-m-none" start="4">
|
|
<li>
|
|
<a href="namespacecti.html">cti</a>
|
|
<ol>
|
|
<li><a href="namespacecti_1_1transforms.html">cti::transforms</a></li>
|
|
<li><a href="classcti_1_1continuable__base.html">cti::continuable_base</a></li>
|
|
<li><a href="classcti_1_1promise__base.html">cti::promise_base</a></li>
|
|
</ol>
|
|
</li>
|
|
<li class="m-show-m"><a href="#search" class="m-dox-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
|
|
<path d="m6 0c-3.3144 0-6 2.6856-6 6 0 3.3144 2.6856 6 6 6 1.4858 0 2.8463-0.54083 3.8945-1.4355-0.0164 0.33797 0.14734 0.75854 0.5 1.1504l3.2227 3.7891c0.55185 0.6139 1.4517 0.66544 2.002 0.11524 0.55022-0.55022 0.49866-1.4501-0.11524-2.002l-3.7891-3.2246c-0.39184-0.35266-0.81242-0.51469-1.1504-0.5 0.89472-1.0482 1.4355-2.4088 1.4355-3.8945 0-3.3128-2.6856-5.998-6-5.998zm0 1.5625a4.4375 4.4375 0 0 1 4.4375 4.4375 4.4375 4.4375 0 0 1-4.4375 4.4375 4.4375 4.4375 0 0 1-4.4375-4.4375 4.4375 4.4375 0 0 1 4.4375-4.4375z"/>
|
|
</svg> Search</a></li>
|
|
</ol>
|
|
<ol class="m-col-t-6 m-col-m-none">
|
|
<li>
|
|
<a href="https://github.com/Naios/continuable" aria-label="View source on Github"><i class="fa fa-github"></i> Code</a>
|
|
</li>
|
|
</ol>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</nav></header>
|
|
<main><article>
|
|
<div class="m-container m-container-inflatable">
|
|
<div class="m-row">
|
|
<div class="m-col-l-10 m-push-l-1">
|
|
<h1>
|
|
<div class="m-dox-template">template<typename... T></div>
|
|
<span class="m-breadcrumb"><a href="namespacecti.html">cti</a>::<wbr/></span>result <span class="m-thin">class</span>
|
|
</h1>
|
|
<p>The result class can carry the three kinds of results an asynchronous operation possibly can return, it's implemented in a variant like data structure which is also specialized to hold arbitrary arguments.</p>
|
|
<div class="m-block m-default">
|
|
<h3>Contents</h3>
|
|
<ul>
|
|
<li>
|
|
Reference
|
|
<ul>
|
|
<li><a href="#pub-static-methods">Public static functions</a></li>
|
|
<li><a href="#typeless-methods">Constructors, destructors, conversion operators</a></li>
|
|
<li><a href="#pub-methods">Public functions</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<p>The result can be in the following three states:</p><ul><li><em>no result</em>: If the operation didn't finish</li><li><em>a value</em>: If the operation finished successfully</li><li><em>an exception</em>: If the operation finished with an exception or was cancelled.</li></ul><p>The interface of the result object is similar to the one proposed in the <code>std::expected</code> proposal:</p><pre class="m-code"><span class="n">result</span><span class="o"><</span><span class="n">std</span><span class="o">::</span><span class="n">string</span><span class="o">></span> <span class="n">result</span> <span class="o">=</span> <span class="n">make_result</span><span class="p">(</span><span class="s">"Hello World!"</span><span class="p">);</span>
|
|
<span class="kt">bool</span><span class="p">(</span><span class="n">result</span><span class="p">);</span>
|
|
<span class="n">result</span><span class="p">.</span><span class="n">is_value</span><span class="p">();</span>
|
|
<span class="n">result</span><span class="p">.</span><span class="n">is_exception</span><span class="p">();</span>
|
|
<span class="o">*</span><span class="n">result</span><span class="p">;</span> <span class="c1">// Same as result.get_value()</span>
|
|
<span class="n">result</span><span class="p">.</span><span class="n">get_value</span><span class="p">();</span>
|
|
<span class="n">result</span><span class="p">.</span><span class="n">get_exception</span><span class="p">();</span></pre><aside class="m-note m-default"><h4>Since</h4><p>4.0.0</p></aside>
|
|
<section id="pub-static-methods">
|
|
<h2><a href="#pub-static-methods">Public static functions</a></h2>
|
|
<dl class="m-dox">
|
|
<dt>
|
|
<span class="m-dox-wrap-bumper">static auto <a href="#a3fec8c9a771a88ce82bcf62d72054ee9" class="m-dox-self" name="a3fec8c9a771a88ce82bcf62d72054ee9">from</a>(</span><span class="m-dox-wrap">T... values) -> <a href="classcti_1_1result.html" class="m-dox">result</a></span>
|
|
</dt>
|
|
<dd>Creates a present result from the given values.</dd>
|
|
<dt>
|
|
<span class="m-dox-wrap-bumper">static auto <a href="#ae8ea01cb58a4b7ebd2657e1fa8bc1f47" class="m-dox-self" name="ae8ea01cb58a4b7ebd2657e1fa8bc1f47">from</a>(</span><span class="m-dox-wrap"><a href="structcti_1_1exception__arg__t.html" class="m-dox">exception_<wbr />arg_<wbr />t</a>,
|
|
<a href="group___primitives.html#ga9fa0d3597f70a7b9e763639f0b30dee1" class="m-dox">exception_<wbr />t</a> exception) -> <a href="classcti_1_1result.html" class="m-dox">result</a></span>
|
|
</dt>
|
|
<dd>Creates a present result from the given exception.</dd>
|
|
<dt>
|
|
<span class="m-dox-wrap-bumper">static auto <a href="#a1ccaa637372b2a8bc93416a4b5831c9f" class="m-dox-self" name="a1ccaa637372b2a8bc93416a4b5831c9f">empty</a>(</span><span class="m-dox-wrap">) -> <a href="classcti_1_1result.html" class="m-dox">result</a></span>
|
|
</dt>
|
|
<dd>Creates an empty result.</dd>
|
|
</dl>
|
|
</section>
|
|
<section id="typeless-methods">
|
|
<h2><a href="#typeless-methods">Constructors, destructors, conversion operators</a></h2>
|
|
<dl class="m-dox">
|
|
<dt>
|
|
<span class="m-dox-wrap-bumper"><a href="#a50ce9290fc7df2746375bd4d469a523e" class="m-dox-self" name="a50ce9290fc7df2746375bd4d469a523e">operator bool</a>(</span><span class="m-dox-wrap">) const <span class="m-label m-flat m-info">explicit</span> <span class="m-label m-flat m-primary">constexpr</span> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns true if the state of the result holds the result.</dd>
|
|
</dl>
|
|
</section>
|
|
<section id="pub-methods">
|
|
<h2><a href="#pub-methods">Public functions</a></h2>
|
|
<dl class="m-dox">
|
|
<dt>
|
|
<span class="m-dox-wrap-bumper">void <a href="#ac256601b1f89911bcd7610d72548e67c" class="m-dox-self" name="ac256601b1f89911bcd7610d72548e67c">set_empty</a>(</span><span class="m-dox-wrap">)</span>
|
|
</dt>
|
|
<dd>Set the result to an empty state.</dd>
|
|
<dt>
|
|
<span class="m-dox-wrap-bumper">void <a href="#a09a414a12acc1c2cc369ab6cc50f699f" class="m-dox-self" name="a09a414a12acc1c2cc369ab6cc50f699f">set_value</a>(</span><span class="m-dox-wrap">T... values)</span>
|
|
</dt>
|
|
<dd>Set the result to a the state which holds the corresponding value.</dd>
|
|
<dt>
|
|
<span class="m-dox-wrap-bumper">void <a href="#a9ae0d4961d609c8f8cda5697f4d9397c" class="m-dox-self" name="a9ae0d4961d609c8f8cda5697f4d9397c">set_exception</a>(</span><span class="m-dox-wrap"><a href="group___primitives.html#ga9fa0d3597f70a7b9e763639f0b30dee1" class="m-dox">exception_<wbr />t</a> exception)</span>
|
|
</dt>
|
|
<dd>Set the result into a state which holds the corresponding exception.</dd>
|
|
<dt>
|
|
<span class="m-dox-wrap-bumper">void <a href="#abc877a55b134ed2c6b227f257b9c2f0f" class="m-dox-self" name="abc877a55b134ed2c6b227f257b9c2f0f">set_canceled</a>(</span><span class="m-dox-wrap">)</span>
|
|
</dt>
|
|
<dd>Set the result into a state which holds the cancellation token.</dd>
|
|
<dt>
|
|
<span class="m-dox-wrap-bumper">auto <a href="#a8f4ce49763a03ecfccb8411d6f9933cc" class="m-dox-self" name="a8f4ce49763a03ecfccb8411d6f9933cc">is_empty</a>(</span><span class="m-dox-wrap">) const -> bool <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns true if the state of the result is empty.</dd>
|
|
<dt>
|
|
<span class="m-dox-wrap-bumper">auto <a href="#a7169738aaff8bcda05ac5fd6fab47fc0" class="m-dox-self" name="a7169738aaff8bcda05ac5fd6fab47fc0">is_value</a>(</span><span class="m-dox-wrap">) const -> bool <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns true if the state of the result holds the result.</dd>
|
|
<dt>
|
|
<span class="m-dox-wrap-bumper">auto <a href="#a930153aeeb5c1adee5790a03c7d1cf57" class="m-dox-self" name="a930153aeeb5c1adee5790a03c7d1cf57">is_exception</a>(</span><span class="m-dox-wrap">) const -> bool <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns true if the state of the result holds a present exception.</dd>
|
|
<dt>
|
|
<span class="m-dox-wrap-bumper">auto <a href="#a694038a262d07a04614175c298ebdcc0" class="m-dox-self" name="a694038a262d07a04614175c298ebdcc0">get_value</a>(</span><span class="m-dox-wrap">) &noexcept -> decltype(auto)</span>
|
|
</dt>
|
|
<dd>Returns the values of the result, if the result doesn't hold the value the behaviour is undefined but will assert in debug mode.</dd>
|
|
<dt>
|
|
<span class="m-dox-wrap-bumper">auto <a href="#a2aa4b69c46fbac6f1566cde08d3f5efc" class="m-dox-self" name="a2aa4b69c46fbac6f1566cde08d3f5efc">get_value</a>(</span><span class="m-dox-wrap">) const &noexcept -> decltype(auto)</span>
|
|
</dt>
|
|
<dd>Returns the values of the result, if the result doesn't hold the value the behaviour is undefined but will assert in debug mode.</dd>
|
|
<dt>
|
|
<span class="m-dox-wrap-bumper">auto <a href="#a0495256a7baa705b545af54b4d41f82d" class="m-dox-self" name="a0495256a7baa705b545af54b4d41f82d">get_value</a>(</span><span class="m-dox-wrap">) &&noexcept -> decltype(auto)</span>
|
|
</dt>
|
|
<dd>Returns the values of the result, if the result doesn't hold the value the behaviour is undefined but will assert in debug mode.</dd>
|
|
<dt>
|
|
<span class="m-dox-wrap-bumper">auto <a href="#ad7a9913309920864c75becde0c287700" class="m-dox-self" name="ad7a9913309920864c75becde0c287700">operator*</a>(</span><span class="m-dox-wrap">) &noexcept -> decltype(auto)</span>
|
|
</dt>
|
|
<dd>Returns the values of the result, if the result doesn't hold the value the behaviour is undefined but will assert in debug mode.</dd>
|
|
<dt>
|
|
<span class="m-dox-wrap-bumper">auto <a href="#a9d80e087aa5e051b1dd367e5ec1582a0" class="m-dox-self" name="a9d80e087aa5e051b1dd367e5ec1582a0">operator*</a>(</span><span class="m-dox-wrap">) const &noexcept -> decltype(auto)</span>
|
|
</dt>
|
|
<dd>Returns the values of the result, if the result doesn't hold the value the behaviour is undefined but will assert in debug mode.</dd>
|
|
<dt>
|
|
<span class="m-dox-wrap-bumper">auto <a href="#a8aa39c9d7f723b6878559ef216e4309b" class="m-dox-self" name="a8aa39c9d7f723b6878559ef216e4309b">operator*</a>(</span><span class="m-dox-wrap">) &&noexcept -> decltype(auto)</span>
|
|
</dt>
|
|
<dd>Returns the values of the result, if the result doesn't hold the value the behaviour is undefined but will assert in debug mode.</dd>
|
|
<dt>
|
|
<span class="m-dox-wrap-bumper">auto <a href="#a0f9014ced70c55772fab16cb594492d3" class="m-dox-self" name="a0f9014ced70c55772fab16cb594492d3">get_exception</a>(</span><span class="m-dox-wrap">) &noexcept -> <a href="group___primitives.html#ga9fa0d3597f70a7b9e763639f0b30dee1" class="m-dox">exception_<wbr />t</a>&</span>
|
|
</dt>
|
|
<dd>Returns the exception of the result, if the result doesn't hold an exception the behaviour is undefined but will assert in debug mode.</dd>
|
|
<dt>
|
|
<span class="m-dox-wrap-bumper">auto <a href="#a3c7aa02b1df0766a42d9932d296cc1cf" class="m-dox-self" name="a3c7aa02b1df0766a42d9932d296cc1cf">get_exception</a>(</span><span class="m-dox-wrap">) const &noexcept -> <a href="group___primitives.html#ga9fa0d3597f70a7b9e763639f0b30dee1" class="m-dox">exception_<wbr />t</a> const &</span>
|
|
</dt>
|
|
<dd>Returns the exception of the result, if the result doesn't hold an exception the behaviour is undefined but will assert in debug mode.</dd>
|
|
<dt>
|
|
<span class="m-dox-wrap-bumper">auto <a href="#a9db24e9b4b51463f9031b4da5f4eb31e" class="m-dox-self" name="a9db24e9b4b51463f9031b4da5f4eb31e">get_exception</a>(</span><span class="m-dox-wrap">) &&noexcept -> <a href="group___primitives.html#ga9fa0d3597f70a7b9e763639f0b30dee1" class="m-dox">exception_<wbr />t</a>&&</span>
|
|
</dt>
|
|
<dd>Returns the exception of the result, if the result doesn't hold an exception the behaviour is undefined but will assert in debug mode.</dd>
|
|
</dl>
|
|
</section>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</article></main>
|
|
<div class="m-dox-search" id="search">
|
|
<a href="#!" onclick="return hideSearch()"></a>
|
|
<div class="m-container">
|
|
<div class="m-row">
|
|
<div class="m-col-m-8 m-push-m-2">
|
|
<div class="m-dox-search-header m-text m-small">
|
|
<div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div>
|
|
<div id="search-symbolcount">…</div>
|
|
</div>
|
|
<div class="m-dox-search-content">
|
|
<form>
|
|
<input type="search" name="q" id="search-input" placeholder="Loading …" disabled="disabled" autofocus="autofocus" autocomplete="off" spellcheck="false" />
|
|
</form>
|
|
<noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript.</noscript>
|
|
<div id="search-help" class="m-text m-dim m-text-center">
|
|
<p class="m-noindent">Search for symbols, directories, files, pages or
|
|
modules. You can omit any prefix from the symbol or file path; adding a
|
|
<code>:</code> or <code>/</code> suffix lists all members of given symbol or
|
|
directory.</p>
|
|
<p class="m-noindent">Use <span class="m-label m-dim">↓</span>
|
|
/ <span class="m-label m-dim">↑</span> to navigate through the list,
|
|
<span class="m-label m-dim">Enter</span> to go.
|
|
<span class="m-label m-dim">Tab</span> autocompletes common prefix, you can
|
|
copy a link to the result using <span class="m-label m-dim">⌘</span>
|
|
<span class="m-label m-dim">L</span> while <span class="m-label m-dim">⌘</span>
|
|
<span class="m-label m-dim">M</span> produces a Markdown link.</p>
|
|
|
|
</div>
|
|
<div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.</div>
|
|
<ul id="search-results"></ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<script src="search.js"></script>
|
|
<script src="searchdata.js" async="async"></script>
|
|
<footer><nav>
|
|
<div class="m-container">
|
|
<div class="m-row">
|
|
<div class="m-col-l-10 m-push-l-1">
|
|
<b><a
|
|
href="https://github.com/Naios/continuable">continuable</a></b>
|
|
-
|
|
C++14
|
|
allocation
|
|
aware
|
|
futures</br>Copyright
|
|
2015–2020
|
|
<a
|
|
href="https://github.com/Naios">Denis
|
|
Blank</a>.
|
|
Contact
|
|
the
|
|
author
|
|
via
|
|
<a
|
|
href="mailto:denis.blank@outlook.com">e-mail</a>.</br>Powered
|
|
by
|
|
<a
|
|
href="http://doxygen.org/">Doxygen</a>
|
|
and
|
|
<a
|
|
href="http://mcss.mosra.cz/">m.css</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</nav></footer>
|
|
</body>
|
|
</html>
|