app-map-filelib.html 8.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <html><meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  3. <title>Mapping the File I/O library into the Application - Boost.Outcome documentation</title>
  4. <link rel="stylesheet" href="../../../css/boost.css" type="text/css">
  5. <meta name="generator" content="Hugo 0.52 with Boostdoc theme">
  6. <meta name="viewport" content="width=device-width,initial-scale=1.0"/>
  7. <link rel="icon" href="../../../images/favicon.ico" type="image/ico"/>
  8. <body><div class="spirit-nav">
  9. <a accesskey="p" href="../../../tutorial/advanced/interop/app-map-httplib2.html"><img src="../../../images/prev.png" alt="Prev"></a>
  10. <a accesskey="u" href="../../../tutorial/advanced/interop.html"><img src="../../../images/up.png" alt="Up"></a>
  11. <a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="../../../tutorial/advanced/interop/app-map-tidylib.html"><img src="../../../images/next.png" alt="Next"></a></div><div id="content">
  12. <div class="titlepage"><div><div><h1 style="clear: both">Mapping the File I/O library into the Application</h1></div></div></div>
  13. <p>To handle the File I/O library, once again we turn to custom <code>ValueOrError</code>
  14. converters:</p>
  15. <div class="code-snippet"><div class="highlight"><pre class="chroma"><code class="language-c++" data-lang="c++"><span class="c1">// Inject custom ValueOrError conversion
  16. </span><span class="c1"></span><span class="n">BOOST_OUTCOME_V2_NAMESPACE_BEGIN</span>
  17. <span class="k">namespace</span> <span class="n">convert</span>
  18. <span class="p">{</span>
  19. <span class="c1">// Provide custom ValueOrError conversion from filelib::result&lt;U&gt;
  20. </span><span class="c1"></span> <span class="c1">// into any app::outcome&lt;T&gt;
  21. </span><span class="c1"></span> <span class="k">template</span> <span class="o">&lt;</span><span class="k">class</span><span class="err"> </span><span class="nc">T</span><span class="p">,</span> <span class="k">class</span><span class="err"> </span><span class="nc">U</span><span class="o">&gt;</span> <span class="c1">//
  22. </span><span class="c1"></span> <span class="k">struct</span> <span class="n">value_or_error</span><span class="o">&lt;</span><span class="n">app</span><span class="o">::</span><span class="n">outcome</span><span class="o">&lt;</span><span class="n">T</span><span class="o">&gt;</span><span class="p">,</span> <span class="n">filelib</span><span class="o">::</span><span class="n">result</span><span class="o">&lt;</span><span class="n">U</span><span class="o">&gt;&gt;</span>
  23. <span class="p">{</span>
  24. <span class="c1">// True to indicate that this converter wants `result`/`outcome`
  25. </span><span class="c1"></span> <span class="c1">// to NOT reject all other `result`
  26. </span><span class="c1"></span> <span class="k">static</span> <span class="k">constexpr</span> <span class="kt">bool</span> <span class="n">enable_result_inputs</span> <span class="o">=</span> <span class="nb">true</span><span class="p">;</span>
  27. <span class="c1">// False to indicate that this converter wants `outcome` to NOT
  28. </span><span class="c1"></span> <span class="c1">// reject all other `outcome`
  29. </span><span class="c1"></span> <span class="k">static</span> <span class="k">constexpr</span> <span class="kt">bool</span> <span class="n">enable_outcome_inputs</span> <span class="o">=</span> <span class="nb">true</span><span class="p">;</span>
  30. <span class="k">template</span> <span class="o">&lt;</span><span class="k">class</span><span class="err"> </span><span class="nc">X</span><span class="p">,</span> <span class="c1">//
  31. </span><span class="c1"></span> <span class="k">typename</span> <span class="o">=</span> <span class="n">std</span><span class="o">::</span><span class="n">enable_if_t</span><span class="o">&lt;</span><span class="n">std</span><span class="o">::</span><span class="n">is_same</span><span class="o">&lt;</span><span class="n">filelib</span><span class="o">::</span><span class="n">result</span><span class="o">&lt;</span><span class="n">U</span><span class="o">&gt;</span><span class="p">,</span> <span class="n">std</span><span class="o">::</span><span class="n">decay_t</span><span class="o">&lt;</span><span class="n">X</span><span class="o">&gt;&gt;::</span><span class="n">value</span> <span class="c1">//
  32. </span><span class="c1"></span> <span class="o">&amp;&amp;</span> <span class="n">std</span><span class="o">::</span><span class="n">is_constructible</span><span class="o">&lt;</span><span class="n">T</span><span class="p">,</span> <span class="n">U</span><span class="o">&gt;::</span><span class="n">value</span><span class="o">&gt;&gt;</span> <span class="c1">//
  33. </span><span class="c1"></span> <span class="k">constexpr</span> <span class="n">app</span><span class="o">::</span><span class="n">outcome</span><span class="o">&lt;</span><span class="n">T</span><span class="o">&gt;</span> <span class="k">operator</span><span class="p">()(</span><span class="n">X</span> <span class="o">&amp;&amp;</span><span class="n">src</span><span class="p">)</span>
  34. <span class="p">{</span>
  35. <span class="c1">// Forward any successful value
  36. </span><span class="c1"></span> <span class="k">if</span><span class="p">(</span><span class="n">src</span><span class="p">.</span><span class="n">has_value</span><span class="p">())</span>
  37. <span class="p">{</span>
  38. <span class="k">return</span> <span class="p">{</span><span class="n">std</span><span class="o">::</span><span class="n">forward</span><span class="o">&lt;</span><span class="n">X</span><span class="o">&gt;</span><span class="p">(</span><span class="n">src</span><span class="p">).</span><span class="n">value</span><span class="p">()};</span>
  39. <span class="p">}</span>
  40. <span class="c1">// Synthesise a filesystem_error, exactly as if someone had
  41. </span><span class="c1"></span> <span class="c1">// called src.value()
  42. </span><span class="c1"></span> <span class="k">auto</span> <span class="o">&amp;</span><span class="n">fi</span> <span class="o">=</span> <span class="n">src</span><span class="p">.</span><span class="n">error</span><span class="p">();</span>
  43. <span class="n">BOOST_OUTCOME_V2_NAMESPACE</span><span class="o">::</span><span class="n">try_throw_std_exception_from_error</span><span class="p">(</span><span class="n">fi</span><span class="p">.</span><span class="n">ec</span><span class="p">);</span> <span class="c1">// might throw
  44. </span><span class="c1"></span> <span class="k">return</span> <span class="p">{</span><span class="n">std</span><span class="o">::</span><span class="n">make_exception_ptr</span><span class="p">(</span> <span class="c1">//
  45. </span><span class="c1"></span> <span class="n">filelib</span><span class="o">::</span><span class="n">filesystem_error</span><span class="p">(</span><span class="n">fi</span><span class="p">.</span><span class="n">ec</span><span class="p">.</span><span class="n">message</span><span class="p">(),</span> <span class="n">std</span><span class="o">::</span><span class="n">move</span><span class="p">(</span><span class="n">fi</span><span class="p">.</span><span class="n">path1</span><span class="p">),</span> <span class="n">std</span><span class="o">::</span><span class="n">move</span><span class="p">(</span><span class="n">fi</span><span class="p">.</span><span class="n">path2</span><span class="p">),</span> <span class="n">fi</span><span class="p">.</span><span class="n">ec</span><span class="p">))};</span>
  46. <span class="p">}</span>
  47. <span class="p">};</span>
  48. <span class="p">}</span> <span class="c1">// namespace convert
  49. </span><span class="c1"></span><span class="n">BOOST_OUTCOME_V2_NAMESPACE_END</span>
  50. </code></pre></div><a href="https://github.com/boostorg/outcome/tree/master/doc/src/snippets/finale.cpp#L289" class="code-snippet-url" target="_blank">View this code on Github</a></div>
  51. <p>Note that the conversion exactly duplicates the implementation of
  52. <code>throw_as_system_error_with_payload(failure_info fi)</code> from
  53. namespace <code>filelib</code>. In a production implementation, you probably
  54. ought to call that function and catch the exception it throws
  55. into a pointer, as that would be more long term maintainable.</p>
  56. </div><p><small>Last revised: February 11, 2019 at 13:38:04 UTC</small></p>
  57. <hr>
  58. <div class="spirit-nav">
  59. <a accesskey="p" href="../../../tutorial/advanced/interop/app-map-httplib2.html"><img src="../../../images/prev.png" alt="Prev"></a>
  60. <a accesskey="u" href="../../../tutorial/advanced/interop.html"><img src="../../../images/up.png" alt="Up"></a>
  61. <a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="../../../tutorial/advanced/interop/app-map-tidylib.html"><img src="../../../images/next.png" alt="Next"></a></div></body>
  62. </html>