Home Explore Help
Register Sign In
devn00b
/
EQ2EMu
9
3
Fork 0
Files Issues 59
Tree: ff02b05cfd
Branches Tags
EQ2EMu
/
EQ2
/
source
/
depends
/
boost_1_72_0
/
libs
/
outcome
/
doc
/
html
/
tutorial
/
advanced
/
interop
/
filelib.html

filelib.html 7.0 KB
History Raw

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    2. 

  2. <html><meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    3. 

  3. <title>The File I/O library - Boost.Outcome documentation</title>
    4. 

  4. <link rel="stylesheet" href="../../../css/boost.css" type="text/css">
    5. 

  5. <meta name="generator" content="Hugo 0.52 with Boostdoc theme">
    6. 

  6. <meta name="viewport" content="width=device-width,initial-scale=1.0"/>
    7. 

  7. 

  8. <link rel="icon" href="../../../images/favicon.ico" type="image/ico"/>
    9. 

  9. <body><div class="spirit-nav">
    10. 

  10. <a accesskey="p" href="../../../tutorial/advanced/interop/tidylib.html"><img src="../../../images/prev.png" alt="Prev"></a>
    11. 

  11.     <a accesskey="u" href="../../../tutorial/advanced/interop.html"><img src="../../../images/up.png" alt="Up"></a>
    12. 

  12.     <a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="../../../tutorial/advanced/interop/app.html"><img src="../../../images/next.png" alt="Next"></a></div><div id="content">
    13. 

  13.   <div class="titlepage"><div><div><h1 style="clear: both">The File I/O library</h1></div></div></div>
    14. 

  14.   <p>The File I/O library we shall be using is very similar <a href="../../payload/copy_file2">to the one we saw earlier
    15. 

  15. in this tutorial</a>:</p>
    16. 

  16. 

  17. <div class="code-snippet"><div class="highlight"><pre class="chroma"><code class="language-c++" data-lang="c++"><span class="c1">// You may remember this from the tutorial section on Custom Payloads
    18. 

  18. </span><span class="c1"></span><span class="k">namespace</span> <span class="n">filelib</span>
    19. 

  19. <span class="p">{</span>
    20. 

  20.   <span class="c1">// Error code + paths related to a failure. Also causes ADL discovery
    21. 

  21. </span><span class="c1"></span>  <span class="c1">// to check this namespace.
    22. 

  22. </span><span class="c1"></span>  <span class="k">struct</span> <span class="n">failure_info</span>
    23. 

  23.   <span class="p">{</span>
    24. 

  24.     <span class="n">std</span><span class="o">::</span><span class="n">error_code</span> <span class="n">ec</span><span class="p">;</span>
    25. 

  25.     <span class="n">path</span> <span class="n">path1</span><span class="p">{},</span> <span class="n">path2</span><span class="p">{};</span>
    26. 

  26.   <span class="p">};</span>
    27. 

  27. 

  28.   <span class="c1">// Tell Outcome that failure_info is to be treated as a std::error_code
    29. 

  29. </span><span class="c1"></span>  <span class="kr">inline</span> <span class="k">const</span> <span class="n">std</span><span class="o">::</span><span class="n">error_code</span> <span class="o">&amp;</span><span class="n">make_error_code</span><span class="p">(</span><span class="k">const</span> <span class="n">failure_info</span> <span class="o">&amp;</span><span class="n">fi</span><span class="p">)</span> <span class="p">{</span> <span class="k">return</span> <span class="n">fi</span><span class="p">.</span><span class="n">ec</span><span class="p">;</span> <span class="p">}</span>
    30. 

  30. 

  31.   <span class="c1">// Tell Outcome that no-value observation should throw a custom exception
    32. 

  32. </span><span class="c1"></span>  <span class="kr">inline</span> <span class="kt">void</span> <span class="n">outcome_throw_as_system_error_with_payload</span><span class="p">(</span><span class="n">failure_info</span> <span class="n">fi</span><span class="p">)</span>
    33. 

  33.   <span class="p">{</span>
    34. 

  34.     <span class="c1">// If the error code is not filesystem related e.g. ENOMEM, throw that
    35. 

  35. </span><span class="c1"></span>    <span class="c1">// as a standard STL exception.
    36. 

  36. </span><span class="c1"></span>    <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>
    37. 

  37.     <span class="c1">// Throw the exact same filesystem_error exception which the throwing
    38. 

  38. </span><span class="c1"></span>    <span class="c1">// copy_file() edition does.
    39. 

  39. </span><span class="c1"></span>    <span class="k">throw</span> <span class="nf">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>
    40. 

  40.   <span class="p">}</span>
    41. 

  41. 

  42.   <span class="c1">// Localise a result implementation specific to this namespace.
    43. 

  43. </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="o">&gt;</span> <span class="k">using</span> <span class="n">result</span> <span class="o">=</span> <span class="n">BOOST_OUTCOME_V2_NAMESPACE</span><span class="o">::</span><span class="n">result</span><span class="o">&lt;</span><span class="n">T</span><span class="p">,</span> <span class="n">failure_info</span><span class="o">&gt;</span><span class="p">;</span>
    44. 

  44. 

  45.   <span class="c1">// Writes a chunk of data to some file. Returns bytes written, or
    46. 

  46. </span><span class="c1"></span>  <span class="c1">// failure_info. Never throws exceptions.
    47. 

  47. </span><span class="c1"></span>  <span class="n">result</span><span class="o">&lt;</span><span class="n">size_t</span><span class="o">&gt;</span> <span class="n">write_file</span><span class="p">(</span><span class="n">string_view</span> <span class="n">chunk</span><span class="p">)</span> <span class="k">noexcept</span><span class="p">;</span>
    48. 

  48. <span class="p">}</span>  <span class="c1">// namespace filelib
    49. 

  49. </span><span class="c1"></span></code></pre></div><a href="https://github.com/boostorg/outcome/tree/master/doc/src/snippets/finale.cpp#L103" class="code-snippet-url" target="_blank">View this code on Github</a></div>
    50. 

  50. 

  51. 

  52. <p>This uses the advanced Outcome feature of programming the lazy synthesis of
    53. 

  53. custom C++ exception throws from a payload carrying <code>E</code> type called <code>failure_info</code>.
    54. 

  54. Like the HTTP library, it too template aliases a localised <code>result</code> implementation
    55. 

  55. into its namespace with ADL bridging so Outcome customisation points can be
    56. 

  56. discovered.</p>
    57. 

  57. 

  58. 

  59.         </div><p><small>Last revised: February 08, 2019 at 22:18:08 UTC</small></p>
    60. 

  60. <hr>
    61. 

  61. <div class="spirit-nav">
    62. 

  62. <a accesskey="p" href="../../../tutorial/advanced/interop/tidylib.html"><img src="../../../images/prev.png" alt="Prev"></a>
    63. 

  63.     <a accesskey="u" href="../../../tutorial/advanced/interop.html"><img src="../../../images/up.png" alt="Up"></a>
    64. 

  64.     <a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="../../../tutorial/advanced/interop/app.html"><img src="../../../images/next.png" alt="Next"></a></div></body>
    65. 

  65. </html>
    66.