TartanLlama/expected
1
0
Fork 1
mirror of https://github.com/TartanLlama/expected.git synced 2025-08-03 19:04:29 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Simon Brand
2017-11-27 15:11:47 +00:00
parent 66856b517e
commit d37876102c
2 changed files with 161 additions and 118 deletions
Download Patch File Download Diff File Expand all files Collapse all files

278
docs/index.md
View File

@@ -1,144 +1,152 @@
# Header file `expected.hpp`<a id="expected.hpp"></a> # Header file `expected.hpp`<a id="expected.hpp"></a>
<pre><code class="language-cpp">#define <a href='doc_expected.md#expected.hpp'>TL_EXPECTED_HPP</a> <pre><code class="language-cpp">#define <a href='doc_expected.html#expected.hpp'>TL_EXPECTED_HPP</a>
#define <a href='doc_expected.md#expected.hpp'>TL_EXPECTED_GCC49</a> #define <a href='doc_expected.html#expected.hpp'>TL_EXPECTED_GCC49</a>
#define <a href='doc_expected.md#expected.hpp'>TL_EXPECTED_NO_CONSTRR</a> #define <a href='doc_expected.html#expected.hpp'>IS_TRIVIALLY_COPY_CONSTRUCTIBLE</a>(T)
#define <a href='doc_expected.md#expected.hpp'>TL_EXPECTED_CXX14</a> #define <a href='doc_expected.html#expected.hpp'>IS_TRIVIALLY_COPY_ASSIGNABLE</a>(T)
#define <a href='doc_expected.md#expected.hpp'>TL_IN_PLACE_MONOSTATE_DEFINED</a> #define <a href='doc_expected.html#expected.hpp'>IS_TRIVIALLY_DESTRUCTIBLE</a>(T)
namespace <a href='doc_expected.md#expected.hpp'>tl</a> #define <a href='doc_expected.html#expected.hpp'>TL_EXPECTED_CXX14</a>
#define <a href='doc_expected.html#expected.hpp'>TL_MONOSTATE_INPLACE_MUTEX</a>
#define <a href='doc_expected.html#expected.hpp'>TL_TRAITS_MUTEX</a>
#define <a href='doc_expected.html#expected.hpp'>TL_OPTIONAL_EXPECTED_MUTEX</a>
namespace <a href='doc_expected.html#expected.hpp'>tl</a>
{ {
class <a href='doc_expected.md#tl::monostate'>monostate</a>; class <a href='doc_expected.html#tl::monostate'>monostate</a>;
struct <a href='doc_expected.md#tl::in_place_t'>in_place_t</a>; struct <a href='doc_expected.html#tl::in_place_t'>in_place_t</a>;
constexpr <a href='doc_expected.md#tl::in_place_t'>in_place_t{}</a> <a href='doc_expected.md#tl::in_place'>in_place</a>; constexpr <a href='doc_expected.html#tl::in_place_t'>in_place_t{}</a> <a href='doc_expected.html#tl::in_place'>in_place</a>;
template &lt;class E&gt; template &lt;class E&gt;
class <a href='doc_expected.md#tl::unexpected-E-'>unexpected</a>; class <a href='doc_expected.html#tl::unexpected-E-'>unexpected</a>;
template &lt;class E&gt; template &lt;class E&gt;
constexpr bool <a href='doc_expected.md#tl::operator==(constunexpected-E-&,constunexpected-E-&)'>operator==</a>(const <a href='doc_expected.md#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; lhs, const <a href='doc_expected.md#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; rhs); constexpr bool <a href='doc_expected.html#tl::operator==(constunexpected-E-&,constunexpected-E-&)'>operator==</a>(const <a href='doc_expected.html#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; lhs, const <a href='doc_expected.html#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; rhs);
template &lt;class E&gt; template &lt;class E&gt;
constexpr bool <a href='doc_expected.md#tl::operator==(constunexpected-E-&,constunexpected-E-&)'>operator!=</a>(const <a href='doc_expected.md#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; lhs, const <a href='doc_expected.md#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; rhs); constexpr bool <a href='doc_expected.html#tl::operator==(constunexpected-E-&,constunexpected-E-&)'>operator!=</a>(const <a href='doc_expected.html#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; lhs, const <a href='doc_expected.html#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; rhs);
template &lt;class E&gt; template &lt;class E&gt;
constexpr bool <a href='doc_expected.md#tl::operator==(constunexpected-E-&,constunexpected-E-&)'>operator&lt;</a>(const <a href='doc_expected.md#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; lhs, const <a href='doc_expected.md#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; rhs); constexpr bool <a href='doc_expected.html#tl::operator==(constunexpected-E-&,constunexpected-E-&)'>operator&lt;</a>(const <a href='doc_expected.html#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; lhs, const <a href='doc_expected.html#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; rhs);
template &lt;class E&gt; template &lt;class E&gt;
constexpr bool <a href='doc_expected.md#tl::operator==(constunexpected-E-&,constunexpected-E-&)'>operator&lt;=</a>(const <a href='doc_expected.md#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; lhs, const <a href='doc_expected.md#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; rhs); constexpr bool <a href='doc_expected.html#tl::operator==(constunexpected-E-&,constunexpected-E-&)'>operator&lt;=</a>(const <a href='doc_expected.html#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; lhs, const <a href='doc_expected.html#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; rhs);
template &lt;class E&gt; template &lt;class E&gt;
constexpr bool <a href='doc_expected.md#tl::operator==(constunexpected-E-&,constunexpected-E-&)'>operator&gt;</a>(const <a href='doc_expected.md#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; lhs, const <a href='doc_expected.md#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; rhs); constexpr bool <a href='doc_expected.html#tl::operator==(constunexpected-E-&,constunexpected-E-&)'>operator&gt;</a>(const <a href='doc_expected.html#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; lhs, const <a href='doc_expected.html#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; rhs);
template &lt;class E&gt; template &lt;class E&gt;
constexpr bool <a href='doc_expected.md#tl::operator==(constunexpected-E-&,constunexpected-E-&)'>operator&gt;=</a>(const <a href='doc_expected.md#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; lhs, const <a href='doc_expected.md#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; rhs); constexpr bool <a href='doc_expected.html#tl::operator==(constunexpected-E-&,constunexpected-E-&)'>operator&gt;=</a>(const <a href='doc_expected.html#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; lhs, const <a href='doc_expected.html#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; rhs);
template &lt;class E&gt; template &lt;class E&gt;
<a href='doc_expected.md#tl::unexpected-E-'>unexpected&lt;E&gt;</a> <a href='doc_expected.md#tl::make_unexpected(E&&)'>make_unexpected</a>(E&amp;&amp; e); <a href='doc_expected.html#tl::unexpected-E-'>unexpected&lt;E&gt;</a> <a href='doc_expected.html#tl::make_unexpected(E&&)'>make_unexpected</a>(E&amp;&amp; e);
struct <a href='doc_expected.md#tl::unexpect_t'>unexpect_t</a>; struct <a href='doc_expected.html#tl::unexpect_t'>unexpect_t</a>;
constexpr <a href='doc_expected.md#tl::unexpect_t'>unexpect_t{}</a> <a href='doc_expected.md#tl::unexpect'>unexpect</a>; constexpr <a href='doc_expected.html#tl::unexpect_t'>unexpect_t{}</a> <a href='doc_expected.html#tl::unexpect'>unexpect</a>;
template &lt;class E&gt; template &lt;class E&gt;
class <a href='doc_expected.md#expected.hpp'>bad_expected_access</a>; class <a href='doc_expected.html#expected.hpp'>bad_expected_access</a>;
template &lt;class T, class E&gt; template &lt;class T, class E&gt;
class <a href='doc_expected.md#tl::expected-T,E-'>expected</a>; class <a href='doc_expected.html#tl::expected-T,E-'>expected</a>;
template &lt;class T, class E, class U, class F&gt; template &lt;class T, class E, class U, class F&gt;
constexpr bool <a href='doc_expected.md#expected.hpp'>operator==</a>(const <a href='doc_expected.md#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; lhs, const <a href='doc_expected.md#tl::expected-T,E-'>expected&lt;U, F&gt;</a>&amp; rhs); constexpr bool <a href='doc_expected.html#expected.hpp'>operator==</a>(const <a href='doc_expected.html#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; lhs, const <a href='doc_expected.html#tl::expected-T,E-'>expected&lt;U, F&gt;</a>&amp; rhs);
template &lt;class T, class E, class U, class F&gt; template &lt;class T, class E, class U, class F&gt;
constexpr bool <a href='doc_expected.md#expected.hpp'>operator!=</a>(const <a href='doc_expected.md#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; lhs, const <a href='doc_expected.md#tl::expected-T,E-'>expected&lt;U, F&gt;</a>&amp; rhs); constexpr bool <a href='doc_expected.html#expected.hpp'>operator!=</a>(const <a href='doc_expected.html#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; lhs, const <a href='doc_expected.html#tl::expected-T,E-'>expected&lt;U, F&gt;</a>&amp; rhs);
template &lt;class T, class E, class U, class F&gt; template &lt;class T, class E, class U, class F&gt;
constexpr bool <a href='doc_expected.md#expected.hpp'>operator&lt;</a>(const <a href='doc_expected.md#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; lhs, const <a href='doc_expected.md#tl::expected-T,E-'>expected&lt;U, F&gt;</a>&amp; rhs); constexpr bool <a href='doc_expected.html#expected.hpp'>operator&lt;</a>(const <a href='doc_expected.html#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; lhs, const <a href='doc_expected.html#tl::expected-T,E-'>expected&lt;U, F&gt;</a>&amp; rhs);
template &lt;class T, class E, class U, class F&gt; template &lt;class T, class E, class U, class F&gt;
constexpr bool <a href='doc_expected.md#expected.hpp'>operator&gt;</a>(const <a href='doc_expected.md#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; lhs, const <a href='doc_expected.md#tl::expected-T,E-'>expected&lt;U, F&gt;</a>&amp; rhs); constexpr bool <a href='doc_expected.html#expected.hpp'>operator&gt;</a>(const <a href='doc_expected.html#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; lhs, const <a href='doc_expected.html#tl::expected-T,E-'>expected&lt;U, F&gt;</a>&amp; rhs);
template &lt;class T, class E, class U, class F&gt; template &lt;class T, class E, class U, class F&gt;
constexpr bool <a href='doc_expected.md#expected.hpp'>operator&lt;=</a>(const <a href='doc_expected.md#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; lhs, const <a href='doc_expected.md#tl::expected-T,E-'>expected&lt;U, F&gt;</a>&amp; rhs); constexpr bool <a href='doc_expected.html#expected.hpp'>operator&lt;=</a>(const <a href='doc_expected.html#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; lhs, const <a href='doc_expected.html#tl::expected-T,E-'>expected&lt;U, F&gt;</a>&amp; rhs);
template &lt;class T, class E, class U, class F&gt; template &lt;class T, class E, class U, class F&gt;
constexpr bool <a href='doc_expected.md#expected.hpp'>operator&gt;=</a>(const <a href='doc_expected.md#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; lhs, const <a href='doc_expected.md#tl::expected-T,E-'>expected&lt;U, F&gt;</a>&amp; rhs); constexpr bool <a href='doc_expected.html#expected.hpp'>operator&gt;=</a>(const <a href='doc_expected.html#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; lhs, const <a href='doc_expected.html#tl::expected-T,E-'>expected&lt;U, F&gt;</a>&amp; rhs);
template &lt;class T, class E, class U&gt; template &lt;class T, class E, class U&gt;
constexpr bool <a href='doc_expected.md#expected.hpp'>operator==</a>(const <a href='doc_expected.md#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x, const U&amp; v); constexpr bool <a href='doc_expected.html#expected.hpp'>operator==</a>(const <a href='doc_expected.html#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x, const U&amp; v);
template &lt;class T, class E, class U&gt; template &lt;class T, class E, class U&gt;
constexpr bool <a href='doc_expected.md#expected.hpp'>operator==</a>(const U&amp; v, const <a href='doc_expected.md#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x); constexpr bool <a href='doc_expected.html#expected.hpp'>operator==</a>(const U&amp; v, const <a href='doc_expected.html#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x);
template &lt;class T, class E, class U&gt; template &lt;class T, class E, class U&gt;
constexpr bool <a href='doc_expected.md#expected.hpp'>operator!=</a>(const <a href='doc_expected.md#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x, const U&amp; v); constexpr bool <a href='doc_expected.html#expected.hpp'>operator!=</a>(const <a href='doc_expected.html#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x, const U&amp; v);
template &lt;class T, class E, class U&gt; template &lt;class T, class E, class U&gt;
constexpr bool <a href='doc_expected.md#expected.hpp'>operator!=</a>(const U&amp; v, const <a href='doc_expected.md#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x); constexpr bool <a href='doc_expected.html#expected.hpp'>operator!=</a>(const U&amp; v, const <a href='doc_expected.html#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x);
template &lt;class T, class E, class U&gt; template &lt;class T, class E, class U&gt;
constexpr bool <a href='doc_expected.md#expected.hpp'>operator&lt;</a>(const <a href='doc_expected.md#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x, const U&amp; v); constexpr bool <a href='doc_expected.html#expected.hpp'>operator&lt;</a>(const <a href='doc_expected.html#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x, const U&amp; v);
template &lt;class T, class E, class U&gt; template &lt;class T, class E, class U&gt;
constexpr bool <a href='doc_expected.md#expected.hpp'>operator&lt;</a>(const U&amp; v, const <a href='doc_expected.md#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x); constexpr bool <a href='doc_expected.html#expected.hpp'>operator&lt;</a>(const U&amp; v, const <a href='doc_expected.html#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x);
template &lt;class T, class E, class U&gt; template &lt;class T, class E, class U&gt;
constexpr bool <a href='doc_expected.md#expected.hpp'>operator&lt;=</a>(const <a href='doc_expected.md#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x, const U&amp; v); constexpr bool <a href='doc_expected.html#expected.hpp'>operator&lt;=</a>(const <a href='doc_expected.html#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x, const U&amp; v);
template &lt;class T, class E, class U&gt; template &lt;class T, class E, class U&gt;
constexpr bool <a href='doc_expected.md#expected.hpp'>operator&lt;=</a>(const U&amp; v, const <a href='doc_expected.md#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x); constexpr bool <a href='doc_expected.html#expected.hpp'>operator&lt;=</a>(const U&amp; v, const <a href='doc_expected.html#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x);
template &lt;class T, class E, class U&gt; template &lt;class T, class E, class U&gt;
constexpr bool <a href='doc_expected.md#expected.hpp'>operator&gt;</a>(const <a href='doc_expected.md#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x, const U&amp; v); constexpr bool <a href='doc_expected.html#expected.hpp'>operator&gt;</a>(const <a href='doc_expected.html#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x, const U&amp; v);
template &lt;class T, class E, class U&gt; template &lt;class T, class E, class U&gt;
constexpr bool <a href='doc_expected.md#expected.hpp'>operator&gt;</a>(const U&amp; v, const <a href='doc_expected.md#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x); constexpr bool <a href='doc_expected.html#expected.hpp'>operator&gt;</a>(const U&amp; v, const <a href='doc_expected.html#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x);
template &lt;class T, class E, class U&gt; template &lt;class T, class E, class U&gt;
constexpr bool <a href='doc_expected.md#expected.hpp'>operator&gt;=</a>(const <a href='doc_expected.md#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x, const U&amp; v); constexpr bool <a href='doc_expected.html#expected.hpp'>operator&gt;=</a>(const <a href='doc_expected.html#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x, const U&amp; v);
template &lt;class T, class E, class U&gt; template &lt;class T, class E, class U&gt;
constexpr bool <a href='doc_expected.md#expected.hpp'>operator&gt;=</a>(const U&amp; v, const <a href='doc_expected.md#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x); constexpr bool <a href='doc_expected.html#expected.hpp'>operator&gt;=</a>(const U&amp; v, const <a href='doc_expected.html#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x);
template &lt;class T, class E&gt; template &lt;class T, class E&gt;
constexpr bool <a href='doc_expected.md#expected.hpp'>operator==</a>(const <a href='doc_expected.md#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x, const <a href='doc_expected.md#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; e); constexpr bool <a href='doc_expected.html#expected.hpp'>operator==</a>(const <a href='doc_expected.html#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x, const <a href='doc_expected.html#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; e);
template &lt;class T, class E&gt; template &lt;class T, class E&gt;
constexpr bool <a href='doc_expected.md#expected.hpp'>operator==</a>(const <a href='doc_expected.md#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; e, const <a href='doc_expected.md#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x); constexpr bool <a href='doc_expected.html#expected.hpp'>operator==</a>(const <a href='doc_expected.html#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; e, const <a href='doc_expected.html#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x);
template &lt;class T, class E&gt; template &lt;class T, class E&gt;
constexpr bool <a href='doc_expected.md#expected.hpp'>operator!=</a>(const <a href='doc_expected.md#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x, const <a href='doc_expected.md#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; e); constexpr bool <a href='doc_expected.html#expected.hpp'>operator!=</a>(const <a href='doc_expected.html#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x, const <a href='doc_expected.html#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; e);
template &lt;class T, class E&gt; template &lt;class T, class E&gt;
constexpr bool <a href='doc_expected.md#expected.hpp'>operator!=</a>(const <a href='doc_expected.md#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; e, const <a href='doc_expected.md#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x); constexpr bool <a href='doc_expected.html#expected.hpp'>operator!=</a>(const <a href='doc_expected.html#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; e, const <a href='doc_expected.html#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x);
template &lt;class T, class E&gt; template &lt;class T, class E&gt;
constexpr bool <a href='doc_expected.md#expected.hpp'>operator&lt;</a>(const <a href='doc_expected.md#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x, const <a href='doc_expected.md#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; e); constexpr bool <a href='doc_expected.html#expected.hpp'>operator&lt;</a>(const <a href='doc_expected.html#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x, const <a href='doc_expected.html#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; e);
template &lt;class T, class E&gt; template &lt;class T, class E&gt;
constexpr bool <a href='doc_expected.md#expected.hpp'>operator&lt;</a>(const <a href='doc_expected.md#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; e, const <a href='doc_expected.md#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x); constexpr bool <a href='doc_expected.html#expected.hpp'>operator&lt;</a>(const <a href='doc_expected.html#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; e, const <a href='doc_expected.html#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x);
template &lt;class T, class E&gt; template &lt;class T, class E&gt;
constexpr bool <a href='doc_expected.md#expected.hpp'>operator&lt;=</a>(const <a href='doc_expected.md#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x, const <a href='doc_expected.md#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; e); constexpr bool <a href='doc_expected.html#expected.hpp'>operator&lt;=</a>(const <a href='doc_expected.html#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x, const <a href='doc_expected.html#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; e);
template &lt;class T, class E&gt; template &lt;class T, class E&gt;
constexpr bool <a href='doc_expected.md#expected.hpp'>operator&lt;=</a>(const <a href='doc_expected.md#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; e, const <a href='doc_expected.md#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x); constexpr bool <a href='doc_expected.html#expected.hpp'>operator&lt;=</a>(const <a href='doc_expected.html#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; e, const <a href='doc_expected.html#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x);
template &lt;class T, class E&gt; template &lt;class T, class E&gt;
constexpr bool <a href='doc_expected.md#expected.hpp'>operator&gt;</a>(const <a href='doc_expected.md#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x, const <a href='doc_expected.md#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; e); constexpr bool <a href='doc_expected.html#expected.hpp'>operator&gt;</a>(const <a href='doc_expected.html#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x, const <a href='doc_expected.html#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; e);
template &lt;class T, class E&gt; template &lt;class T, class E&gt;
constexpr bool <a href='doc_expected.md#expected.hpp'>operator&gt;</a>(const <a href='doc_expected.md#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; e, const <a href='doc_expected.md#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x); constexpr bool <a href='doc_expected.html#expected.hpp'>operator&gt;</a>(const <a href='doc_expected.html#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; e, const <a href='doc_expected.html#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x);
template &lt;class T, class E&gt; template &lt;class T, class E&gt;
constexpr bool <a href='doc_expected.md#expected.hpp'>operator&gt;=</a>(const <a href='doc_expected.md#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x, const <a href='doc_expected.md#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; e); constexpr bool <a href='doc_expected.html#expected.hpp'>operator&gt;=</a>(const <a href='doc_expected.html#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x, const <a href='doc_expected.html#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; e);
template &lt;class T, class E&gt; template &lt;class T, class E&gt;
constexpr bool <a href='doc_expected.md#expected.hpp'>operator&gt;=</a>(const <a href='doc_expected.md#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; e, const <a href='doc_expected.md#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x); constexpr bool <a href='doc_expected.html#expected.hpp'>operator&gt;=</a>(const <a href='doc_expected.html#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; e, const <a href='doc_expected.html#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; x);
template &lt;class T, class E, 'hidden'&gt; template &lt;class T, class E, 'hidden'&gt;
void <a href='doc_expected.md#expected.hpp'>swap</a>(<a href='doc_expected.md#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; lhs, <a href='doc_expected.md#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; rhs) noexcept(noexcept(lhs.swap(rhs))); void <a href='doc_expected.html#expected.hpp'>swap</a>(<a href='doc_expected.html#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; lhs, <a href='doc_expected.html#tl::expected-T,E-'>expected&lt;T, E&gt;</a>&amp; rhs) noexcept(noexcept(lhs.swap(rhs)));
}</code></pre> }</code></pre>
## Class `tl::monostate`<a id="tl::monostate"></a> ## Class `tl::monostate`<a id="tl::monostate"></a>
@@ -153,14 +161,14 @@ Used to represent an expected with no data
<pre><code class="language-cpp">struct in_place_t <pre><code class="language-cpp">struct in_place_t
{ {
<a href='doc_expected.md#tl::in_place_t'>in_place_t</a>() = default; <a href='doc_expected.html#tl::in_place_t'>in_place_t</a>() = default;
};</code></pre> };</code></pre>
A tag type to tell expected to construct its value in-place A tag type to tell expected to construct its value in-place
## Variable `tl::in_place`<a id="tl::in_place"></a> ## Variable `tl::in_place`<a id="tl::in_place"></a>
<pre><code class="language-cpp">constexpr <a href='doc_expected.md#tl::in_place_t'>in_place_t{}</a> in_place;</code></pre> <pre><code class="language-cpp">constexpr <a href='doc_expected.html#tl::in_place_t'>in_place_t{}</a> in_place;</code></pre>
A tag to tell expected to construct its value in-place A tag to tell expected to construct its value in-place
@@ -170,15 +178,15 @@ A tag to tell expected to construct its value in-place
class unexpected class unexpected
{ {
public: public:
<a href='doc_expected.md#tl::unexpected-E-'>unexpected</a>() = delete; <a href='doc_expected.html#tl::unexpected-E-'>unexpected</a>() = delete;
constexpr <a href='doc_expected.md#tl::unexpected-E-'>unexpected</a>(const E&amp; e); constexpr <a href='doc_expected.html#tl::unexpected-E-'>unexpected</a>(const E&amp; e);
constexpr <a href='doc_expected.md#tl::unexpected-E-'>unexpected</a>(E&amp;&amp; e); constexpr <a href='doc_expected.html#tl::unexpected-E-'>unexpected</a>(E&amp;&amp; e);
constexpr const E&amp; <a href='doc_expected.md#tl::unexpected-E-::value()const&'>value</a>() const &amp;; constexpr const E&amp; <a href='doc_expected.html#tl::unexpected-E-::value()const&'>value</a>() const &amp;;
constexpr E&amp; <a href='doc_expected.md#tl::unexpected-E-::value()const&'>value</a>() &amp;; E&amp; <a href='doc_expected.html#tl::unexpected-E-::value()const&'>value</a>() &amp;;
constexpr E&amp;&amp; <a href='doc_expected.md#tl::unexpected-E-::value()const&'>value</a>() &amp;&amp;; E&amp;&amp; <a href='doc_expected.html#tl::unexpected-E-::value()const&'>value</a>() &amp;&amp;;
};</code></pre> };</code></pre>
Used as a wrapper to store the unexpected value Used as a wrapper to store the unexpected value
@@ -187,9 +195,9 @@ Used as a wrapper to store the unexpected value
<pre><code class="language-cpp">(1) constexpr const E&amp; value() const &amp;; <pre><code class="language-cpp">(1) constexpr const E&amp; value() const &amp;;
(2) constexpr E&amp; value() &amp;; (2) E&amp; value() &amp;;
(3) constexpr E&amp;&amp; value() &amp;&amp;;</code></pre> (3) E&amp;&amp; value() &amp;&amp;;</code></pre>
*Returns*: the contained value *Returns*: the contained value
@@ -198,22 +206,22 @@ Used as a wrapper to store the unexpected value
## Comparison operator `tl::operator==`<a id="tl::operator==(constunexpected-E-&,constunexpected-E-&)"></a> ## Comparison operator `tl::operator==`<a id="tl::operator==(constunexpected-E-&,constunexpected-E-&)"></a>
<pre><code class="language-cpp">(1) template &lt;class E&gt; <pre><code class="language-cpp">(1) template &lt;class E&gt;
constexpr bool operator==(const <a href='doc_expected.md#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; lhs, const <a href='doc_expected.md#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; rhs); constexpr bool operator==(const <a href='doc_expected.html#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; lhs, const <a href='doc_expected.html#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; rhs);
(2) template &lt;class E&gt; (2) template &lt;class E&gt;
constexpr bool operator!=(const <a href='doc_expected.md#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; lhs, const <a href='doc_expected.md#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; rhs); constexpr bool operator!=(const <a href='doc_expected.html#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; lhs, const <a href='doc_expected.html#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; rhs);
(3) template &lt;class E&gt; (3) template &lt;class E&gt;
constexpr bool operator&lt;(const <a href='doc_expected.md#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; lhs, const <a href='doc_expected.md#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; rhs); constexpr bool operator&lt;(const <a href='doc_expected.html#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; lhs, const <a href='doc_expected.html#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; rhs);
(4) template &lt;class E&gt; (4) template &lt;class E&gt;
constexpr bool operator&lt;=(const <a href='doc_expected.md#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; lhs, const <a href='doc_expected.md#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; rhs); constexpr bool operator&lt;=(const <a href='doc_expected.html#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; lhs, const <a href='doc_expected.html#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; rhs);
(5) template &lt;class E&gt; (5) template &lt;class E&gt;
constexpr bool operator&gt;(const <a href='doc_expected.md#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; lhs, const <a href='doc_expected.md#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; rhs); constexpr bool operator&gt;(const <a href='doc_expected.html#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; lhs, const <a href='doc_expected.html#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; rhs);
(6) template &lt;class E&gt; (6) template &lt;class E&gt;
constexpr bool operator&gt;=(const <a href='doc_expected.md#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; lhs, const <a href='doc_expected.md#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; rhs);</code></pre> constexpr bool operator&gt;=(const <a href='doc_expected.html#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; lhs, const <a href='doc_expected.html#tl::unexpected-E-'>unexpected&lt;E&gt;</a>&amp; rhs);</code></pre>
Compares two unexpected objects Compares two unexpected objects
@@ -222,7 +230,7 @@ Simply compares lhs.value() to rhs.value()
## Function template `tl::make_unexpected`<a id="tl::make_unexpected(E&&)"></a> ## Function template `tl::make_unexpected`<a id="tl::make_unexpected(E&&)"></a>
<pre><code class="language-cpp">template &lt;class E&gt; <pre><code class="language-cpp">template &lt;class E&gt;
<a href='doc_expected.md#tl::unexpected-E-'>unexpected&lt;E&gt;</a> make_unexpected(E&amp;&amp; e);</code></pre> <a href='doc_expected.html#tl::unexpected-E-'>unexpected&lt;E&gt;</a> make_unexpected(E&amp;&amp; e);</code></pre>
Create an `unexpected` from `e`, deducing the return type Create an `unexpected` from `e`, deducing the return type
@@ -232,14 +240,14 @@ Create an `unexpected` from `e`, deducing the return type
<pre><code class="language-cpp">struct unexpect_t <pre><code class="language-cpp">struct unexpect_t
{ {
<a href='doc_expected.md#tl::unexpect_t'>unexpect_t</a>() = default; <a href='doc_expected.html#tl::unexpect_t'>unexpect_t</a>() = default;
};</code></pre> };</code></pre>
A tag type to tell expected to construct the unexpected value A tag type to tell expected to construct the unexpected value
## Variable `tl::unexpect`<a id="tl::unexpect"></a> ## Variable `tl::unexpect`<a id="tl::unexpect"></a>
<pre><code class="language-cpp">constexpr <a href='doc_expected.md#tl::unexpect_t'>unexpect_t{}</a> unexpect;</code></pre> <pre><code class="language-cpp">constexpr <a href='doc_expected.html#tl::unexpect_t'>unexpect_t{}</a> unexpect;</code></pre>
A tag to tell expected to construct the unexpected value A tag to tell expected to construct the unexpected value
@@ -249,112 +257,128 @@ A tag to tell expected to construct the unexpected value
class expected class expected
{ {
public: public:
using <a href='doc_expected.md#tl::expected-T,E-'>value_type</a> = T; using <a href='doc_expected.html#tl::expected-T,E-'>value_type</a> = T;
using <a href='doc_expected.md#tl::expected-T,E-'>error_type</a> = E; using <a href='doc_expected.html#tl::expected-T,E-'>error_type</a> = E;
using <a href='doc_expected.md#tl::expected-T,E-'>unexpected_type</a> = <a href='doc_expected.md#tl::unexpected-E-'>unexpected&lt;E&gt;</a>; using <a href='doc_expected.html#tl::expected-T,E-'>unexpected_type</a> = <a href='doc_expected.html#tl::unexpected-E-'>unexpected&lt;E&gt;</a>;
template &lt;class F&gt; template &lt;class F&gt;
'hidden' <a href='doc_expected.md#tl::expected-T,E-::and_then(F&&)&'>and_then</a>(F&amp;&amp; f) &amp;; 'hidden' <a href='doc_expected.html#tl::expected-T,E-::and_then(F&&)&'>and_then</a>(F&amp;&amp; f) &amp;;
template &lt;class F&gt; template &lt;class F&gt;
constexpr auto and_then(F &amp;&amp;f) &amp;&amp;; constexpr auto and_then(F &amp;&amp;f) &amp;&amp;;
template &lt;class F&gt; template &lt;class F&gt;
constexpr auto and_then(F &amp;&amp;f) const &amp;; constexpr auto and_then(F &amp;&amp;f) const &amp;;
template &lt;class F&gt;
constexpr auto and_then(F &amp;&amp;f) const &amp;&amp;;
template &lt;class F&gt; constexpr auto map(F &amp;&amp;f) &amp;; template &lt;class F&gt; constexpr auto map(F &amp;&amp;f) &amp;;
template &lt;class F&gt; constexpr auto map(F &amp;&amp;f) &amp;&amp;; template &lt;class F&gt; constexpr auto map(F &amp;&amp;f) &amp;&amp;;
template &lt;class F&gt; constexpr auto map(F &amp;&amp;f) const &amp;; template &lt;class F&gt; constexpr auto map(F &amp;&amp;f) const &amp;;
template &lt;class F&gt; constexpr auto map(F &amp;&amp;f) const &amp;&amp;;
template &lt;class F&gt; constexpr auto map_error(F &amp;&amp;f) &amp;; template &lt;class F&gt; constexpr auto map_error(F &amp;&amp;f) &amp;;
template &lt;class F&gt; constexpr auto map_error(F &amp;&amp;f) &amp;&amp;; template &lt;class F&gt; constexpr auto map_error(F &amp;&amp;f) &amp;&amp;;
template &lt;class F&gt; constexpr auto map_error(F &amp;&amp;f) const &amp;; template &lt;class F&gt; constexpr auto map_error(F &amp;&amp;f) const &amp;;
template &lt;class F&gt; constexpr auto map_error(F &amp;&amp;f) const &amp;&amp;;
constexpr <a href='doc_expected.md#tl::expected-T,E-'>expected</a>() = default; template &lt;class F&gt;
<a href='doc_expected.html#tl::expected-T,E-'>expected</a> <a href='doc_expected.html#tl::expected-T,E-::or_else(F&&)&'>or_else</a>(F&amp;&amp; f) &amp;;
constexpr <a href='doc_expected.md#tl::expected-T,E-'>expected</a>(const <a href='doc_expected.md#tl::expected-T,E-'>expected</a>&amp; rhs) = default; template &lt;class F&gt;
<a href='doc_expected.html#tl::expected-T,E-'>expected</a> <a href='doc_expected.html#tl::expected-T,E-'>or_else</a>(F&amp;&amp; f) &amp;&amp;;
constexpr <a href='doc_expected.md#tl::expected-T,E-'>expected</a>(<a href='doc_expected.md#tl::expected-T,E-'>expected</a>&amp;&amp; rhs) = default; template &lt;class F&gt;
constexpr <a href='doc_expected.html#tl::expected-T,E-'>expected</a> <a href='doc_expected.html#tl::expected-T,E-'>or_else</a>(F&amp;&amp; f) const &amp;;
constexpr <a href='doc_expected.md#tl::expected-T,E-'>expected</a>&amp; <a href='doc_expected.md#tl::expected-T,E-'>operator=</a>(const <a href='doc_expected.md#tl::expected-T,E-'>expected</a>&amp; rhs) = default; template &lt;class F&gt;
constexpr <a href='doc_expected.html#tl::expected-T,E-'>expected</a> <a href='doc_expected.html#tl::expected-T,E-'>or_else</a>(F&amp;&amp; f) const &amp;&amp;;
constexpr <a href='doc_expected.md#tl::expected-T,E-'>expected</a>&amp; <a href='doc_expected.md#tl::expected-T,E-'>operator=</a>(<a href='doc_expected.md#tl::expected-T,E-'>expected</a>&amp;&amp; rhs) = default; constexpr <a href='doc_expected.html#tl::expected-T,E-'>expected</a>() = default;
constexpr <a href='doc_expected.html#tl::expected-T,E-'>expected</a>(const <a href='doc_expected.html#tl::expected-T,E-'>expected</a>&amp; rhs) = default;
constexpr <a href='doc_expected.html#tl::expected-T,E-'>expected</a>(<a href='doc_expected.html#tl::expected-T,E-'>expected</a>&amp;&amp; rhs) = default;
<a href='doc_expected.html#tl::expected-T,E-'>expected</a>&amp; <a href='doc_expected.html#tl::expected-T,E-'>operator=</a>(const <a href='doc_expected.html#tl::expected-T,E-'>expected</a>&amp; rhs) = default;
<a href='doc_expected.html#tl::expected-T,E-'>expected</a>&amp; <a href='doc_expected.html#tl::expected-T,E-'>operator=</a>(<a href='doc_expected.html#tl::expected-T,E-'>expected</a>&amp;&amp; rhs) = default;
template &lt;class ... Args, 'hidden' ... = nullptr&gt; template &lt;class ... Args, 'hidden' ... = nullptr&gt;
constexpr <a href='doc_expected.md#tl::expected-T,E-'>expected</a>(<a href='doc_expected.md#tl::in_place_t'>in_place_t</a>, Args&amp;&amp;... args); constexpr <a href='doc_expected.html#tl::expected-T,E-'>expected</a>(<a href='doc_expected.html#tl::in_place_t'>in_place_t</a>, Args&amp;&amp;... args);
template &lt;class U, class ... Args, 'hidden' ... = nullptr&gt; template &lt;class U, class ... Args, 'hidden' ... = nullptr&gt;
constexpr <a href='doc_expected.md#tl::expected-T,E-'>expected</a>(<a href='doc_expected.md#tl::in_place_t'>in_place_t</a>, <a href='http://en.cppreference.com/mwiki/index.php?title=Special%3ASearch&search=std::initializer_list%3cU%3e'>std::initializer_list&lt;U&gt;</a> il, Args&amp;&amp;... args); constexpr <a href='doc_expected.html#tl::expected-T,E-'>expected</a>(<a href='doc_expected.html#tl::in_place_t'>in_place_t</a>, <a href='http://en.cppreference.com/mwiki/index.php?title=Special%3ASearch&search=std::initializer_list%3cU%3e'>std::initializer_list&lt;U&gt;</a> il, Args&amp;&amp;... args);
EXPLICIT constexpr expected(const unexpected&lt;G&gt; &amp;e); EXPLICIT constexpr expected(const unexpected&lt;G&gt; &amp;e);
EXPLICIT constexpr expected(unexpected&lt;G&gt; &amp;&amp;e); EXPLICIT constexpr expected(unexpected&lt;G&gt; &amp;&amp;e);
template &lt;class ... Args, 'hidden' ... = nullptr&gt; template &lt;class ... Args, 'hidden' ... = nullptr&gt;
constexpr <a href='doc_expected.md#tl::expected-T,E-'>expected</a>(<a href='doc_expected.md#tl::unexpect_t'>unexpect_t</a>, Args&amp;&amp;... args); constexpr <a href='doc_expected.html#tl::expected-T,E-'>expected</a>(<a href='doc_expected.html#tl::unexpect_t'>unexpect_t</a>, Args&amp;&amp;... args);
template &lt;class U, class G, 'hidden'&gt; template &lt;class U, class G, 'hidden', 'hidden'&gt;
constexpr <a href='doc_expected.md#tl::expected-T,E-'>expected</a>(const <a href='doc_expected.md#tl::expected-T,E-'>expected&lt;U, G&gt;</a>&amp; rhs); <a href='doc_expected.html#tl::expected-T,E-'>expected</a>(const <a href='doc_expected.html#tl::expected-T,E-'>expected&lt;U, G&gt;</a>&amp; rhs);
template &lt;class U, class G, 'hidden'&gt; template &lt;class U, class G, 'hidden', 'hidden'&gt;
constexpr <a href='doc_expected.md#tl::expected-T,E-'>expected</a>(<a href='doc_expected.md#tl::expected-T,E-'>expected&lt;U, G&gt;</a>&amp;&amp; rhs); <a href='doc_expected.html#tl::expected-T,E-'>expected</a>(<a href='doc_expected.html#tl::expected-T,E-'>expected&lt;U, G&gt;</a>&amp;&amp; rhs);
template &lt;class U = T, 'hidden'&gt;
constexpr <a href='doc_expected.md#tl::expected-T,E-'>expected</a>(U&amp;&amp; v);
template &lt;class U = T, 'hidden', 'hidden'&gt; template &lt;class U = T, 'hidden', 'hidden'&gt;
<a href='doc_expected.md#tl::expected-T,E-'>expected</a>&amp; <a href='doc_expected.md#tl::expected-T,E-'>operator=</a>(U&amp;&amp; v); constexpr <a href='doc_expected.html#tl::expected-T,E-'>expected</a>(U&amp;&amp; v);
template &lt;class U = T, 'hidden', 'hidden'&gt;
<a href='doc_expected.html#tl::expected-T,E-'>expected</a>&amp; <a href='doc_expected.html#tl::expected-T,E-'>operator=</a>(U&amp;&amp; v);
template &lt;class G = E, 'hidden'&gt; template &lt;class G = E, 'hidden'&gt;
<a href='doc_expected.md#tl::expected-T,E-'>expected</a>&amp; <a href='doc_expected.md#tl::expected-T,E-'>operator=</a>(const <a href='doc_expected.md#tl::unexpected-E-'>unexpected&lt;G&gt;</a>&amp; rhs); <a href='doc_expected.html#tl::expected-T,E-'>expected</a>&amp; <a href='doc_expected.html#tl::expected-T,E-'>operator=</a>(const <a href='doc_expected.html#tl::unexpected-E-'>unexpected&lt;G&gt;</a>&amp; rhs);
template &lt;class G = E, 'hidden'&gt; template &lt;class G = E, 'hidden'&gt;
<a href='doc_expected.md#tl::expected-T,E-'>expected</a>&amp; <a href='doc_expected.md#tl::expected-T,E-'>operator=</a>(<a href='doc_expected.md#tl::unexpected-E-'>unexpected&lt;G&gt;</a>&amp;&amp; rhs) noexcept; <a href='doc_expected.html#tl::expected-T,E-'>expected</a>&amp; <a href='doc_expected.html#tl::expected-T,E-'>operator=</a>(<a href='doc_expected.html#tl::unexpected-E-'>unexpected&lt;G&gt;</a>&amp;&amp; rhs) noexcept;
template &lt;class ... Args, 'hidden' ... = nullptr&gt; template &lt;class ... Args, 'hidden' ... = nullptr&gt;
void <a href='doc_expected.md#tl::expected-T,E-'>emplace</a>(Args&amp;&amp;... args); void <a href='doc_expected.html#tl::expected-T,E-'>emplace</a>(Args&amp;&amp;... args);
template &lt;class U, class ... Args, 'hidden' ... = nullptr&gt; template &lt;class U, class ... Args, 'hidden' ... = nullptr&gt;
void <a href='doc_expected.md#tl::expected-T,E-'>emplace</a>(<a href='http://en.cppreference.com/mwiki/index.php?title=Special%3ASearch&search=std::initializer_list%3cU%3e'>std::initializer_list&lt;U&gt;</a> il, Args&amp;&amp;... args); void <a href='doc_expected.html#tl::expected-T,E-'>emplace</a>(<a href='http://en.cppreference.com/mwiki/index.php?title=Special%3ASearch&search=std::initializer_list%3cU%3e'>std::initializer_list&lt;U&gt;</a> il, Args&amp;&amp;... args);
void <a href='doc_expected.md#tl::expected-T,E-'>swap</a>(<a href='doc_expected.md#tl::expected-T,E-'>expected</a>&amp; rhs) noexcept(std::is_nothrow_move_constructible&lt;T&gt;::value&amp;&amp;noexcept(swap(std::declval&lt;T&amp;&gt;(), std::declval&lt;T&amp;&gt;()))&amp;&amp;std::is_nothrow_move_constructible&lt;E&gt;::value&amp;&amp;noexcept(swap(std::declval&lt;E&amp;&gt;(), std::declval&lt;E&amp;&gt;()))); void <a href='doc_expected.html#tl::expected-T,E-'>swap</a>(<a href='doc_expected.html#tl::expected-T,E-'>expected</a>&amp; rhs) noexcept(std::is_nothrow_move_constructible&lt;T&gt;::value&amp;&amp;noexcept(swap(std::declval&lt;T&amp;&gt;(), std::declval&lt;T&amp;&gt;()))&amp;&amp;std::is_nothrow_move_constructible&lt;E&gt;::value&amp;&amp;noexcept(swap(std::declval&lt;E&amp;&gt;(), std::declval&lt;E&amp;&gt;())));
constexpr const T* <a href='doc_expected.md#tl::expected-T,E-'>operator-&gt;</a>() const; constexpr const T* <a href='doc_expected.html#tl::expected-T,E-'>operator-&gt;</a>() const;
constexpr T* <a href='doc_expected.md#tl::expected-T,E-'>operator-&gt;</a>(); T* <a href='doc_expected.html#tl::expected-T,E-'>operator-&gt;</a>();
constexpr const T&amp; <a href='doc_expected.md#tl::expected-T,E-'>operator*</a>() const &amp;; constexpr const T&amp; <a href='doc_expected.html#tl::expected-T,E-'>operator*</a>() const &amp;;
constexpr T&amp; <a href='doc_expected.md#tl::expected-T,E-'>operator*</a>() &amp;; T&amp; <a href='doc_expected.html#tl::expected-T,E-'>operator*</a>() &amp;;
constexpr const T&amp;&amp; <a href='doc_expected.md#tl::expected-T,E-'>operator*</a>() const &amp;&amp;; constexpr const T&amp;&amp; <a href='doc_expected.html#tl::expected-T,E-'>operator*</a>() const &amp;&amp;;
constexpr T&amp;&amp; <a href='doc_expected.md#tl::expected-T,E-'>operator*</a>() &amp;&amp;; T&amp;&amp; <a href='doc_expected.html#tl::expected-T,E-'>operator*</a>() &amp;&amp;;
constexpr <a href='doc_expected.md#tl::expected-T,E-'>operator bool</a>() const noexcept; constexpr <a href='doc_expected.html#tl::expected-T,E-'>operator bool</a>() const noexcept;
constexpr bool <a href='doc_expected.md#tl::expected-T,E-'>has_value</a>() const noexcept; constexpr bool <a href='doc_expected.html#tl::expected-T,E-'>has_value</a>() const noexcept;
constexpr const T&amp; <a href='doc_expected.md#tl::expected-T,E-'>value</a>() const &amp;; constexpr const T&amp; <a href='doc_expected.html#tl::expected-T,E-'>value</a>() const &amp;;
constexpr T&amp; <a href='doc_expected.md#tl::expected-T,E-'>value</a>() &amp;; T&amp; <a href='doc_expected.html#tl::expected-T,E-'>value</a>() &amp;;
constexpr const T&amp;&amp; <a href='doc_expected.md#tl::expected-T,E-'>value</a>() const &amp;&amp;; constexpr const T&amp;&amp; <a href='doc_expected.html#tl::expected-T,E-'>value</a>() const &amp;&amp;;
constexpr T&amp;&amp; <a href='doc_expected.md#tl::expected-T,E-'>value</a>() &amp;&amp;; T&amp;&amp; <a href='doc_expected.html#tl::expected-T,E-'>value</a>() &amp;&amp;;
constexpr const E&amp; <a href='doc_expected.md#tl::expected-T,E-'>error</a>() const &amp;; constexpr const E&amp; <a href='doc_expected.html#tl::expected-T,E-'>error</a>() const &amp;;
constexpr E&amp; <a href='doc_expected.md#tl::expected-T,E-'>error</a>() &amp;; E&amp; <a href='doc_expected.html#tl::expected-T,E-'>error</a>() &amp;;
constexpr const E&amp;&amp; <a href='doc_expected.md#tl::expected-T,E-'>error</a>() const &amp;&amp;; constexpr const E&amp;&amp; <a href='doc_expected.html#tl::expected-T,E-'>error</a>() const &amp;&amp;;
constexpr E&amp;&amp; <a href='doc_expected.md#tl::expected-T,E-'>error</a>() &amp;&amp;; E&amp;&amp; <a href='doc_expected.html#tl::expected-T,E-'>error</a>() &amp;&amp;;
template &lt;class U&gt; template &lt;class U&gt;
constexpr T <a href='doc_expected.md#tl::expected-T,E-'>value_or</a>(U&amp;&amp; v) const &amp;; constexpr T <a href='doc_expected.html#tl::expected-T,E-'>value_or</a>(U&amp;&amp; v) const &amp;;
template &lt;class U&gt; template &lt;class U&gt;
T <a href='doc_expected.md#tl::expected-T,E-'>value_or</a>(U&amp;&amp; v) &amp;&amp;; T <a href='doc_expected.html#tl::expected-T,E-'>value_or</a>(U&amp;&amp; v) &amp;&amp;;
};</code></pre> };</code></pre>
An `expected<T, E>` object is an object that contains the storage for another object and manages the lifetime of this contained object `T`. Alternatively it could contain the storage for another unexpected object `E`. The contained object may not be initialized after the expected object has been initialized, and may not be destroyed before the expected object has been destroyed. The initialization state of the contained object is tracked by the expected object. An `expected<T, E>` object is an object that contains the storage for another object and manages the lifetime of this contained object `T`. Alternatively it could contain the storage for another unexpected object `E`. The contained object may not be initialized after the expected object has been initialized, and may not be destroyed before the expected object has been destroyed. The initialization state of the contained object is tracked by the expected object.
@@ -368,9 +392,12 @@ An `expected<T, E>` object is an object that contains the storage for another ob
constexpr auto and_then(F &amp;&amp;f) &amp;&amp;; constexpr auto and_then(F &amp;&amp;f) &amp;&amp;;
(3) template &lt;class F&gt; (3) template &lt;class F&gt;
constexpr auto and_then(F &amp;&amp;f) const &amp;;</code></pre> constexpr auto and_then(F &amp;&amp;f) const &amp;;
Carries out some operation which returns an optional on the stored object if there is one. \\requires `std::invoke(std::forward<F>(f), value())` returns a `std::optional<U>` for some `U`. \\returns Let `U` be the result of `std::invoke(std::forward<F>(f), value())`. Returns a `std::optional<U>`. The return value is empty if `*this` is empty, otherwise the return value of `std::invoke(std::forward<F>(f), value())` is returned. \\group and\_then \\synopsis template \<class F\>\\nconstexpr auto and\_then(F &\&f) &; (4) template &lt;class F&gt;
constexpr auto and_then(F &amp;&amp;f) const &amp;&amp;;</code></pre>
Carries out some operation which returns an expected on the stored object if there is one. \\requires `std::invoke(std::forward<F>(f), value())` returns a `std::expected<U>` for some `U`. \\returns Let `U` be the result of `std::invoke(std::forward<F>(f), value())`. Returns a `std::expected<U>`. The return value is empty if `*this` is empty, otherwise the return value of `std::invoke(std::forward<F>(f), value())` is returned. \\group and\_then \\synopsis template \<class F\>\\nconstexpr auto and\_then(F &\&f) &;
### Function template `tl::expected::map`<a id="tl::expected-T,E-::map(F&&)&"></a> ### Function template `tl::expected::map`<a id="tl::expected-T,E-::map(F&&)&"></a>
@@ -378,7 +405,9 @@ Carries out some operation which returns an optional on the stored object if the
(2) template &lt;class F&gt; constexpr auto map(F &amp;&amp;f) &amp;&amp;; (2) template &lt;class F&gt; constexpr auto map(F &amp;&amp;f) &amp;&amp;;
(3) template &lt;class F&gt; constexpr auto map(F &amp;&amp;f) const &amp;;</code></pre> (3) template &lt;class F&gt; constexpr auto map(F &amp;&amp;f) const &amp;;
(4) template &lt;class F&gt; constexpr auto map(F &amp;&amp;f) const &amp;&amp;;</code></pre>
Carries out some operation on the stored object if there is one. Carries out some operation on the stored object if there is one.
@@ -390,12 +419,25 @@ Carries out some operation on the stored object if there is one.
(2) template &lt;class F&gt; constexpr auto map_error(F &amp;&amp;f) &amp;&amp;; (2) template &lt;class F&gt; constexpr auto map_error(F &amp;&amp;f) &amp;&amp;;
(3) template &lt;class F&gt; constexpr auto map_error(F &amp;&amp;f) const &amp;;</code></pre> (3) template &lt;class F&gt; constexpr auto map_error(F &amp;&amp;f) const &amp;;
(4) template &lt;class F&gt; constexpr auto map_error(F &amp;&amp;f) const &amp;&amp;;</code></pre>
Carries out some operation on the stored unexpected object if there is one. Carries out some operation on the stored unexpected object if there is one.
*Returns*: Let `U` be the result of `std::invoke(std::forward<F>(f), value())`. Returns a `std::expected<T,U>`. If `*this` has an expected value, the result is `*this`, otherwise an `expected<T,U>` is constructed from `make_unexpected(std::invoke(std::forward<F>(f), value()))` and is returned. *Returns*: Let `U` be the result of `std::invoke(std::forward<F>(f), value())`. Returns a `std::expected<T,U>`. If `*this` has an expected value, the result is `*this`, otherwise an `expected<T,U>` is constructed from `make_unexpected(std::invoke(std::forward<F>(f), value()))` and is returned.
### Function template `tl::expected::or_else`<a id="tl::expected-T,E-::or_else(F&&)&"></a>
<pre><code class="language-cpp">(1) template &lt;class F&gt;
<a href='doc_expected.html#tl::expected-T,E-'>expected</a> or_else(F&amp;&amp; f) &amp;;</code></pre>
Calls `f` if the expectd is in the unexpected state
*Requires*: `std::invoke_result_t<F>` must be void or convertible to `expcted<T,E>`.
*Effects*: If `*this` has a value, returns `*this`. Otherwise, if `f` returns `void`, calls `std::forward<F>(f)` and returns `std::nullopt`. Otherwise, returns `std::forward<F>(f)()`.
### Function template `tl::expected::expected`<a id="tl::expected-T,E-::expected(constunexpected-G-&)"></a> ### Function template `tl::expected::expected`<a id="tl::expected-T,E-::expected(constunexpected-G-&)"></a>
<pre><code class="language-cpp">(1) EXPLICIT constexpr expected(const unexpected&lt;G&gt; &amp;e); <pre><code class="language-cpp">(1) EXPLICIT constexpr expected(const unexpected&lt;G&gt; &amp;e);

1
standardese.config
View File

@@ -1,2 +1,3 @@
[output] [output]
format=commonmark format=commonmark
link_extension=html