mirror of
https://github.com/Naios/continuable.git
synced 2025-12-06 08:46:44 +08:00
289 lines
19 KiB
HTML
289 lines
19 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
|
|
|
|
<meta charset="UTF-8" />
|
|
<title>Result module | 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>
|
|
Result <span class="m-thin">module</span></h1>
|
|
<p>provides the <a href="classcti_1_1result.html" class="m-dox">result</a> class and corresponding utility functions to work with the result of an asynchronous operation which can possibly yield:</p>
|
|
<div class="m-block m-default">
|
|
<h3>Contents</h3>
|
|
<ul>
|
|
<li>
|
|
Reference
|
|
<ul>
|
|
<li><a href="#nested-classes">Classes</a></li>
|
|
<li><a href="#typedef-members">Typedefs</a></li>
|
|
<li><a href="#func-members">Functions</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<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>
|
|
<section id="nested-classes">
|
|
<h2><a href="#nested-classes">Classes</a></h2>
|
|
<dl class="m-dox">
|
|
<dt>
|
|
struct <a href="structcti_1_1empty__result.html" class="m-dox">cti::empty_result</a>
|
|
</dt>
|
|
<dd>A class which is convertible to any <a href="classcti_1_1result.html" class="m-dox">result</a> and that definitely holds no value so the real result gets invalidated when this object is passed to it.</dd>
|
|
<dt>
|
|
struct <a href="structcti_1_1cancellation__result.html" class="m-dox">cti::cancellation_result</a>
|
|
</dt>
|
|
<dd>A class which is convertible to any <a href="classcti_1_1result.html" class="m-dox">result</a> and that definitely holds a default constructed exception which signals the cancellation of the asynchronous control flow.</dd>
|
|
<dt>
|
|
class <a href="classcti_1_1exceptional__result.html" class="m-dox">cti::exceptional_result</a>
|
|
</dt>
|
|
<dd>A class which is convertible to any result and that holds an exception which is then passed to the converted result object.</dd>
|
|
<dt>
|
|
<div class="m-dox-template">template<typename... T></div>
|
|
class <a href="classcti_1_1result.html" class="m-dox">cti::result</a>
|
|
</dt>
|
|
<dd>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.</dd>
|
|
</dl>
|
|
</section>
|
|
<section id="typedef-members">
|
|
<h2><a href="#typedef-members">Typedefs</a></h2>
|
|
<dl class="m-dox">
|
|
<dt>
|
|
using <a href="#gaa4a7d06dc54b9058d15bf46305e4f282" class="m-dox">void_arg_t</a> = detail::void_arg_t
|
|
</dt>
|
|
<dd>A tag which represents present void values in result.</dd>
|
|
</dl>
|
|
</section>
|
|
<section id="func-members">
|
|
<h2><a href="#func-members">Functions</a></h2>
|
|
<dl class="m-dox">
|
|
<dt>
|
|
<div class="m-dox-template">template<std::size_t I, typename... T></div>
|
|
<span class="m-dox-wrap-bumper">auto <a href="#ga8c47cc24b02abb222a8bd7739ec3920e" class="m-dox-self" name="ga8c47cc24b02abb222a8bd7739ec3920e">get</a>(</span><span class="m-dox-wrap">result<T...>& result) -> decltype(auto)</span>
|
|
</dt>
|
|
<dd>Returns the value at position I of the given result.</dd>
|
|
<dt>
|
|
<div class="m-dox-template">template<std::size_t I, typename... T></div>
|
|
<span class="m-dox-wrap-bumper">auto <a href="#ga6d638c96597a30798bf74eb5a7968730" class="m-dox-self" name="ga6d638c96597a30798bf74eb5a7968730">get</a>(</span><span class="m-dox-wrap">result<T...> const& result) -> decltype(auto)</span>
|
|
</dt>
|
|
<dd>Returns the value at position I of the given result.</dd>
|
|
<dt>
|
|
<div class="m-dox-template">template<std::size_t I, typename... T></div>
|
|
<span class="m-dox-wrap-bumper">auto <a href="#ga61a97fe8e93c19e42f97396c6262281b" class="m-dox-self" name="ga61a97fe8e93c19e42f97396c6262281b">get</a>(</span><span class="m-dox-wrap">result<T...>&& result) -> decltype(auto)</span>
|
|
</dt>
|
|
<dd>Returns the value at position I of the given result.</dd>
|
|
<dt>
|
|
<div class="m-dox-template">template<typename... T, typename Result = result<detail::traits::unrefcv_t<T>...>></div>
|
|
<span class="m-dox-wrap-bumper">auto <a href="#ga2852fa60e4e34409e35a9f6e8ff5c816" class="m-dox">make_result</a>(</span><span class="m-dox-wrap">T && ... values) -> Result</span>
|
|
</dt>
|
|
<dd>Creates a present result from the given values.</dd>
|
|
<dt>
|
|
<span class="m-dox-wrap-bumper">auto <a href="#gae70b4f9c3ca8e28e559363a4bb9fee00" class="m-dox">make_result</a>(</span><span class="m-dox-wrap">exception_arg_t,
|
|
exception_t exception) -> exceptional_result</span>
|
|
</dt>
|
|
<dd>Creates an <a href="classcti_1_1exceptional__result.html" class="m-dox">exceptional_<wbr />result</a> from the given exception.</dd>
|
|
</dl>
|
|
</section>
|
|
<section>
|
|
<h2>Typedef documentation</h2>
|
|
<section class="m-dox-details" id="gaa4a7d06dc54b9058d15bf46305e4f282"><div>
|
|
<h3>
|
|
using <a href="#gaa4a7d06dc54b9058d15bf46305e4f282" class="m-dox-self">void_arg_t</a> = detail::void_arg_t
|
|
</h3>
|
|
<p>A tag which represents present void values in result.</p>
|
|
<aside class="m-note m-default"><h4>Since</h4><p>4.0.0</p></aside>
|
|
</div></section>
|
|
</section>
|
|
<section>
|
|
<h2>Function documentation</h2>
|
|
<section class="m-dox-details" id="ga2852fa60e4e34409e35a9f6e8ff5c816"><div>
|
|
<h3>
|
|
<div class="m-dox-template">
|
|
template<typename... T, typename Result = result<detail::traits::unrefcv_t<T>...>>
|
|
</div>
|
|
<span class="m-dox-wrap-bumper">Result </span><span class="m-dox-wrap"><span class="m-dox-wrap-bumper"><a href="#ga2852fa60e4e34409e35a9f6e8ff5c816" class="m-dox-self">make_result</a>(</span><span class="m-dox-wrap">T && ... values)</span></span>
|
|
</h3>
|
|
<p>Creates a present result from the given values.</p>
|
|
<p>This could be used to pass the result of the next handler to the same asynchronous path it came from as shown below:</p><pre class="m-code"><span class="n">make_ready_continuable</span><span class="p">().</span><span class="n">next</span><span class="p">([</span><span class="o">&</span><span class="p">](</span><span class="k">auto</span><span class="o">&&</span><span class="p">...</span> <span class="n">args</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="n">result</span><span class="o"><></span> <span class="n">captured</span> <span class="o">=</span> <span class="n">make_result</span><span class="p">(</span><span class="n">std</span><span class="o">::</span><span class="n">forward</span><span class="o"><</span><span class="k">decltype</span><span class="p">(</span><span class="n">args</span><span class="p">)</span><span class="o">></span><span class="p">(</span><span class="n">args</span><span class="p">)...);</span>
|
|
<span class="k">return</span> <span class="nf">shutdown</span><span class="p">().</span><span class="n">then</span><span class="p">([</span><span class="n">captured</span> <span class="o">=</span> <span class="n">std</span><span class="o">::</span><span class="n">move</span><span class="p">(</span><span class="n">captured</span><span class="p">)]()</span> <span class="k">mutable</span> <span class="p">{</span>
|
|
<span class="k">return</span> <span class="n">std</span><span class="o">::</span><span class="n">move</span><span class="p">(</span><span class="n">captured</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
<span class="p">});</span></pre><aside class="m-note m-default"><h4>Since</h4><p>4.0.0</p></aside>
|
|
</div></section>
|
|
<section class="m-dox-details" id="gae70b4f9c3ca8e28e559363a4bb9fee00"><div>
|
|
<h3>
|
|
<span class="m-dox-wrap-bumper">exceptional_result </span><span class="m-dox-wrap"><span class="m-dox-wrap-bumper"><a href="#gae70b4f9c3ca8e28e559363a4bb9fee00" class="m-dox-self">make_result</a>(</span><span class="m-dox-wrap">exception_arg_t,
|
|
exception_t exception)</span></span>
|
|
</h3>
|
|
<p>Creates an <a href="classcti_1_1exceptional__result.html" class="m-dox">exceptional_<wbr />result</a> from the given exception.</p>
|
|
<p>This could be used to pass the result of the next handler to the same asynchronous path it came from as shown below:</p><pre class="m-code"><span class="n">make_ready_continuable</span><span class="p">().</span><span class="n">next</span><span class="p">([</span><span class="o">&</span><span class="p">](</span><span class="k">auto</span><span class="o">&&</span><span class="p">...</span> <span class="n">args</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="n">result</span><span class="o"><></span> <span class="n">captured</span> <span class="o">=</span> <span class="n">make_result</span><span class="p">(</span><span class="n">std</span><span class="o">::</span><span class="n">forward</span><span class="o"><</span><span class="k">decltype</span><span class="p">(</span><span class="n">args</span><span class="p">)</span><span class="o">></span><span class="p">(</span><span class="n">args</span><span class="p">)...);</span>
|
|
<span class="k">return</span> <span class="nf">shutdown</span><span class="p">().</span><span class="n">then</span><span class="p">([</span><span class="n">captured</span> <span class="o">=</span> <span class="n">std</span><span class="o">::</span><span class="n">move</span><span class="p">(</span><span class="n">captured</span><span class="p">)]()</span> <span class="k">mutable</span> <span class="p">{</span>
|
|
<span class="k">return</span> <span class="n">std</span><span class="o">::</span><span class="n">move</span><span class="p">(</span><span class="n">captured</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
<span class="p">});</span></pre><aside class="m-note m-default"><h4>Since</h4><p>4.0.0</p><p>4.0.0</p></aside>
|
|
</div></section>
|
|
</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>
|