mirror of
https://github.com/TartanLlama/expected.git
synced 2025-08-03 10:54:31 +02:00
Remove old docs
This commit is contained in:
Simon Brand
@@ -3,7 +3,6 @@ cmake_minimum_required(VERSION 3.0)
|
||||
project(expected)
|
||||
|
||||
option(EXPECTED_ENABLE_TESTS "Enable tests." ON)
|
||||
option(EXPECTED_ENABLE_DOCS "Enable documentation." ON)
|
||||
|
||||
add_library(expected INTERFACE)
|
||||
target_sources(expected INTERFACE ${CMAKE_CURRENT_SOURCE_DIR}/tl/expected.hpp)
|
||||
@@ -34,15 +33,3 @@ if(EXPECTED_ENABLE_TESTS)
|
||||
set_property(TARGET tests PROPERTY CXX_STANDARD ${CXXSTD})
|
||||
set_property(TARGET tests PROPERTY CXX_FLAGS "-Wall -Wextra")
|
||||
endif()
|
||||
|
||||
if(EXPECTED_ENABLE_DOCS)
|
||||
find_package(standardese) # find standardese after installation
|
||||
|
||||
# generates a custom target that will run standardese to generate the documentation
|
||||
if(standardese_FOUND)
|
||||
standardese_generate(expected
|
||||
INCLUDE_DIRECTORY tl
|
||||
CONFIG ${CMAKE_CURRENT_SOURCE_DIR}/standardese.config
|
||||
INPUT tl/expected.hpp)
|
||||
endif()
|
||||
endif()
|
||||
|
||||
@@ -1 +0,0 @@
|
||||
expected.tartanllama.xyz
|
||||
499
docs/index.md
499
docs/index.md
@@ -1,499 +0,0 @@
|
||||
# Header file `expected.hpp`<a id="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.html#expected.hpp'>TL_EXPECTED_VERSION_MAJOR</a>
|
||||
|
||||
#define <a href='doc_expected.html#expected.hpp'>TL_EXPECTED_VERSION_MINOR</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.html#tl::monostate'>monostate</a>;
|
||||
|
||||
struct <a href='doc_expected.html#tl::in_place_t'>in_place_t</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 <class E>
|
||||
class <a href='doc_expected.html#tl::unexpected-E-'>unexpected</a>;
|
||||
|
||||
template <class E>
|
||||
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<E></a>& lhs, const <a href='doc_expected.html#tl::unexpected-E-'>unexpected<E></a>& rhs);
|
||||
template <class E>
|
||||
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<E></a>& lhs, const <a href='doc_expected.html#tl::unexpected-E-'>unexpected<E></a>& rhs);
|
||||
template <class E>
|
||||
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<E></a>& lhs, const <a href='doc_expected.html#tl::unexpected-E-'>unexpected<E></a>& rhs);
|
||||
template <class E>
|
||||
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<E></a>& lhs, const <a href='doc_expected.html#tl::unexpected-E-'>unexpected<E></a>& rhs);
|
||||
template <class E>
|
||||
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<E></a>& lhs, const <a href='doc_expected.html#tl::unexpected-E-'>unexpected<E></a>& rhs);
|
||||
template <class E>
|
||||
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<E></a>& lhs, const <a href='doc_expected.html#tl::unexpected-E-'>unexpected<E></a>& rhs);
|
||||
|
||||
template <class E>
|
||||
<a href='doc_expected.html#tl::unexpected-E-'>unexpected<E></a> <a href='doc_expected.html#tl::make_unexpected(E&&)'>make_unexpected</a>(E&& e);
|
||||
|
||||
struct <a href='doc_expected.html#tl::unexpect_t'>unexpect_t</a>;
|
||||
|
||||
constexpr <a href='doc_expected.html#tl::unexpect_t'>unexpect_t{}</a> <a href='doc_expected.html#tl::unexpect'>unexpect</a>;
|
||||
|
||||
template <class E>
|
||||
class <a href='doc_expected.html#expected.hpp'>bad_expected_access</a>;
|
||||
|
||||
template <class T, class E>
|
||||
class <a href='doc_expected.html#tl::expected-T,E-'>expected</a>;
|
||||
|
||||
template <class T, class E, class U, class F>
|
||||
constexpr bool <a href='doc_expected.html#expected.hpp'>operator==</a>(const <a href='doc_expected.html#tl::expected-T,E-'>expected<T, E></a>& lhs, const <a href='doc_expected.html#tl::expected-T,E-'>expected<U, F></a>& rhs);
|
||||
|
||||
template <class T, class E, class U, class F>
|
||||
constexpr bool <a href='doc_expected.html#expected.hpp'>operator!=</a>(const <a href='doc_expected.html#tl::expected-T,E-'>expected<T, E></a>& lhs, const <a href='doc_expected.html#tl::expected-T,E-'>expected<U, F></a>& rhs);
|
||||
|
||||
template <class T, class E, class U, class F>
|
||||
constexpr bool <a href='doc_expected.html#expected.hpp'>operator<</a>(const <a href='doc_expected.html#tl::expected-T,E-'>expected<T, E></a>& lhs, const <a href='doc_expected.html#tl::expected-T,E-'>expected<U, F></a>& rhs);
|
||||
|
||||
template <class T, class E, class U, class F>
|
||||
constexpr bool <a href='doc_expected.html#expected.hpp'>operator></a>(const <a href='doc_expected.html#tl::expected-T,E-'>expected<T, E></a>& lhs, const <a href='doc_expected.html#tl::expected-T,E-'>expected<U, F></a>& rhs);
|
||||
|
||||
template <class T, class E, class U, class F>
|
||||
constexpr bool <a href='doc_expected.html#expected.hpp'>operator<=</a>(const <a href='doc_expected.html#tl::expected-T,E-'>expected<T, E></a>& lhs, const <a href='doc_expected.html#tl::expected-T,E-'>expected<U, F></a>& rhs);
|
||||
|
||||
template <class T, class E, class U, class F>
|
||||
constexpr bool <a href='doc_expected.html#expected.hpp'>operator>=</a>(const <a href='doc_expected.html#tl::expected-T,E-'>expected<T, E></a>& lhs, const <a href='doc_expected.html#tl::expected-T,E-'>expected<U, F></a>& rhs);
|
||||
|
||||
template <class T, class E, class U>
|
||||
constexpr bool <a href='doc_expected.html#expected.hpp'>operator==</a>(const <a href='doc_expected.html#tl::expected-T,E-'>expected<T, E></a>& x, const U& v);
|
||||
|
||||
template <class T, class E, class U>
|
||||
constexpr bool <a href='doc_expected.html#expected.hpp'>operator==</a>(const U& v, const <a href='doc_expected.html#tl::expected-T,E-'>expected<T, E></a>& x);
|
||||
|
||||
template <class T, class E, class U>
|
||||
constexpr bool <a href='doc_expected.html#expected.hpp'>operator!=</a>(const <a href='doc_expected.html#tl::expected-T,E-'>expected<T, E></a>& x, const U& v);
|
||||
|
||||
template <class T, class E, class U>
|
||||
constexpr bool <a href='doc_expected.html#expected.hpp'>operator!=</a>(const U& v, const <a href='doc_expected.html#tl::expected-T,E-'>expected<T, E></a>& x);
|
||||
|
||||
template <class T, class E, class U>
|
||||
constexpr bool <a href='doc_expected.html#expected.hpp'>operator<</a>(const <a href='doc_expected.html#tl::expected-T,E-'>expected<T, E></a>& x, const U& v);
|
||||
|
||||
template <class T, class E, class U>
|
||||
constexpr bool <a href='doc_expected.html#expected.hpp'>operator<</a>(const U& v, const <a href='doc_expected.html#tl::expected-T,E-'>expected<T, E></a>& x);
|
||||
|
||||
template <class T, class E, class U>
|
||||
constexpr bool <a href='doc_expected.html#expected.hpp'>operator<=</a>(const <a href='doc_expected.html#tl::expected-T,E-'>expected<T, E></a>& x, const U& v);
|
||||
|
||||
template <class T, class E, class U>
|
||||
constexpr bool <a href='doc_expected.html#expected.hpp'>operator<=</a>(const U& v, const <a href='doc_expected.html#tl::expected-T,E-'>expected<T, E></a>& x);
|
||||
|
||||
template <class T, class E, class U>
|
||||
constexpr bool <a href='doc_expected.html#expected.hpp'>operator></a>(const <a href='doc_expected.html#tl::expected-T,E-'>expected<T, E></a>& x, const U& v);
|
||||
|
||||
template <class T, class E, class U>
|
||||
constexpr bool <a href='doc_expected.html#expected.hpp'>operator></a>(const U& v, const <a href='doc_expected.html#tl::expected-T,E-'>expected<T, E></a>& x);
|
||||
|
||||
template <class T, class E, class U>
|
||||
constexpr bool <a href='doc_expected.html#expected.hpp'>operator>=</a>(const <a href='doc_expected.html#tl::expected-T,E-'>expected<T, E></a>& x, const U& v);
|
||||
|
||||
template <class T, class E, class U>
|
||||
constexpr bool <a href='doc_expected.html#expected.hpp'>operator>=</a>(const U& v, const <a href='doc_expected.html#tl::expected-T,E-'>expected<T, E></a>& x);
|
||||
|
||||
template <class T, class E>
|
||||
constexpr bool <a href='doc_expected.html#expected.hpp'>operator==</a>(const <a href='doc_expected.html#tl::expected-T,E-'>expected<T, E></a>& x, const <a href='doc_expected.html#tl::unexpected-E-'>unexpected<E></a>& e);
|
||||
|
||||
template <class T, class E>
|
||||
constexpr bool <a href='doc_expected.html#expected.hpp'>operator==</a>(const <a href='doc_expected.html#tl::unexpected-E-'>unexpected<E></a>& e, const <a href='doc_expected.html#tl::expected-T,E-'>expected<T, E></a>& x);
|
||||
|
||||
template <class T, class E>
|
||||
constexpr bool <a href='doc_expected.html#expected.hpp'>operator!=</a>(const <a href='doc_expected.html#tl::expected-T,E-'>expected<T, E></a>& x, const <a href='doc_expected.html#tl::unexpected-E-'>unexpected<E></a>& e);
|
||||
|
||||
template <class T, class E>
|
||||
constexpr bool <a href='doc_expected.html#expected.hpp'>operator!=</a>(const <a href='doc_expected.html#tl::unexpected-E-'>unexpected<E></a>& e, const <a href='doc_expected.html#tl::expected-T,E-'>expected<T, E></a>& x);
|
||||
|
||||
template <class T, class E>
|
||||
constexpr bool <a href='doc_expected.html#expected.hpp'>operator<</a>(const <a href='doc_expected.html#tl::expected-T,E-'>expected<T, E></a>& x, const <a href='doc_expected.html#tl::unexpected-E-'>unexpected<E></a>& e);
|
||||
|
||||
template <class T, class E>
|
||||
constexpr bool <a href='doc_expected.html#expected.hpp'>operator<</a>(const <a href='doc_expected.html#tl::unexpected-E-'>unexpected<E></a>& e, const <a href='doc_expected.html#tl::expected-T,E-'>expected<T, E></a>& x);
|
||||
|
||||
template <class T, class E>
|
||||
constexpr bool <a href='doc_expected.html#expected.hpp'>operator<=</a>(const <a href='doc_expected.html#tl::expected-T,E-'>expected<T, E></a>& x, const <a href='doc_expected.html#tl::unexpected-E-'>unexpected<E></a>& e);
|
||||
|
||||
template <class T, class E>
|
||||
constexpr bool <a href='doc_expected.html#expected.hpp'>operator<=</a>(const <a href='doc_expected.html#tl::unexpected-E-'>unexpected<E></a>& e, const <a href='doc_expected.html#tl::expected-T,E-'>expected<T, E></a>& x);
|
||||
|
||||
template <class T, class E>
|
||||
constexpr bool <a href='doc_expected.html#expected.hpp'>operator></a>(const <a href='doc_expected.html#tl::expected-T,E-'>expected<T, E></a>& x, const <a href='doc_expected.html#tl::unexpected-E-'>unexpected<E></a>& e);
|
||||
|
||||
template <class T, class E>
|
||||
constexpr bool <a href='doc_expected.html#expected.hpp'>operator></a>(const <a href='doc_expected.html#tl::unexpected-E-'>unexpected<E></a>& e, const <a href='doc_expected.html#tl::expected-T,E-'>expected<T, E></a>& x);
|
||||
|
||||
template <class T, class E>
|
||||
constexpr bool <a href='doc_expected.html#expected.hpp'>operator>=</a>(const <a href='doc_expected.html#tl::expected-T,E-'>expected<T, E></a>& x, const <a href='doc_expected.html#tl::unexpected-E-'>unexpected<E></a>& e);
|
||||
|
||||
template <class T, class E>
|
||||
constexpr bool <a href='doc_expected.html#expected.hpp'>operator>=</a>(const <a href='doc_expected.html#tl::unexpected-E-'>unexpected<E></a>& e, const <a href='doc_expected.html#tl::expected-T,E-'>expected<T, E></a>& x);
|
||||
|
||||
template <class T, class E, 'hidden'>
|
||||
void <a href='doc_expected.html#expected.hpp'>swap</a>(<a href='doc_expected.html#tl::expected-T,E-'>expected<T, E></a>& lhs, <a href='doc_expected.html#tl::expected-T,E-'>expected<T, E></a>& rhs) noexcept(noexcept(lhs.swap(rhs)));
|
||||
}</code></pre>
|
||||
|
||||
## Class `tl::monostate`<a id="tl::monostate"></a>
|
||||
|
||||
<pre><code class="language-cpp">class monostate
|
||||
{
|
||||
};</code></pre>
|
||||
|
||||
Used to represent an expected with no data
|
||||
|
||||
## Struct `tl::in_place_t`<a id="tl::in_place_t"></a>
|
||||
|
||||
<pre><code class="language-cpp">struct in_place_t
|
||||
{
|
||||
<a href='doc_expected.html#tl::in_place_t'>in_place_t</a>() = default;
|
||||
};</code></pre>
|
||||
|
||||
A tag type to tell expected to construct its value in-place
|
||||
|
||||
## Variable `tl::in_place`<a id="tl::in_place"></a>
|
||||
|
||||
<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
|
||||
|
||||
## Class template `tl::unexpected`<a id="tl::unexpected-E-"></a>
|
||||
|
||||
<pre><code class="language-cpp">template <class E>
|
||||
class unexpected
|
||||
{
|
||||
public:
|
||||
<a href='doc_expected.html#tl::unexpected-E-'>unexpected</a>() = delete;
|
||||
|
||||
constexpr <a href='doc_expected.html#tl::unexpected-E-'>unexpected</a>(const E& e);
|
||||
|
||||
constexpr <a href='doc_expected.html#tl::unexpected-E-'>unexpected</a>(E&& e);
|
||||
|
||||
constexpr const E& <a href='doc_expected.html#tl::unexpected-E-::value()const&'>value</a>() const &;
|
||||
E& <a href='doc_expected.html#tl::unexpected-E-::value()const&'>value</a>() &;
|
||||
E&& <a href='doc_expected.html#tl::unexpected-E-::value()const&'>value</a>() &&;
|
||||
};</code></pre>
|
||||
|
||||
Used as a wrapper to store the unexpected value
|
||||
|
||||
### Function `tl::unexpected::value`<a id="tl::unexpected-E-::value()const&"></a>
|
||||
|
||||
<pre><code class="language-cpp">(1) constexpr const E& value() const &;
|
||||
|
||||
(2) E& value() &;
|
||||
|
||||
(3) E&& value() &&;</code></pre>
|
||||
|
||||
*Returns*: the contained value
|
||||
|
||||
-----
|
||||
|
||||
## Comparison operator `tl::operator==`<a id="tl::operator==(constunexpected-E-&,constunexpected-E-&)"></a>
|
||||
|
||||
<pre><code class="language-cpp">(1) template <class E>
|
||||
constexpr bool operator==(const <a href='doc_expected.html#tl::unexpected-E-'>unexpected<E></a>& lhs, const <a href='doc_expected.html#tl::unexpected-E-'>unexpected<E></a>& rhs);
|
||||
|
||||
(2) template <class E>
|
||||
constexpr bool operator!=(const <a href='doc_expected.html#tl::unexpected-E-'>unexpected<E></a>& lhs, const <a href='doc_expected.html#tl::unexpected-E-'>unexpected<E></a>& rhs);
|
||||
|
||||
(3) template <class E>
|
||||
constexpr bool operator<(const <a href='doc_expected.html#tl::unexpected-E-'>unexpected<E></a>& lhs, const <a href='doc_expected.html#tl::unexpected-E-'>unexpected<E></a>& rhs);
|
||||
|
||||
(4) template <class E>
|
||||
constexpr bool operator<=(const <a href='doc_expected.html#tl::unexpected-E-'>unexpected<E></a>& lhs, const <a href='doc_expected.html#tl::unexpected-E-'>unexpected<E></a>& rhs);
|
||||
|
||||
(5) template <class E>
|
||||
constexpr bool operator>(const <a href='doc_expected.html#tl::unexpected-E-'>unexpected<E></a>& lhs, const <a href='doc_expected.html#tl::unexpected-E-'>unexpected<E></a>& rhs);
|
||||
|
||||
(6) template <class E>
|
||||
constexpr bool operator>=(const <a href='doc_expected.html#tl::unexpected-E-'>unexpected<E></a>& lhs, const <a href='doc_expected.html#tl::unexpected-E-'>unexpected<E></a>& rhs);</code></pre>
|
||||
|
||||
Compares two unexpected objects
|
||||
|
||||
Simply compares lhs.value() to rhs.value()
|
||||
|
||||
## Function template `tl::make_unexpected`<a id="tl::make_unexpected(E&&)"></a>
|
||||
|
||||
<pre><code class="language-cpp">template <class E>
|
||||
<a href='doc_expected.html#tl::unexpected-E-'>unexpected<E></a> make_unexpected(E&& e);</code></pre>
|
||||
|
||||
Create an `unexpected` from `e`, deducing the return type
|
||||
|
||||
*Example:* auto e1 = tl::make\_unexpected(42); unexpected\<int\> e2 (42); //same semantics
|
||||
|
||||
## Struct `tl::unexpect_t`<a id="tl::unexpect_t"></a>
|
||||
|
||||
<pre><code class="language-cpp">struct unexpect_t
|
||||
{
|
||||
<a href='doc_expected.html#tl::unexpect_t'>unexpect_t</a>() = default;
|
||||
};</code></pre>
|
||||
|
||||
A tag type to tell expected to construct the unexpected value
|
||||
|
||||
## Variable `tl::unexpect`<a id="tl::unexpect"></a>
|
||||
|
||||
<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
|
||||
|
||||
## Class template `tl::expected`<a id="tl::expected-T,E-"></a>
|
||||
|
||||
<pre><code class="language-cpp">template <class T, class E>
|
||||
class expected
|
||||
{
|
||||
public:
|
||||
using <a href='doc_expected.html#tl::expected-T,E-'>value_type</a> = T;
|
||||
|
||||
using <a href='doc_expected.html#tl::expected-T,E-'>error_type</a> = E;
|
||||
|
||||
using <a href='doc_expected.html#tl::expected-T,E-'>unexpected_type</a> = <a href='doc_expected.html#tl::unexpected-E-'>unexpected<E></a>;
|
||||
|
||||
template <class F>
|
||||
constexpr auto and_then(F &&f) &;
|
||||
template <class F>
|
||||
constexpr auto and_then(F &&f) &&;
|
||||
template <class F>
|
||||
constexpr auto and_then(F &&f) const &;
|
||||
template <class F>
|
||||
constexpr auto and_then(F &&f) const &&;
|
||||
|
||||
template <class F> constexpr auto map(F &&f) &;
|
||||
template <class F> constexpr auto map(F &&f) &&;
|
||||
template <class F> constexpr auto map(F &&f) const &;
|
||||
template <class F> constexpr auto map(F &&f) const &&;
|
||||
|
||||
template <class F> constexpr auto map_error(F &&f) &;
|
||||
template <class F> constexpr auto map_error(F &&f) &&;
|
||||
template <class F> constexpr auto map_error(F &&f) const &;
|
||||
template <class F> constexpr auto map_error(F &&f) const &&;
|
||||
|
||||
template <class F>
|
||||
<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&& f) &;
|
||||
|
||||
template <class F>
|
||||
<a href='doc_expected.html#tl::expected-T,E-'>expected</a> <a href='doc_expected.html#tl::expected-T,E-'>or_else</a>(F&& f) &&;
|
||||
|
||||
template <class F>
|
||||
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&& f) const &;
|
||||
|
||||
template <class F>
|
||||
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&& f) const &&;
|
||||
|
||||
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>& 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>&& rhs) = default;
|
||||
|
||||
<a href='doc_expected.html#tl::expected-T,E-'>expected</a>& <a href='doc_expected.html#tl::expected-T,E-'>operator=</a>(const <a href='doc_expected.html#tl::expected-T,E-'>expected</a>& rhs) = default;
|
||||
|
||||
<a href='doc_expected.html#tl::expected-T,E-'>expected</a>& <a href='doc_expected.html#tl::expected-T,E-'>operator=</a>(<a href='doc_expected.html#tl::expected-T,E-'>expected</a>&& rhs) = default;
|
||||
|
||||
template <class ... Args, 'hidden' ... = nullptr>
|
||||
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&&... args);
|
||||
|
||||
template <class U, class ... Args, 'hidden' ... = nullptr>
|
||||
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<U></a> il, Args&&... args);
|
||||
|
||||
EXPLICIT constexpr expected(const unexpected<G> &e);
|
||||
EXPLICIT constexpr expected(unexpected<G> &&e);
|
||||
|
||||
template <class ... Args, 'hidden' ... = nullptr>
|
||||
constexpr <a href='doc_expected.html#tl::expected-T,E-'>expected</a>(<a href='doc_expected.html#tl::unexpect_t'>unexpect_t</a>, Args&&... args);
|
||||
|
||||
template <class U, class G, 'hidden', 'hidden'>
|
||||
<a href='doc_expected.html#tl::expected-T,E-'>expected</a>(const <a href='doc_expected.html#tl::expected-T,E-'>expected<U, G></a>& rhs);
|
||||
|
||||
template <class U, class G, 'hidden', 'hidden'>
|
||||
<a href='doc_expected.html#tl::expected-T,E-'>expected</a>(<a href='doc_expected.html#tl::expected-T,E-'>expected<U, G></a>&& rhs);
|
||||
|
||||
template <class U = T, 'hidden', 'hidden'>
|
||||
constexpr <a href='doc_expected.html#tl::expected-T,E-'>expected</a>(U&& v);
|
||||
|
||||
template <class U = T, 'hidden', 'hidden'>
|
||||
<a href='doc_expected.html#tl::expected-T,E-'>expected</a>& <a href='doc_expected.html#tl::expected-T,E-'>operator=</a>(U&& v);
|
||||
|
||||
template <class G = E, 'hidden'>
|
||||
<a href='doc_expected.html#tl::expected-T,E-'>expected</a>& <a href='doc_expected.html#tl::expected-T,E-'>operator=</a>(const <a href='doc_expected.html#tl::unexpected-E-'>unexpected<G></a>& rhs);
|
||||
|
||||
template <class G = E, 'hidden'>
|
||||
<a href='doc_expected.html#tl::expected-T,E-'>expected</a>& <a href='doc_expected.html#tl::expected-T,E-'>operator=</a>(<a href='doc_expected.html#tl::unexpected-E-'>unexpected<G></a>&& rhs) noexcept;
|
||||
|
||||
template <class ... Args, 'hidden' ... = nullptr>
|
||||
void <a href='doc_expected.html#tl::expected-T,E-'>emplace</a>(Args&&... args);
|
||||
|
||||
template <class U, class ... Args, 'hidden' ... = nullptr>
|
||||
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<U></a> il, Args&&... args);
|
||||
|
||||
void <a href='doc_expected.html#tl::expected-T,E-'>swap</a>(<a href='doc_expected.html#tl::expected-T,E-'>expected</a>& rhs) noexcept(std::is_nothrow_move_constructible<T>::value&&noexcept(swap(std::declval<T&>(), std::declval<T&>()))&&std::is_nothrow_move_constructible<E>::value&&noexcept(swap(std::declval<E&>(), std::declval<E&>())));
|
||||
|
||||
constexpr const T* <a href='doc_expected.html#tl::expected-T,E-::operator--()const'>operator-></a>() const;
|
||||
T* <a href='doc_expected.html#tl::expected-T,E-::operator--()const'>operator-></a>();
|
||||
|
||||
constexpr const T& <a href='doc_expected.html#tl::expected-T,E-::operator*()const&'>operator*</a>() const &;
|
||||
T& <a href='doc_expected.html#tl::expected-T,E-::operator*()const&'>operator*</a>() &;
|
||||
constexpr const T&& <a href='doc_expected.html#tl::expected-T,E-::operator*()const&'>operator*</a>() const &&;
|
||||
T&& <a href='doc_expected.html#tl::expected-T,E-::operator*()const&'>operator*</a>() &&;
|
||||
|
||||
constexpr bool <a href='doc_expected.html#tl::expected-T,E-::has_value()const'>has_value</a>() const noexcept;
|
||||
constexpr <a href='doc_expected.html#tl::expected-T,E-::has_value()const'>operator bool</a>() const noexcept;
|
||||
|
||||
constexpr const T& <a href='doc_expected.html#tl::expected-T,E-::value()const&'>value</a>() const &;
|
||||
T& <a href='doc_expected.html#tl::expected-T,E-::value()const&'>value</a>() &;
|
||||
constexpr const T&& <a href='doc_expected.html#tl::expected-T,E-::value()const&'>value</a>() const &&;
|
||||
T&& <a href='doc_expected.html#tl::expected-T,E-::value()const&'>value</a>() &&;
|
||||
|
||||
constexpr const E& <a href='doc_expected.html#tl::expected-T,E-::error()const&'>error</a>() const &;
|
||||
E& <a href='doc_expected.html#tl::expected-T,E-::error()const&'>error</a>() &;
|
||||
constexpr const E&& <a href='doc_expected.html#tl::expected-T,E-::error()const&'>error</a>() const &&;
|
||||
E&& <a href='doc_expected.html#tl::expected-T,E-::error()const&'>error</a>() &&;
|
||||
|
||||
template <class U>
|
||||
constexpr T <a href='doc_expected.html#tl::expected-T,E-::value_or(U&&)const&'>value_or</a>(U&& v) const &;
|
||||
template <class U>
|
||||
T <a href='doc_expected.html#tl::expected-T,E-::value_or(U&&)const&'>value_or</a>(U&& v) &&;
|
||||
};</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.
|
||||
|
||||
### Function template `tl::expected::and_then`<a id="tl::expected-T,E-::and_then(F&&)&"></a>
|
||||
|
||||
<pre><code class="language-cpp">(1) template <class F>
|
||||
constexpr auto and_then(F &&f) &;
|
||||
|
||||
(2) template <class F>
|
||||
constexpr auto and_then(F &&f) &&;
|
||||
|
||||
(3) template <class F>
|
||||
constexpr auto and_then(F &&f) const &;
|
||||
|
||||
(4) template <class F>
|
||||
constexpr auto and_then(F &&f) const &&;</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.
|
||||
|
||||
### Function template `tl::expected::map`<a id="tl::expected-T,E-::map(F&&)&"></a>
|
||||
|
||||
<pre><code class="language-cpp">(1) template <class F> constexpr auto map(F &&f) &;
|
||||
|
||||
(2) template <class F> constexpr auto map(F &&f) &&;
|
||||
|
||||
(3) template <class F> constexpr auto map(F &&f) const &;
|
||||
|
||||
(4) template <class F> constexpr auto map(F &&f) const &&;</code></pre>
|
||||
|
||||
Carries out some operation on the stored object if there is one.
|
||||
|
||||
*Returns*: Let `U` be the result of `std::invoke(std::forward<F>(f), value())`. Returns a `std::expected<U,E>`. If `*this` is unexpected, the result is `*this`, otherwise an `expected<U,E>` is constructed from the return value of `std::invoke(std::forward<F>(f), value())` and is returned.
|
||||
|
||||
### Function template `tl::expected::map_error`<a id="tl::expected-T,E-::map_error(F&&)&"></a>
|
||||
|
||||
<pre><code class="language-cpp">(1) template <class F> constexpr auto map_error(F &&f) &;
|
||||
|
||||
(2) template <class F> constexpr auto map_error(F &&f) &&;
|
||||
|
||||
(3) template <class F> constexpr auto map_error(F &&f) const &;
|
||||
|
||||
(4) template <class F> constexpr auto map_error(F &&f) const &&;</code></pre>
|
||||
|
||||
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.
|
||||
|
||||
### Function template `tl::expected::or_else`<a id="tl::expected-T,E-::or_else(F&&)&"></a>
|
||||
|
||||
<pre><code class="language-cpp">(1) template <class F>
|
||||
<a href='doc_expected.html#tl::expected-T,E-'>expected</a> or_else(F&& f) &;</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>
|
||||
|
||||
<pre><code class="language-cpp">(1) EXPLICIT constexpr expected(const unexpected<G> &e);
|
||||
|
||||
(2) EXPLICIT constexpr expected(unexpected<G> &&e);</code></pre>
|
||||
|
||||
### Operator `tl::expected::operator->`<a id="tl::expected-T,E-::operator--()const"></a>
|
||||
|
||||
<pre><code class="language-cpp">(1) constexpr const T* operator->() const;
|
||||
|
||||
(2) T* operator->();</code></pre>
|
||||
|
||||
*Returns*: a pointer to the stored value
|
||||
|
||||
*Requires*: a value is stored
|
||||
|
||||
### Operator `tl::expected::operator*`<a id="tl::expected-T,E-::operator*()const&"></a>
|
||||
|
||||
<pre><code class="language-cpp">(1) constexpr const T& operator*() const &;
|
||||
|
||||
(2) T& operator*() &;
|
||||
|
||||
(3) constexpr const T&& operator*() const &&;
|
||||
|
||||
(4) T&& operator*() &&;</code></pre>
|
||||
|
||||
*Returns*: the stored value
|
||||
|
||||
*Requires*: a value is stored
|
||||
|
||||
### Function `tl::expected::has_value`<a id="tl::expected-T,E-::has_value()const"></a>
|
||||
|
||||
<pre><code class="language-cpp">(1) constexpr bool has_value() const noexcept;
|
||||
|
||||
(2) constexpr operator bool() const noexcept;</code></pre>
|
||||
|
||||
*Returns*: whether or not the optional has a value
|
||||
|
||||
### Function `tl::expected::value`<a id="tl::expected-T,E-::value()const&"></a>
|
||||
|
||||
<pre><code class="language-cpp">(1) constexpr const T& value() const &;
|
||||
|
||||
(2) T& value() &;
|
||||
|
||||
(3) constexpr const T&& value() const &&;
|
||||
|
||||
(4) T&& value() &&;</code></pre>
|
||||
|
||||
*Returns*: the contained value if there is one, otherwise throws \[bad\_expected\_access\]
|
||||
|
||||
### Function `tl::expected::error`<a id="tl::expected-T,E-::error()const&"></a>
|
||||
|
||||
<pre><code class="language-cpp">(1) constexpr const E& error() const &;
|
||||
|
||||
(2) E& error() &;
|
||||
|
||||
(3) constexpr const E&& error() const &&;
|
||||
|
||||
(4) E&& error() &&;</code></pre>
|
||||
|
||||
*Returns*: the unexpected value
|
||||
|
||||
*Requires*: there is an unexpected value
|
||||
|
||||
### Function template `tl::expected::value_or`<a id="tl::expected-T,E-::value_or(U&&)const&"></a>
|
||||
|
||||
<pre><code class="language-cpp">(1) template <class U>
|
||||
constexpr T value_or(U&& v) const &;
|
||||
|
||||
(2) template <class U>
|
||||
T value_or(U&& v) &&;</code></pre>
|
||||
|
||||
*Returns*: the stored value if there is one, otherwise returns `u`
|
||||
|
||||
-----
|
||||
|
||||
-----
|
||||
@@ -1,3 +0,0 @@
|
||||
[output]
|
||||
format=commonmark
|
||||
link_extension=html
|
||||
Reference in New Issue
Block a user