value_type.html 3.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  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>The payload - 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="../../experimental/worked-example/preamble.html"><img src="../../images/prev.png" alt="Prev"></a>
  10. <a accesskey="u" href="../../experimental/worked-example.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="../../experimental/worked-example/constructor.html"><img src="../../images/next.png" alt="Next"></a></div><div id="content">
  12. <div class="titlepage"><div><div><h1 style="clear: both">The payload</h1></div></div></div>
  13. <p>We define the code domain&rsquo;s <code>value_type</code> &ndash; the payload to be transported by
  14. status codes using this code domain &ndash; to be a POSIX <code>errno</code> value, an integer
  15. line number and a const char pointer.</p>
  16. <div class="code-snippet"><div class="highlight"><pre class="chroma"><code class="language-c++" data-lang="c++"><span class="k">public</span><span class="o">:</span>
  17. <span class="c1">// This is the value type for `file_io_error`. We add line number and source file path.
  18. </span><span class="c1"></span> <span class="k">struct</span> <span class="n">value_type</span>
  19. <span class="p">{</span>
  20. <span class="k">typename</span> <span class="n">outcome_e</span><span class="o">::</span><span class="n">posix_code</span><span class="o">::</span><span class="n">value_type</span> <span class="n">errcode</span><span class="p">;</span> <span class="c1">// from POSIX, as we inherit from _posix_code_domain
  21. </span><span class="c1"></span>
  22. <span class="c1">// Our additional payload
  23. </span><span class="c1"></span> <span class="kt">int</span> <span class="n">lineno</span><span class="p">;</span> <span class="c1">// from __LINE__
  24. </span><span class="c1"></span> <span class="k">const</span> <span class="kt">char</span> <span class="o">*</span><span class="n">file</span><span class="p">;</span> <span class="c1">// from __FILE__
  25. </span><span class="c1"></span> <span class="c1">// Could also place a backtrace of void *[16] here ...
  26. </span><span class="c1"></span> <span class="p">};</span>
  27. </code></pre></div><a href="https://github.com/boostorg/outcome/tree/master/doc/src/snippets/experimental_status_code.cpp#L83" class="code-snippet-url" target="_blank">View this code on Github</a></div>
  28. <p>You will note that this is a <code>TriviallyCopyable</code> type, and so gains an implicit
  29. conversion to any <code>status_code&lt;erased&lt;T&gt;&gt;</code> where <code>sizeof(T) &gt;= sizeof(value_type)</code>.</p>
  30. <p><code>error</code> is however <code>status_code&lt;erased&lt;intptr_t&gt;&gt;</code>, and <code>sizeof(intptr_t) &lt; sizeof(value_type)</code>,
  31. so it is not possible to implicitly convert status codes from this domain into
  32. <code>error</code>. Instead, you must tell the compiler how to do the conversion, as we
  33. shall see later.</p>
  34. </div><p><small>Last revised: January 26, 2019 at 23:38:56 UTC</small></p>
  35. <hr>
  36. <div class="spirit-nav">
  37. <a accesskey="p" href="../../experimental/worked-example/preamble.html"><img src="../../images/prev.png" alt="Prev"></a>
  38. <a accesskey="u" href="../../experimental/worked-example.html"><img src="../../images/up.png" alt="Up"></a>
  39. <a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../../experimental/worked-example/constructor.html"><img src="../../images/next.png" alt="Next"></a></div></body>
  40. </html>