mirror of
https://github.com/boostorg/outcome.git
synced 2026-02-19 14:42:08 +00:00
62 lines
5.0 KiB
HTML
62 lines
5.0 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<html><meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<title>The HTTP library - Boost.Outcome documentation</title>
|
|
<link rel="stylesheet" href="/boost-outcome/css/boost.css" type="text/css">
|
|
<meta name="generator" content="Hugo with Boostdoc theme">
|
|
<meta name="viewport" content="width=device-width,initial-scale=1.0"/>
|
|
|
|
<link rel="icon" href="/boost-outcome/images/favicon.ico" type="image/ico"/>
|
|
<body><div id="content">
|
|
<p>Let us imagine a simple application: it fetches a HTTP page using a HTTP library,
|
|
sends it through HTML tidy via the htmltidy library, and then writes it to disc
|
|
using a filelib library. So three third party libraries, two using Outcome in
|
|
incompatible ways, and the third being a C library just for kicks.</p>
|
|
|
|
<p>Let us imagine that the HTTP library has the following public interface:</p>
|
|
|
|
<div class="code-snippet"><div class="highlight"><pre class="chroma"><code class="language-c++" data-lang="c++">
|
|
<span class="c1">// This is some standalone library implementing high level HTTP
|
|
</span><span class="c1"></span><span class="k">namespace</span> <span class="n">httplib</span>
|
|
<span class="p">{</span>
|
|
<span class="c1">// These are the error code that this HTTP library can return
|
|
</span><span class="c1"></span> <span class="k">enum</span> <span class="k">class</span><span class="err"> </span><span class="nc">status_code</span>
|
|
<span class="p">{</span>
|
|
<span class="n">success</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="c1">// not the HTTP success code of 200
|
|
</span><span class="c1"></span>
|
|
<span class="c1">// A subset of all HTTP status codes for brevity
|
|
</span><span class="c1"></span> <span class="n">bad_request</span> <span class="o">=</span> <span class="mi">400</span><span class="p">,</span>
|
|
<span class="n">access_denied</span> <span class="o">=</span> <span class="mi">401</span><span class="p">,</span>
|
|
<span class="n">logon_failed</span> <span class="o">=</span> <span class="mi">402</span><span class="p">,</span>
|
|
<span class="n">forbidden</span> <span class="o">=</span> <span class="mi">403</span><span class="p">,</span>
|
|
<span class="n">not_found</span> <span class="o">=</span> <span class="mi">404</span><span class="p">,</span>
|
|
<span class="n">internal_error</span> <span class="o">=</span> <span class="mi">500</span>
|
|
<span class="p">};</span>
|
|
<span class="c1">// This is the error type that this HTTP library can return
|
|
</span><span class="c1"></span> <span class="k">struct</span> <span class="n">failure</span>
|
|
<span class="p">{</span>
|
|
<span class="n">status_code</span> <span class="n">status</span><span class="p">{</span><span class="n">status_code</span><span class="o">::</span><span class="n">success</span><span class="p">};</span>
|
|
<span class="n">std</span><span class="o">::</span><span class="n">string</span> <span class="n">url</span><span class="p">{};</span> <span class="c1">// The failing URL
|
|
</span><span class="c1"></span> <span class="p">};</span>
|
|
<span class="c1">// Localise a result implementation to this library
|
|
</span><span class="c1"></span> <span class="k">template</span> <span class="o"><</span><span class="k">class</span><span class="err"> </span><span class="nc">T</span><span class="o">></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"><</span><span class="n">T</span><span class="p">,</span> <span class="n">failure</span><span class="o">></span><span class="p">;</span>
|
|
|
|
<span class="cm">/* Performs a HTTP GET on the url, returning the body if successful,
|
|
</span><span class="cm"> a failure with status_code if unsuccessful at the HTTP level, or a
|
|
</span><span class="cm"> C++ exception throw if something catastrophic happened e.g. bad_alloc
|
|
</span><span class="cm"> */</span>
|
|
<span class="n">result</span><span class="o"><</span><span class="n">std</span><span class="o">::</span><span class="n">string</span><span class="o">></span> <span class="n">get</span><span class="p">(</span><span class="n">std</span><span class="o">::</span><span class="n">string</span> <span class="n">url</span><span class="p">);</span>
|
|
<span class="p">}</span>
|
|
</code></pre></div><a href="https://github.com/ned14/boost-outcome/tree/master/doc/src/snippets/finale.cpp#L40" class="code-snippet-url" target="_blank">View this code on Github</a></div>
|
|
|
|
|
|
<p>The HTTP library is a mixed-failure design. Likely failures (HTTP status codes)
|
|
are returned via <code>httplib::failure</code>, unlikely failures (e.g. out of memory)
|
|
are returned via throw of the usual STL exception types.</p>
|
|
|
|
<p>The sole API we bother describing is an implementation of HTTP GET. It fetches
|
|
a URL, and either returns the contents or the failure reason why not.</p>
|
|
|
|
|
|
</div></body>
|
|
</html>
|