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

Update docs

Browse Source
This commit is contained in:
Simon Brand
2017-11-27 15:17:46 +00:00
parent d37876102c
commit e61179684c
2 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/index.md
View File

@@ -264,7 +264,7 @@ public:
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>; 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.html#tl::expected-T,E-::and_then(F&&)&'>and_then</a>(F&amp;&amp; f) &amp;; constexpr auto and_then(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;
@@ -386,7 +386,7 @@ An `expected<T, E>` object is an object that contains the storage for another ob
### Function template `tl::expected::and_then`<a id="tl::expected-T,E-::and_then(F&&)&"></a> ### Function template `tl::expected::and_then`<a id="tl::expected-T,E-::and_then(F&&)&"></a>
<pre><code class="language-cpp">(1) template &lt;class F&gt; <pre><code class="language-cpp">(1) template &lt;class F&gt;
'hidden' and_then(F&amp;&amp; f) &amp;; constexpr auto and_then(F &amp;&amp;f) &amp;;
(2) template &lt;class F&gt; (2) 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;;
@@ -397,7 +397,7 @@ An `expected<T, E>` object is an object that contains the storage for another ob
(4) template &lt;class F&gt; (4) template &lt;class F&gt;
constexpr auto and_then(F &amp;&amp;f) const &amp;&amp;;</code></pre> 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) &; 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> ### Function template `tl::expected::map`<a id="tl::expected-T,E-::map(F&&)&"></a>

8
expected.hpp
View File

@@ -911,8 +911,8 @@ public:
/// of `std::invoke(std::forward<F>(f), value())`. Returns a /// of `std::invoke(std::forward<F>(f), value())`. Returns a
/// `std::expected<U>`. The return value is empty if `*this` is empty, /// `std::expected<U>`. The return value is empty if `*this` is empty,
/// otherwise the return value of `std::invoke(std::forward<F>(f), value())` /// otherwise the return value of `std::invoke(std::forward<F>(f), value())`
/// is returned. \group and_then \synopsis template <class F>\nconstexpr auto /// is returned.
/// and_then(F &&f) &; /// \synopsis template <class F>\nconstexpr auto and_then(F &&f) &;
template <class F> TL_EXPECTED_11_CONSTEXPR auto and_then(F &&f) & { template <class F> TL_EXPECTED_11_CONSTEXPR auto and_then(F &&f) & {
using result = detail::invoke_result_t<F, T &>; using result = detail::invoke_result_t<F, T &>;
static_assert(detail::is_expected<result>::value, static_assert(detail::is_expected<result>::value,
@@ -965,8 +965,8 @@ public:
/// of `std::invoke(std::forward<F>(f), value())`. Returns a /// of `std::invoke(std::forward<F>(f), value())`. Returns a
/// `std::expected<U>`. The return value is empty if `*this` is empty, /// `std::expected<U>`. The return value is empty if `*this` is empty,
/// otherwise the return value of `std::invoke(std::forward<F>(f), value())` /// otherwise the return value of `std::invoke(std::forward<F>(f), value())`
/// is returned. \group and_then \synopsis template <class F>\nconstexpr auto /// is returned.
/// and_then(F &&f) &; /// \synopsis template <class F>\nconstexpr auto and_then(F &&f) &;
template <class F> template <class F>
TL_EXPECTED_11_CONSTEXPR detail::invoke_result_t<F, T &> and_then(F &&f) & { TL_EXPECTED_11_CONSTEXPR detail::invoke_result_t<F, T &> and_then(F &&f) & {
using result = detail::invoke_result_t<F, T &>; using result = detail::invoke_result_t<F, T &>;